mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-11-15 14:59:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

vim-patch:partial:450d591: runtime(doc): tweak documentation style (#35748)

Browse Source 
closes: vim/vim#18284

450d59145e

Skip ft_hare.txt.

Co-authored-by: Hirohito Higashi <h.east.727@gmail.com>
This commit is contained in:
zeertzjq
2025-09-14 07:33:06 +08:00
committed by GitHub
parent 8ae9a44d38
commit 68f40386ed
3 changed files with 189 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
runtime/doc/options.txt
View File

@@ -859,8 +859,8 @@ A jump table for the options with a short description can be found at |Q_op|.
eol allow backspacing over line breaks (join lines) eol allow backspacing over line breaks (join lines)
start allow backspacing over the start of insert; CTRL-W and CTRL-U start allow backspacing over the start of insert; CTRL-W and CTRL-U
stop once at the start of insert. stop once at the start of insert.
nostop like start, except CTRL-W and CTRL-U do not stop at the start of nostop like start, except CTRL-W and CTRL-U do not stop at the start
insert. of insert.
When the value is empty, Vi compatible backspacing is used, none of When the value is empty, Vi compatible backspacing is used, none of
the ways mentioned for the items above are possible. the ways mentioned for the items above are possible.
@@ -1546,19 +1546,19 @@ A jump table for the options with a short description can be found at |Q_op|.
name of a function or a |Funcref|. For |Funcref| values, name of a function or a |Funcref|. For |Funcref| values,
spaces must be escaped with a backslash ('\'), and commas with spaces must be escaped with a backslash ('\'), and commas with
double backslashes ('\\') (see |option-backslash|). double backslashes ('\\') (see |option-backslash|).
Unlike other sources, functions can provide completions starting Unlike other sources, functions can provide completions
from a non-keyword character before the cursor, and their starting from a non-keyword character before the cursor, and
start position for replacing text may differ from other sources. their start position for replacing text may differ from other
If the Dict returned by the {func} includes {"refresh": "always"}, sources. If the Dict returned by the {func} includes
the function will be invoked again whenever the leading text `{"refresh": "always"}`, the function will be invoked again
changes. whenever the leading text changes.
If generating matches is potentially slow, call If generating matches is potentially slow, call
|complete_check()| periodically to keep Vim responsive. This |complete_check()| periodically to keep Vim responsive. This
is especially important for |ins-autocompletion|. is especially important for |ins-autocompletion|.
F equivalent to using "F{func}", where the function is taken from F equivalent to using "F{func}", where the function is taken
the 'completefunc' option. from the 'completefunc' option.
o equivalent to using "F{func}", where the function is taken from o equivalent to using "F{func}", where the function is taken
the 'omnifunc' option. from the 'omnifunc' option.
Unloaded buffers are not loaded, thus their autocmds |:autocmd| are Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
not executed, this may lead to unexpected completions from some files not executed, this may lead to unexpected completions from some files
@@ -1573,8 +1573,8 @@ A jump table for the options with a short description can be found at |Q_op|.
An optional match limit can be specified for a completion source by An optional match limit can be specified for a completion source by
appending a caret ("^") followed by a {count} to the source flag. appending a caret ("^") followed by a {count} to the source flag.
For example: ".^9,w,u,t^5" limits matches from the current buffer For example: ".^9,w,u,t^5" limits matches from the current buffer to 9
to 9 and from tags to 5. Other sources remain unlimited. and from tags to 5. Other sources remain unlimited.
Note: The match limit takes effect only during forward completion Note: The match limit takes effect only during forward completion
(CTRL-N) and is ignored during backward completion (CTRL-P). (CTRL-N) and is ignored during backward completion (CTRL-P).
@@ -1628,7 +1628,7 @@ A jump table for the options with a short description can be found at |Q_op|.
A comma-separated list of options for Insert mode completion A comma-separated list of options for Insert mode completion
|ins-completion|. The supported values are: |ins-completion|. The supported values are:
fuzzy Enable |fuzzy-matching| for completion candidates. This fuzzy Enable |fuzzy-matching| for completion candidates. This
allows for more flexible and intuitive matching, where allows for more flexible and intuitive matching, where
characters can be skipped and matches can be found even characters can be skipped and matches can be found even
if the exact sequence is not typed. Note: This option if the exact sequence is not typed. Note: This option
@@ -1701,9 +1701,9 @@ A jump table for the options with a short description can be found at |Q_op|.
only modifiable in MS-Windows only modifiable in MS-Windows
When this option is set it overrules 'shellslash' for completion: When this option is set it overrules 'shellslash' for completion:
- When this option is set to "slash", a forward slash is used for path - When this option is set to "slash", a forward slash is used for path
completion in insert mode. This is useful when editing HTML tag, or completion in insert mode. This is useful when editing HTML tag, or
Makefile with 'noshellslash' on MS-Windows. Makefile with 'noshellslash' on MS-Windows.
- When this option is set to "backslash", backslash is used. This is - When this option is set to "backslash", backslash is used. This is
useful when editing a batch file with 'shellslash' set on MS-Windows. useful when editing a batch file with 'shellslash' set on MS-Windows.
- When this option is empty, same character is used as for - When this option is empty, same character is used as for
'shellslash'. 'shellslash'.
@@ -2006,7 +2006,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*cpo-;* *cpo-;*
; When using |,| or |;| to repeat the last |t| search ; When using |,| or |;| to repeat the last |t| search
and the cursor is right in front of the searched and the cursor is right in front of the searched
character, the cursor won't move. When not included, character, the cursor won't move. When not included,
the cursor would skip over it and jump to the the cursor would skip over it and jump to the
following occurrence. following occurrence.
*cpo-~* *cpo-~*
@@ -2129,7 +2129,7 @@ A jump table for the options with a short description can be found at |Q_op|.
When this option is empty or an entry "spell" is present, and spell When this option is empty or an entry "spell" is present, and spell
checking is enabled, words in the word lists for the currently active checking is enabled, words in the word lists for the currently active
'spelllang' are used. See |spell|. 'spelllang' are used. See |spell|.
To include a comma in a file name precede it with a backslash. Spaces To include a comma in a file name precede it with a backslash. Spaces
after a comma are ignored, otherwise spaces are included in the file after a comma are ignored, otherwise spaces are included in the file
@@ -2188,7 +2188,7 @@ A jump table for the options with a short description can be found at |Q_op|.
All are optional. Items must be separated by a comma. All are optional. Items must be separated by a comma.
algorithm:{text} Use the specified diff algorithm with the algorithm:{text} Use the specified diff algorithm with the
internal diff engine. Currently supported internal diff engine. Currently supported
algorithms are: algorithms are:
myers the default algorithm myers the default algorithm
minimal spend extra time to generate the minimal spend extra time to generate the
@@ -2211,7 +2211,7 @@ A jump table for the options with a short description can be found at |Q_op|.
When omitted a context of six lines is used. When omitted a context of six lines is used.
When using zero the context is actually one, When using zero the context is actually one,
since folds require a line in between, also since folds require a line in between, also
for a deleted line. Set it to a very large for a deleted line. Set it to a very large
value (999999) to disable folding completely. value (999999) to disable folding completely.
See |fold-diff|. See |fold-diff|.
@@ -2294,14 +2294,14 @@ A jump table for the options with a short description can be found at |Q_op|.
exactly. exactly.
linematch:{n} Align and mark changes between the most linematch:{n} Align and mark changes between the most
similar lines between the buffers. When the similar lines between the buffers. When the
total number of lines in the diff hunk exceeds total number of lines in the diff hunk exceeds
{n}, the lines will not be aligned because for {n}, the lines will not be aligned because for
very large diff hunks there will be a very large diff hunks there will be a
noticeable lag. A reasonable setting is noticeable lag. A reasonable setting is
"linematch:60", as this will enable alignment "linematch:60", as this will enable alignment
for a 2 buffer diff hunk of 30 lines each, for a 2 buffer diff hunk of 30 lines each, or
or a 3 buffer diff hunk of 20 lines each. a 3 buffer diff hunk of 20 lines each.
Implicitly sets "filler" when this is set. Implicitly sets "filler" when this is set.
vertical Start diff mode with vertical splits (unless vertical Start diff mode with vertical splits (unless
@@ -2345,7 +2345,7 @@ A jump table for the options with a short description can be found at |Q_op|.
file name uniqueness in the preserve directory. file name uniqueness in the preserve directory.
On Win32, it is also possible to end with "\\". However, When a On Win32, it is also possible to end with "\\". However, When a
separating comma is following, you must use "//", since "\\" will separating comma is following, you must use "//", since "\\" will
include the comma in the file name. Therefore it is recommended to include the comma in the file name. Therefore it is recommended to
use '//', instead of '\\'. use '//', instead of '\\'.
- Spaces after the comma are ignored, other spaces are considered part - Spaces after the comma are ignored, other spaces are considered part
of the directory name. To have a space at the start of a directory of the directory name. To have a space at the start of a directory
@@ -2477,7 +2477,7 @@ A jump table for the options with a short description can be found at |Q_op|.
makes a difference for error messages, the bell will be used always makes a difference for error messages, the bell will be used always
for a lot of errors without a message (e.g., hitting <Esc> in Normal for a lot of errors without a message (e.g., hitting <Esc> in Normal
mode). See 'visualbell' to make the bell behave like a screen flash mode). See 'visualbell' to make the bell behave like a screen flash
or do nothing. See 'belloff' to finetune when to ring the bell. or do nothing. See 'belloff' to finetune when to ring the bell.
*'errorfile'* *'ef'* *'errorfile'* *'ef'*
'errorfile' 'ef' string (default "errors.err") 'errorfile' 'ef' string (default "errors.err")
@@ -3229,7 +3229,7 @@ A jump table for the options with a short description can be found at |Q_op|.
:s///gg subst. all subst. one :s///gg subst. all subst. one
NOTE: Setting this option may break plugins that rely on the default NOTE: Setting this option may break plugins that rely on the default
behavior of the 'g' flag. This will also make the 'g' flag have the behavior of the 'g' flag. This will also make the 'g' flag have the
opposite effect of that documented in |:s_g|. opposite effect of that documented in |:s_g|.
*'grepformat'* *'gfm'* *'grepformat'* *'gfm'*
@@ -3662,7 +3662,7 @@ A jump table for the options with a short description can be found at |Q_op|.
avoid that Vim hangs while you are typing the pattern. avoid that Vim hangs while you are typing the pattern.
The |hl-IncSearch| highlight group determines the highlighting. The |hl-IncSearch| highlight group determines the highlighting.
When 'hlsearch' is on, all matched strings are highlighted too while When 'hlsearch' is on, all matched strings are highlighted too while
typing a search command. See also: 'hlsearch'. typing a search command. See also: 'hlsearch'.
If you don't want to turn 'hlsearch' on, but want to highlight all If you don't want to turn 'hlsearch' on, but want to highlight all
matches while searching, you can turn on and off 'hlsearch' with matches while searching, you can turn on and off 'hlsearch' with
autocmd. Example: >vim autocmd. Example: >vim
@@ -4046,8 +4046,8 @@ A jump table for the options with a short description can be found at |Q_op|.
than at the last character that fits on the screen. Unlike than at the last character that fits on the screen. Unlike
'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
it only affects the way the file is displayed, not its contents. it only affects the way the file is displayed, not its contents.
If 'breakindent' is set, line is visually indented. Then, the value If 'breakindent' is set, line is visually indented. Then, the value
of 'showbreak' is used to put in front of wrapped lines. This option of 'showbreak' is used to put in front of wrapped lines. This option
is not used when the 'wrap' option is off. is not used when the 'wrap' option is off.
Note that <Tab> characters after an <EOL> are mostly not displayed Note that <Tab> characters after an <EOL> are mostly not displayed
with the right amount of white space. with the right amount of white space.
@@ -4609,8 +4609,8 @@ A jump table for the options with a short description can be found at |Q_op|.
'mousemoveevent' 'mousemev' boolean (default off) 'mousemoveevent' 'mousemev' boolean (default off)
global global
When on, mouse move events are delivered to the input queue and are When on, mouse move events are delivered to the input queue and are
available for mapping |<MouseMove>|. The default, off, avoids the mouse available for mapping |<MouseMove>|. The default, off, avoids the
movement overhead except when needed. mouse movement overhead except when needed.
Warning: Setting this option can make pending mappings to be aborted Warning: Setting this option can make pending mappings to be aborted
when the mouse is moved. when the mouse is moved.
@@ -4658,7 +4658,7 @@ A jump table for the options with a short description can be found at |Q_op|.
bin If included, numbers starting with "0b" or "0B" will be bin If included, numbers starting with "0b" or "0B" will be
considered to be binary. Example: Using CTRL-X on considered to be binary. Example: Using CTRL-X on
"0b1000" subtracts one, resulting in "0b0111". "0b1000" subtracts one, resulting in "0b0111".
unsigned If included, numbers are recognized as unsigned. Thus a unsigned If included, numbers are recognized as unsigned. Thus a
leading dash or negative sign won't be considered as part of leading dash or negative sign won't be considered as part of
the number. Examples: the number. Examples:
Using CTRL-X on "2020" in "9-2020" results in "9-2019" Using CTRL-X on "2020" in "9-2020" results in "9-2019"
@@ -4715,14 +4715,14 @@ A jump table for the options with a short description can be found at |Q_op|.
local to window local to window
Minimal number of columns to use for the line number. Only relevant Minimal number of columns to use for the line number. Only relevant
when the 'number' or 'relativenumber' option is set or printing lines when the 'number' or 'relativenumber' option is set or printing lines
with a line number. Since one space is always between the number and with a line number. Since one space is always between the number and
the text, there is one less character for the number itself. the text, there is one less character for the number itself.
The value is the minimum width. A bigger width is used when needed to The value is the minimum width. A bigger width is used when needed to
fit the highest line number in the buffer respectively the number of fit the highest line number in the buffer respectively the number of
rows in the window, depending on whether 'number' or 'relativenumber' rows in the window, depending on whether 'number' or 'relativenumber'
is set. Thus with the Vim default of 4 there is room for a line number is set. Thus with the Vim default of 4 there is room for a line
up to 999. When the buffer has 1000 lines five columns will be used. number up to 999. When the buffer has 1000 lines five columns will be
The minimum value is 1, the maximum value is 20. used. The minimum value is 1, the maximum value is 20.
*'omnifunc'* *'ofu'* *'omnifunc'* *'ofu'*
'omnifunc' 'ofu' string (default "") 'omnifunc' 'ofu' string (default "")
@@ -5023,12 +5023,12 @@ A jump table for the options with a short description can be found at |Q_op|.
'relativenumber' 'rnu' boolean (default off) 'relativenumber' 'rnu' boolean (default off)
local to window local to window
Show the line number relative to the line with the cursor in front of Show the line number relative to the line with the cursor in front of
each line. Relative line numbers help you use the |count| you can each line. Relative line numbers help you use the |count| you can
precede some vertical motion commands (e.g. j k + -) with, without precede some vertical motion commands (e.g. j k + -) with, without
having to calculate it yourself. Especially useful in combination with having to calculate it yourself. Especially useful in combination
other commands (e.g. y d c < > gq gw =). with other commands (e.g. y d c < > gq gw =).
When the 'n' option is excluded from 'cpoptions' a wrapped When the 'n' option is excluded from 'cpoptions' a wrapped line will
line will not use the column of line numbers. not use the column of line numbers.
The 'numberwidth' option can be used to set the room used for the line The 'numberwidth' option can be used to set the room used for the line
number. number.
When a long, wrapped line doesn't start with the first character, '-' When a long, wrapped line doesn't start with the first character, '-'
@@ -5693,7 +5693,7 @@ A jump table for the options with a short description can be found at |Q_op|.
the "!" and ":!" commands. Includes the redirection. See the "!" and ":!" commands. Includes the redirection. See
'shellquote' to exclude the redirection. It's probably not useful 'shellquote' to exclude the redirection. It's probably not useful
to set both options. to set both options.
When the value is '(' then ')' is appended. When the value is '"(' When the value is '(' then ')' is appended. When the value is '"('
then ')"' is appended. then ')"' is appended.
When the value is '(' then also see 'shellxescape'. When the value is '(' then also see 'shellxescape'.
This option cannot be set from a |modeline| or in the |sandbox|, for This option cannot be set from a |modeline| or in the |sandbox|, for
@@ -5909,12 +5909,12 @@ A jump table for the options with a short description can be found at |Q_op|.
*'signcolumn'* *'scl'* *'signcolumn'* *'scl'*
'signcolumn' 'scl' string (default "auto") 'signcolumn' 'scl' string (default "auto")
local to window local to window
When and how to draw the signcolumn. Valid values are: When and how to draw the signcolumn. Valid values are:
"auto" only when there is a sign to display "auto" only when there is a sign to display
"auto:[1-9]" resize to accommodate multiple signs up to the "auto:[1-9]" resize to accommodate multiple signs up to the
given number (maximum 9), e.g. "auto:4" given number (maximum 9), e.g. "auto:4"
"auto:[1-8]-[2-9]" "auto:[1-8]-[2-9]"
resize to accommodate multiple signs up to the resize to accommodate multiple signs up to the
given maximum number (maximum 9) while keeping given maximum number (maximum 9) while keeping
at least the given minimum (maximum 8) fixed at least the given minimum (maximum 8) fixed
space. The minimum number should always be less space. The minimum number should always be less
@@ -5922,8 +5922,8 @@ A jump table for the options with a short description can be found at |Q_op|.
"no" never "no" never
"yes" always "yes" always
"yes:[1-9]" always, with fixed space for signs up to the given "yes:[1-9]" always, with fixed space for signs up to the given
number (maximum 9), e.g. "yes:3" number (maximum 9), e.g. "yes:3"
"number" display signs in the 'number' column. If the number "number" display signs in the 'number' column. If the number
column is not present, then behaves like "auto". column is not present, then behaves like "auto".
*'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
@@ -5977,7 +5977,7 @@ A jump table for the options with a short description can be found at |Q_op|.
local to window local to window
Scrolling works with screen lines. When 'wrap' is set and the first Scrolling works with screen lines. When 'wrap' is set and the first
line in the window wraps part of it may not be visible, as if it is line in the window wraps part of it may not be visible, as if it is
above the window. "<<<" is displayed at the start of the first line, above the window. "<<<" is displayed at the start of the first line,
highlighted with |hl-NonText|. highlighted with |hl-NonText|.
You may also want to add "lastline" to the 'display' option to show as You may also want to add "lastline" to the 'display' option to show as
much of the last line as possible. much of the last line as possible.
@@ -6067,7 +6067,7 @@ A jump table for the options with a short description can be found at |Q_op|.
the two-letter, lower case region name. You can use more than one the two-letter, lower case region name. You can use more than one
region by listing them: "en_us,en_ca" supports both US and Canadian region by listing them: "en_us,en_ca" supports both US and Canadian
English, but not words specific for Australia, New Zealand or Great English, but not words specific for Australia, New Zealand or Great
Britain. (Note: currently en_au and en_nz dictionaries are older than Britain. (Note: currently en_au and en_nz dictionaries are older than
en_ca, en_gb and en_us). en_ca, en_gb and en_us).
If the name "cjk" is included East Asian characters are excluded from If the name "cjk" is included East Asian characters are excluded from
spell checking. This is useful when editing text that also has Asian spell checking. This is useful when editing text that also has Asian
@@ -6191,9 +6191,9 @@ A jump table for the options with a short description can be found at |Q_op|.
topline Keep the topline the same. topline Keep the topline the same.
For the "screen" and "topline" values, the cursor position will be For the "screen" and "topline" values, the cursor position will be
changed when necessary. In this case, the jumplist will be populated changed when necessary. In this case, the jumplist will be populated
with the previous cursor position. For "screen", the text cannot always with the previous cursor position. For "screen", the text cannot
be kept on the same screen line when 'wrap' is enabled. always be kept on the same screen line when 'wrap' is enabled.
*'splitright'* *'spr'* *'nosplitright'* *'nospr'* *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
'splitright' 'spr' boolean (default off) 'splitright' 'spr' boolean (default off)
@@ -6855,7 +6855,7 @@ A jump table for the options with a short description can be found at |Q_op|.
'thesaurusfunc' 'tsrfu' string (default "") 'thesaurusfunc' 'tsrfu' string (default "")
global or local to buffer |global-local| global or local to buffer |global-local|
This option specifies a function to be used for thesaurus completion This option specifies a function to be used for thesaurus completion
with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|. with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
The value can be the name of a function, a |lambda| or a |Funcref|. The value can be the name of a function, a |lambda| or a |Funcref|.
See |option-value-function| for more information. See |option-value-function| for more information.
@@ -7082,9 +7082,9 @@ A jump table for the options with a short description can be found at |Q_op|.
*'vartabstop'* *'vts'* *'vartabstop'* *'vts'*
'vartabstop' 'vts' string (default "") 'vartabstop' 'vts' string (default "")
local to buffer local to buffer
Defines variable-width tab stops. The value is a comma-separated list Defines variable-width tab stops. The value is a comma-separated list
of widths in columns. Each width defines the number of columns of widths in columns. Each width defines the number of columns before
before the next tab stop; the last value repeats indefinitely. the next tab stop; the last value repeats indefinitely.
For example: > For example: >
:set vartabstop=4,8 :set vartabstop=4,8
@@ -7416,16 +7416,16 @@ A jump table for the options with a short description can be found at |Q_op|.
expressions or with 'smartcase' enabled. However, the expressions or with 'smartcase' enabled. However, the
case of the appended matched word may not exactly case of the appended matched word may not exactly
match the case of the word in the buffer. match the case of the word in the buffer.
fuzzy Use |fuzzy-matching| to find completion matches. When fuzzy Use |fuzzy-matching| to find completion matches. When
this value is specified, wildcard expansion will not this value is specified, wildcard expansion will not
be used for completion. The matches will be sorted by be used for completion. The matches will be sorted by
the "best match" rather than alphabetically sorted. the "best match" rather than alphabetically sorted.
This will find more matches than the wildcard This will find more matches than the wildcard
expansion. Currently fuzzy matching based completion expansion. Currently fuzzy matching based completion
is not supported for file and directory names and is not supported for file and directory names and
instead wildcard expansion is used. instead wildcard expansion is used.
pum Display the completion matches using the popup menu pum Display the completion matches using the popup menu in
in the same style as the |ins-completion-menu|. the same style as the |ins-completion-menu|.
tagfile When using CTRL-D to list matching tags, the kind of tagfile When using CTRL-D to list matching tags, the kind of
tag and the file of the tag is listed. Only one match tag and the file of the tag is listed. Only one match
is displayed per line. Often used tag kinds are: is displayed per line. Often used tag kinds are:

126
runtime/lua/vim/_meta/options.lua generated
View File

@@ -258,8 +258,8 @@ vim.go.bg = vim.go.background
--- eol allow backspacing over line breaks (join lines) --- eol allow backspacing over line breaks (join lines)
--- start allow backspacing over the start of insert; CTRL-W and CTRL-U --- start allow backspacing over the start of insert; CTRL-W and CTRL-U
--- stop once at the start of insert. --- stop once at the start of insert.
--- nostop like start, except CTRL-W and CTRL-U do not stop at the start of --- nostop like start, except CTRL-W and CTRL-U do not stop at the start
--- insert. --- of insert.
--- ---
--- When the value is empty, Vi compatible backspacing is used, none of --- When the value is empty, Vi compatible backspacing is used, none of
--- the ways mentioned for the items above are possible. --- the ways mentioned for the items above are possible.
@@ -1077,19 +1077,19 @@ vim.bo.cms = vim.bo.commentstring
--- name of a function or a `Funcref`. For `Funcref` values, --- name of a function or a `Funcref`. For `Funcref` values,
--- spaces must be escaped with a backslash ('\'), and commas with --- spaces must be escaped with a backslash ('\'), and commas with
--- double backslashes ('\\') (see `option-backslash`). --- double backslashes ('\\') (see `option-backslash`).
--- Unlike other sources, functions can provide completions starting --- Unlike other sources, functions can provide completions
--- from a non-keyword character before the cursor, and their --- starting from a non-keyword character before the cursor, and
--- start position for replacing text may differ from other sources. --- their start position for replacing text may differ from other
--- If the Dict returned by the {func} includes {"refresh": "always"}, --- sources. If the Dict returned by the {func} includes
--- the function will be invoked again whenever the leading text --- `{"refresh": "always"}`, the function will be invoked again
--- changes. --- whenever the leading text changes.
--- If generating matches is potentially slow, call --- If generating matches is potentially slow, call
--- `complete_check()` periodically to keep Vim responsive. This --- `complete_check()` periodically to keep Vim responsive. This
--- is especially important for `ins-autocompletion`. --- is especially important for `ins-autocompletion`.
--- F equivalent to using "F{func}", where the function is taken from --- F equivalent to using "F{func}", where the function is taken
--- the 'completefunc' option. --- from the 'completefunc' option.
--- o equivalent to using "F{func}", where the function is taken from --- o equivalent to using "F{func}", where the function is taken
--- the 'omnifunc' option. --- from the 'omnifunc' option.
--- ---
--- Unloaded buffers are not loaded, thus their autocmds `:autocmd` are --- Unloaded buffers are not loaded, thus their autocmds `:autocmd` are
--- not executed, this may lead to unexpected completions from some files --- not executed, this may lead to unexpected completions from some files
@@ -1104,8 +1104,8 @@ vim.bo.cms = vim.bo.commentstring
--- ---
--- An optional match limit can be specified for a completion source by --- An optional match limit can be specified for a completion source by
--- appending a caret ("^") followed by a {count} to the source flag. --- appending a caret ("^") followed by a {count} to the source flag.
--- For example: ".^9,w,u,t^5" limits matches from the current buffer --- For example: ".^9,w,u,t^5" limits matches from the current buffer to 9
--- to 9 and from tags to 5. Other sources remain unlimited. --- and from tags to 5. Other sources remain unlimited.
--- Note: The match limit takes effect only during forward completion --- Note: The match limit takes effect only during forward completion
--- (CTRL-N) and is ignored during backward completion (CTRL-P). --- (CTRL-N) and is ignored during backward completion (CTRL-P).
--- ---
@@ -1171,7 +1171,7 @@ vim.go.cia = vim.go.completeitemalign
--- A comma-separated list of options for Insert mode completion --- A comma-separated list of options for Insert mode completion
--- `ins-completion`. The supported values are: --- `ins-completion`. The supported values are:
--- ---
--- fuzzy Enable `fuzzy-matching` for completion candidates. This --- fuzzy Enable `fuzzy-matching` for completion candidates. This
--- allows for more flexible and intuitive matching, where --- allows for more flexible and intuitive matching, where
--- characters can be skipped and matches can be found even --- characters can be skipped and matches can be found even
--- if the exact sequence is not typed. Note: This option --- if the exact sequence is not typed. Note: This option
@@ -1249,9 +1249,9 @@ vim.go.cot = vim.go.completeopt
--- only modifiable in MS-Windows --- only modifiable in MS-Windows
--- When this option is set it overrules 'shellslash' for completion: --- When this option is set it overrules 'shellslash' for completion:
--- - When this option is set to "slash", a forward slash is used for path --- - When this option is set to "slash", a forward slash is used for path
--- completion in insert mode. This is useful when editing HTML tag, or --- completion in insert mode. This is useful when editing HTML tag, or
--- Makefile with 'noshellslash' on MS-Windows. --- Makefile with 'noshellslash' on MS-Windows.
--- - When this option is set to "backslash", backslash is used. This is --- - When this option is set to "backslash", backslash is used. This is
--- useful when editing a batch file with 'shellslash' set on MS-Windows. --- useful when editing a batch file with 'shellslash' set on MS-Windows.
--- - When this option is empty, same character is used as for --- - When this option is empty, same character is used as for
--- 'shellslash'. --- 'shellslash'.
@@ -1572,7 +1572,7 @@ vim.bo.ci = vim.bo.copyindent
--- *cpo-;* --- *cpo-;*
--- ; When using `,` or `;` to repeat the last `t` search --- ; When using `,` or `;` to repeat the last `t` search
--- and the cursor is right in front of the searched --- and the cursor is right in front of the searched
--- character, the cursor won't move. When not included, --- character, the cursor won't move. When not included,
--- the cursor would skip over it and jump to the --- the cursor would skip over it and jump to the
--- following occurrence. --- following occurrence.
--- *cpo-~* --- *cpo-~*
@@ -1733,7 +1733,7 @@ vim.go.deco = vim.go.delcombine
--- ---
--- When this option is empty or an entry "spell" is present, and spell --- When this option is empty or an entry "spell" is present, and spell
--- checking is enabled, words in the word lists for the currently active --- checking is enabled, words in the word lists for the currently active
--- 'spelllang' are used. See `spell`. --- 'spelllang' are used. See `spell`.
--- ---
--- To include a comma in a file name precede it with a backslash. Spaces --- To include a comma in a file name precede it with a backslash. Spaces
--- after a comma are ignored, otherwise spaces are included in the file --- after a comma are ignored, otherwise spaces are included in the file
@@ -1806,7 +1806,7 @@ vim.go.dex = vim.go.diffexpr
--- All are optional. Items must be separated by a comma. --- All are optional. Items must be separated by a comma.
--- ---
--- algorithm:{text} Use the specified diff algorithm with the --- algorithm:{text} Use the specified diff algorithm with the
--- internal diff engine. Currently supported --- internal diff engine. Currently supported
--- algorithms are: --- algorithms are:
--- myers the default algorithm --- myers the default algorithm
--- minimal spend extra time to generate the --- minimal spend extra time to generate the
@@ -1829,7 +1829,7 @@ vim.go.dex = vim.go.diffexpr
--- When omitted a context of six lines is used. --- When omitted a context of six lines is used.
--- When using zero the context is actually one, --- When using zero the context is actually one,
--- since folds require a line in between, also --- since folds require a line in between, also
--- for a deleted line. Set it to a very large --- for a deleted line. Set it to a very large
--- value (999999) to disable folding completely. --- value (999999) to disable folding completely.
--- See `fold-diff`. --- See `fold-diff`.
--- ---
@@ -1912,14 +1912,14 @@ vim.go.dex = vim.go.diffexpr
--- exactly. --- exactly.
--- ---
--- linematch:{n} Align and mark changes between the most --- linematch:{n} Align and mark changes between the most
--- similar lines between the buffers. When the --- similar lines between the buffers. When the
--- total number of lines in the diff hunk exceeds --- total number of lines in the diff hunk exceeds
--- {n}, the lines will not be aligned because for --- {n}, the lines will not be aligned because for
--- very large diff hunks there will be a --- very large diff hunks there will be a
--- noticeable lag. A reasonable setting is --- noticeable lag. A reasonable setting is
--- "linematch:60", as this will enable alignment --- "linematch:60", as this will enable alignment
--- for a 2 buffer diff hunk of 30 lines each, --- for a 2 buffer diff hunk of 30 lines each, or
--- or a 3 buffer diff hunk of 20 lines each. --- a 3 buffer diff hunk of 20 lines each.
--- Implicitly sets "filler" when this is set. --- Implicitly sets "filler" when this is set.
--- ---
--- vertical Start diff mode with vertical splits (unless --- vertical Start diff mode with vertical splits (unless
@@ -1972,7 +1972,7 @@ vim.go.dg = vim.go.digraph
--- file name uniqueness in the preserve directory. --- file name uniqueness in the preserve directory.
--- On Win32, it is also possible to end with "\\". However, When a --- On Win32, it is also possible to end with "\\". However, When a
--- separating comma is following, you must use "//", since "\\" will --- separating comma is following, you must use "//", since "\\" will
--- include the comma in the file name. Therefore it is recommended to --- include the comma in the file name. Therefore it is recommended to
--- use '//', instead of '\\'. --- use '//', instead of '\\'.
--- - Spaces after the comma are ignored, other spaces are considered part --- - Spaces after the comma are ignored, other spaces are considered part
--- of the directory name. To have a space at the start of a directory --- of the directory name. To have a space at the start of a directory
@@ -2136,7 +2136,7 @@ vim.go.ep = vim.go.equalprg
--- makes a difference for error messages, the bell will be used always --- makes a difference for error messages, the bell will be used always
--- for a lot of errors without a message (e.g., hitting <Esc> in Normal --- for a lot of errors without a message (e.g., hitting <Esc> in Normal
--- mode). See 'visualbell' to make the bell behave like a screen flash --- mode). See 'visualbell' to make the bell behave like a screen flash
--- or do nothing. See 'belloff' to finetune when to ring the bell. --- or do nothing. See 'belloff' to finetune when to ring the bell.
--- ---
--- @type boolean --- @type boolean
vim.o.errorbells = false vim.o.errorbells = false
@@ -3025,7 +3025,7 @@ vim.go.fs = vim.go.fsync
--- :s///gg subst. all subst. one --- :s///gg subst. all subst. one
--- ---
--- NOTE: Setting this option may break plugins that rely on the default --- NOTE: Setting this option may break plugins that rely on the default
--- behavior of the 'g' flag. This will also make the 'g' flag have the --- behavior of the 'g' flag. This will also make the 'g' flag have the
--- opposite effect of that documented in `:s_g`. --- opposite effect of that documented in `:s_g`.
--- ---
--- @type boolean --- @type boolean
@@ -3556,7 +3556,7 @@ vim.bo.inex = vim.bo.includeexpr
--- avoid that Vim hangs while you are typing the pattern. --- avoid that Vim hangs while you are typing the pattern.
--- The `hl-IncSearch` highlight group determines the highlighting. --- The `hl-IncSearch` highlight group determines the highlighting.
--- When 'hlsearch' is on, all matched strings are highlighted too while --- When 'hlsearch' is on, all matched strings are highlighted too while
--- typing a search command. See also: 'hlsearch'. --- typing a search command. See also: 'hlsearch'.
--- If you don't want to turn 'hlsearch' on, but want to highlight all --- If you don't want to turn 'hlsearch' on, but want to highlight all
--- matches while searching, you can turn on and off 'hlsearch' with --- matches while searching, you can turn on and off 'hlsearch' with
--- autocmd. Example: --- autocmd. Example:
@@ -4033,8 +4033,8 @@ vim.wo.lhi = vim.wo.lhistory
--- than at the last character that fits on the screen. Unlike --- than at the last character that fits on the screen. Unlike
--- 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, --- 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
--- it only affects the way the file is displayed, not its contents. --- it only affects the way the file is displayed, not its contents.
--- If 'breakindent' is set, line is visually indented. Then, the value --- If 'breakindent' is set, line is visually indented. Then, the value
--- of 'showbreak' is used to put in front of wrapped lines. This option --- of 'showbreak' is used to put in front of wrapped lines. This option
--- is not used when the 'wrap' option is off. --- is not used when the 'wrap' option is off.
--- Note that <Tab> characters after an <EOL> are mostly not displayed --- Note that <Tab> characters after an <EOL> are mostly not displayed
--- with the right amount of white space. --- with the right amount of white space.
@@ -4737,8 +4737,8 @@ vim.go.mousemodel = vim.o.mousemodel
vim.go.mousem = vim.go.mousemodel vim.go.mousem = vim.go.mousemodel
--- When on, mouse move events are delivered to the input queue and are --- When on, mouse move events are delivered to the input queue and are
--- available for mapping `<MouseMove>`. The default, off, avoids the mouse --- available for mapping `<MouseMove>`. The default, off, avoids the
--- movement overhead except when needed. --- mouse movement overhead except when needed.
--- Warning: Setting this option can make pending mappings to be aborted --- Warning: Setting this option can make pending mappings to be aborted
--- when the mouse is moved. --- when the mouse is moved.
--- ---
@@ -4796,7 +4796,7 @@ vim.go.mouset = vim.go.mousetime
--- bin If included, numbers starting with "0b" or "0B" will be --- bin If included, numbers starting with "0b" or "0B" will be
--- considered to be binary. Example: Using CTRL-X on --- considered to be binary. Example: Using CTRL-X on
--- "0b1000" subtracts one, resulting in "0b0111". --- "0b1000" subtracts one, resulting in "0b0111".
--- unsigned If included, numbers are recognized as unsigned. Thus a --- unsigned If included, numbers are recognized as unsigned. Thus a
--- leading dash or negative sign won't be considered as part of --- leading dash or negative sign won't be considered as part of
--- the number. Examples: --- the number. Examples:
--- Using CTRL-X on "2020" in "9-2020" results in "9-2019" --- Using CTRL-X on "2020" in "9-2020" results in "9-2019"
@@ -4860,14 +4860,14 @@ vim.wo.nu = vim.wo.number
--- Minimal number of columns to use for the line number. Only relevant --- Minimal number of columns to use for the line number. Only relevant
--- when the 'number' or 'relativenumber' option is set or printing lines --- when the 'number' or 'relativenumber' option is set or printing lines
--- with a line number. Since one space is always between the number and --- with a line number. Since one space is always between the number and
--- the text, there is one less character for the number itself. --- the text, there is one less character for the number itself.
--- The value is the minimum width. A bigger width is used when needed to --- The value is the minimum width. A bigger width is used when needed to
--- fit the highest line number in the buffer respectively the number of --- fit the highest line number in the buffer respectively the number of
--- rows in the window, depending on whether 'number' or 'relativenumber' --- rows in the window, depending on whether 'number' or 'relativenumber'
--- is set. Thus with the Vim default of 4 there is room for a line number --- is set. Thus with the Vim default of 4 there is room for a line
--- up to 999. When the buffer has 1000 lines five columns will be used. --- number up to 999. When the buffer has 1000 lines five columns will be
--- The minimum value is 1, the maximum value is 20. --- used. The minimum value is 1, the maximum value is 20.
--- ---
--- @type integer --- @type integer
vim.o.numberwidth = 4 vim.o.numberwidth = 4
@@ -5269,12 +5269,12 @@ vim.go.regexpengine = vim.o.regexpengine
vim.go.re = vim.go.regexpengine vim.go.re = vim.go.regexpengine
--- Show the line number relative to the line with the cursor in front of --- Show the line number relative to the line with the cursor in front of
--- each line. Relative line numbers help you use the `count` you can --- each line. Relative line numbers help you use the `count` you can
--- precede some vertical motion commands (e.g. j k + -) with, without --- precede some vertical motion commands (e.g. j k + -) with, without
--- having to calculate it yourself. Especially useful in combination with --- having to calculate it yourself. Especially useful in combination
--- other commands (e.g. y d c < > gq gw =). --- with other commands (e.g. y d c < > gq gw =).
--- When the 'n' option is excluded from 'cpoptions' a wrapped --- When the 'n' option is excluded from 'cpoptions' a wrapped line will
--- line will not use the column of line numbers. --- not use the column of line numbers.
--- The 'numberwidth' option can be used to set the room used for the line --- The 'numberwidth' option can be used to set the room used for the line
--- number. --- number.
--- When a long, wrapped line doesn't start with the first character, '-' --- When a long, wrapped line doesn't start with the first character, '-'
@@ -6027,7 +6027,7 @@ vim.go.sxe = vim.go.shellxescape
--- the "!" and ":!" commands. Includes the redirection. See --- the "!" and ":!" commands. Includes the redirection. See
--- 'shellquote' to exclude the redirection. It's probably not useful --- 'shellquote' to exclude the redirection. It's probably not useful
--- to set both options. --- to set both options.
--- When the value is '(' then ')' is appended. When the value is '"(' --- When the value is '(' then ')' is appended. When the value is '"('
--- then ')"' is appended. --- then ')"' is appended.
--- When the value is '(' then also see 'shellxescape'. --- When the value is '(' then also see 'shellxescape'.
--- This option cannot be set from a `modeline` or in the `sandbox`, for --- This option cannot be set from a `modeline` or in the `sandbox`, for
@@ -6298,12 +6298,12 @@ vim.wo.siso = vim.wo.sidescrolloff
vim.go.sidescrolloff = vim.o.sidescrolloff vim.go.sidescrolloff = vim.o.sidescrolloff
vim.go.siso = vim.go.sidescrolloff vim.go.siso = vim.go.sidescrolloff
--- When and how to draw the signcolumn. Valid values are: --- When and how to draw the signcolumn. Valid values are:
--- "auto" only when there is a sign to display --- "auto" only when there is a sign to display
--- "auto:[1-9]" resize to accommodate multiple signs up to the --- "auto:[1-9]" resize to accommodate multiple signs up to the
--- given number (maximum 9), e.g. "auto:4" --- given number (maximum 9), e.g. "auto:4"
--- "auto:[1-8]-[2-9]" --- "auto:[1-8]-[2-9]"
--- resize to accommodate multiple signs up to the --- resize to accommodate multiple signs up to the
--- given maximum number (maximum 9) while keeping --- given maximum number (maximum 9) while keeping
--- at least the given minimum (maximum 8) fixed --- at least the given minimum (maximum 8) fixed
--- space. The minimum number should always be less --- space. The minimum number should always be less
@@ -6311,8 +6311,8 @@ vim.go.siso = vim.go.sidescrolloff
--- "no" never --- "no" never
--- "yes" always --- "yes" always
--- "yes:[1-9]" always, with fixed space for signs up to the given --- "yes:[1-9]" always, with fixed space for signs up to the given
--- number (maximum 9), e.g. "yes:3" --- number (maximum 9), e.g. "yes:3"
--- "number" display signs in the 'number' column. If the number --- "number" display signs in the 'number' column. If the number
--- column is not present, then behaves like "auto". --- column is not present, then behaves like "auto".
--- ---
--- @type 'yes'|'no'|'auto'|'auto:1'|'auto:2'|'auto:3'|'auto:4'|'auto:5'|'auto:6'|'auto:7'|'auto:8'|'auto:9'|'yes:1'|'yes:2'|'yes:3'|'yes:4'|'yes:5'|'yes:6'|'yes:7'|'yes:8'|'yes:9'|'number' --- @type 'yes'|'no'|'auto'|'auto:1'|'auto:2'|'auto:3'|'auto:4'|'auto:5'|'auto:6'|'auto:7'|'auto:8'|'auto:9'|'yes:1'|'yes:2'|'yes:3'|'yes:4'|'yes:5'|'yes:6'|'yes:7'|'yes:8'|'yes:9'|'number'
@@ -6378,7 +6378,7 @@ vim.go.sta = vim.go.smarttab
--- Scrolling works with screen lines. When 'wrap' is set and the first --- Scrolling works with screen lines. When 'wrap' is set and the first
--- line in the window wraps part of it may not be visible, as if it is --- line in the window wraps part of it may not be visible, as if it is
--- above the window. "<<<" is displayed at the start of the first line, --- above the window. "<<<" is displayed at the start of the first line,
--- highlighted with `hl-NonText`. --- highlighted with `hl-NonText`.
--- You may also want to add "lastline" to the 'display' option to show as --- You may also want to add "lastline" to the 'display' option to show as
--- much of the last line as possible. --- much of the last line as possible.
@@ -6484,7 +6484,7 @@ vim.bo.spf = vim.bo.spellfile
--- the two-letter, lower case region name. You can use more than one --- the two-letter, lower case region name. You can use more than one
--- region by listing them: "en_us,en_ca" supports both US and Canadian --- region by listing them: "en_us,en_ca" supports both US and Canadian
--- English, but not words specific for Australia, New Zealand or Great --- English, but not words specific for Australia, New Zealand or Great
--- Britain. (Note: currently en_au and en_nz dictionaries are older than --- Britain. (Note: currently en_au and en_nz dictionaries are older than
--- en_ca, en_gb and en_us). --- en_ca, en_gb and en_us).
--- If the name "cjk" is included East Asian characters are excluded from --- If the name "cjk" is included East Asian characters are excluded from
--- spell checking. This is useful when editing text that also has Asian --- spell checking. This is useful when editing text that also has Asian
@@ -6623,9 +6623,9 @@ vim.go.sb = vim.go.splitbelow
--- topline Keep the topline the same. --- topline Keep the topline the same.
--- ---
--- For the "screen" and "topline" values, the cursor position will be --- For the "screen" and "topline" values, the cursor position will be
--- changed when necessary. In this case, the jumplist will be populated --- changed when necessary. In this case, the jumplist will be populated
--- with the previous cursor position. For "screen", the text cannot always --- with the previous cursor position. For "screen", the text cannot
--- be kept on the same screen line when 'wrap' is enabled. --- always be kept on the same screen line when 'wrap' is enabled.
--- ---
--- @type 'cursor'|'screen'|'topline' --- @type 'cursor'|'screen'|'topline'
vim.o.splitkeep = "cursor" vim.o.splitkeep = "cursor"
@@ -7422,7 +7422,7 @@ vim.go.thesaurus = vim.o.thesaurus
vim.go.tsr = vim.go.thesaurus vim.go.tsr = vim.go.thesaurus
--- This option specifies a function to be used for thesaurus completion --- This option specifies a function to be used for thesaurus completion
--- with CTRL-X CTRL-T. `i_CTRL-X_CTRL-T` See `compl-thesaurusfunc`. --- with CTRL-X CTRL-T. `i_CTRL-X_CTRL-T` See `compl-thesaurusfunc`.
--- The value can be the name of a function, a `lambda` or a `Funcref`. --- The value can be the name of a function, a `lambda` or a `Funcref`.
--- See `option-value-function` for more information. --- See `option-value-function` for more information.
--- ---
@@ -7712,9 +7712,9 @@ vim.o.vsts = vim.o.varsofttabstop
vim.bo.varsofttabstop = vim.o.varsofttabstop vim.bo.varsofttabstop = vim.o.varsofttabstop
vim.bo.vsts = vim.bo.varsofttabstop vim.bo.vsts = vim.bo.varsofttabstop
--- Defines variable-width tab stops. The value is a comma-separated list --- Defines variable-width tab stops. The value is a comma-separated list
--- of widths in columns. Each width defines the number of columns --- of widths in columns. Each width defines the number of columns before
--- before the next tab stop; the last value repeats indefinitely. --- the next tab stop; the last value repeats indefinitely.
--- ---
--- For example: --- For example:
--- ``` --- ```
@@ -8129,16 +8129,16 @@ vim.go.wim = vim.go.wildmode
--- expressions or with 'smartcase' enabled. However, the --- expressions or with 'smartcase' enabled. However, the
--- case of the appended matched word may not exactly --- case of the appended matched word may not exactly
--- match the case of the word in the buffer. --- match the case of the word in the buffer.
--- fuzzy Use `fuzzy-matching` to find completion matches. When --- fuzzy Use `fuzzy-matching` to find completion matches. When
--- this value is specified, wildcard expansion will not --- this value is specified, wildcard expansion will not
--- be used for completion. The matches will be sorted by --- be used for completion. The matches will be sorted by
--- the "best match" rather than alphabetically sorted. --- the "best match" rather than alphabetically sorted.
--- This will find more matches than the wildcard --- This will find more matches than the wildcard
--- expansion. Currently fuzzy matching based completion --- expansion. Currently fuzzy matching based completion
--- is not supported for file and directory names and --- is not supported for file and directory names and
--- instead wildcard expansion is used. --- instead wildcard expansion is used.
--- pum Display the completion matches using the popup menu --- pum Display the completion matches using the popup menu in
--- in the same style as the `ins-completion-menu`. --- the same style as the `ins-completion-menu`.
--- tagfile When using CTRL-D to list matching tags, the kind of --- tagfile When using CTRL-D to list matching tags, the kind of
--- tag and the file of the tag is listed. Only one match --- tag and the file of the tag is listed. Only one match
--- is displayed per line. Often used tag kinds are: --- is displayed per line. Often used tag kinds are:

126
src/nvim/options.lua
View File

@@ -408,8 +408,8 @@ local options = {
eol allow backspacing over line breaks (join lines) eol allow backspacing over line breaks (join lines)
start allow backspacing over the start of insert; CTRL-W and CTRL-U start allow backspacing over the start of insert; CTRL-W and CTRL-U
stop once at the start of insert. stop once at the start of insert.
nostop like start, except CTRL-W and CTRL-U do not stop at the start of nostop like start, except CTRL-W and CTRL-U do not stop at the start
insert. of insert.
When the value is empty, Vi compatible backspacing is used, none of When the value is empty, Vi compatible backspacing is used, none of
the ways mentioned for the items above are possible. the ways mentioned for the items above are possible.
@@ -1513,19 +1513,19 @@ local options = {
name of a function or a |Funcref|. For |Funcref| values, name of a function or a |Funcref|. For |Funcref| values,
spaces must be escaped with a backslash ('\'), and commas with spaces must be escaped with a backslash ('\'), and commas with
double backslashes ('\\') (see |option-backslash|). double backslashes ('\\') (see |option-backslash|).
Unlike other sources, functions can provide completions starting Unlike other sources, functions can provide completions
from a non-keyword character before the cursor, and their starting from a non-keyword character before the cursor, and
start position for replacing text may differ from other sources. their start position for replacing text may differ from other
If the Dict returned by the {func} includes {"refresh": "always"}, sources. If the Dict returned by the {func} includes
the function will be invoked again whenever the leading text `{"refresh": "always"}`, the function will be invoked again
changes. whenever the leading text changes.
If generating matches is potentially slow, call If generating matches is potentially slow, call
|complete_check()| periodically to keep Vim responsive. This |complete_check()| periodically to keep Vim responsive. This
is especially important for |ins-autocompletion|. is especially important for |ins-autocompletion|.
F equivalent to using "F{func}", where the function is taken from F equivalent to using "F{func}", where the function is taken
the 'completefunc' option. from the 'completefunc' option.
o equivalent to using "F{func}", where the function is taken from o equivalent to using "F{func}", where the function is taken
the 'omnifunc' option. from the 'omnifunc' option.
Unloaded buffers are not loaded, thus their autocmds |:autocmd| are Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
not executed, this may lead to unexpected completions from some files not executed, this may lead to unexpected completions from some files
@@ -1540,8 +1540,8 @@ local options = {
An optional match limit can be specified for a completion source by An optional match limit can be specified for a completion source by
appending a caret ("^") followed by a {count} to the source flag. appending a caret ("^") followed by a {count} to the source flag.
For example: ".^9,w,u,t^5" limits matches from the current buffer For example: ".^9,w,u,t^5" limits matches from the current buffer to 9
to 9 and from tags to 5. Other sources remain unlimited. and from tags to 5. Other sources remain unlimited.
Note: The match limit takes effect only during forward completion Note: The match limit takes effect only during forward completion
(CTRL-N) and is ignored during backward completion (CTRL-P). (CTRL-N) and is ignored during backward completion (CTRL-P).
]=], ]=],
@@ -1653,7 +1653,7 @@ local options = {
A comma-separated list of options for Insert mode completion A comma-separated list of options for Insert mode completion
|ins-completion|. The supported values are: |ins-completion|. The supported values are:
fuzzy Enable |fuzzy-matching| for completion candidates. This fuzzy Enable |fuzzy-matching| for completion candidates. This
allows for more flexible and intuitive matching, where allows for more flexible and intuitive matching, where
characters can be skipped and matches can be found even characters can be skipped and matches can be found even
if the exact sequence is not typed. Note: This option if the exact sequence is not typed. Note: This option
@@ -1737,9 +1737,9 @@ local options = {
only modifiable in MS-Windows only modifiable in MS-Windows
When this option is set it overrules 'shellslash' for completion: When this option is set it overrules 'shellslash' for completion:
- When this option is set to "slash", a forward slash is used for path - When this option is set to "slash", a forward slash is used for path
completion in insert mode. This is useful when editing HTML tag, or completion in insert mode. This is useful when editing HTML tag, or
Makefile with 'noshellslash' on MS-Windows. Makefile with 'noshellslash' on MS-Windows.
- When this option is set to "backslash", backslash is used. This is - When this option is set to "backslash", backslash is used. This is
useful when editing a batch file with 'shellslash' set on MS-Windows. useful when editing a batch file with 'shellslash' set on MS-Windows.
- When this option is empty, same character is used as for - When this option is empty, same character is used as for
'shellslash'. 'shellslash'.
@@ -2088,7 +2088,7 @@ local options = {
*cpo-;* *cpo-;*
; When using |,| or |;| to repeat the last |t| search ; When using |,| or |;| to repeat the last |t| search
and the cursor is right in front of the searched and the cursor is right in front of the searched
character, the cursor won't move. When not included, character, the cursor won't move. When not included,
the cursor would skip over it and jump to the the cursor would skip over it and jump to the
following occurrence. following occurrence.
*cpo-~* *cpo-~*
@@ -2283,7 +2283,7 @@ local options = {
When this option is empty or an entry "spell" is present, and spell When this option is empty or an entry "spell" is present, and spell
checking is enabled, words in the word lists for the currently active checking is enabled, words in the word lists for the currently active
'spelllang' are used. See |spell|. 'spelllang' are used. See |spell|.
To include a comma in a file name precede it with a backslash. Spaces To include a comma in a file name precede it with a backslash. Spaces
after a comma are ignored, otherwise spaces are included in the file after a comma are ignored, otherwise spaces are included in the file
@@ -2403,7 +2403,7 @@ local options = {
All are optional. Items must be separated by a comma. All are optional. Items must be separated by a comma.
algorithm:{text} Use the specified diff algorithm with the algorithm:{text} Use the specified diff algorithm with the
internal diff engine. Currently supported internal diff engine. Currently supported
algorithms are: algorithms are:
myers the default algorithm myers the default algorithm
minimal spend extra time to generate the minimal spend extra time to generate the
@@ -2426,7 +2426,7 @@ local options = {
When omitted a context of six lines is used. When omitted a context of six lines is used.
When using zero the context is actually one, When using zero the context is actually one,
since folds require a line in between, also since folds require a line in between, also
for a deleted line. Set it to a very large for a deleted line. Set it to a very large
value (999999) to disable folding completely. value (999999) to disable folding completely.
See |fold-diff|. See |fold-diff|.
@@ -2509,14 +2509,14 @@ local options = {
exactly. exactly.
linematch:{n} Align and mark changes between the most linematch:{n} Align and mark changes between the most
similar lines between the buffers. When the similar lines between the buffers. When the
total number of lines in the diff hunk exceeds total number of lines in the diff hunk exceeds
{n}, the lines will not be aligned because for {n}, the lines will not be aligned because for
very large diff hunks there will be a very large diff hunks there will be a
noticeable lag. A reasonable setting is noticeable lag. A reasonable setting is
"linematch:60", as this will enable alignment "linematch:60", as this will enable alignment
for a 2 buffer diff hunk of 30 lines each, for a 2 buffer diff hunk of 30 lines each, or
or a 3 buffer diff hunk of 20 lines each. a 3 buffer diff hunk of 20 lines each.
Implicitly sets "filler" when this is set. Implicitly sets "filler" when this is set.
vertical Start diff mode with vertical splits (unless vertical Start diff mode with vertical splits (unless
@@ -2578,7 +2578,7 @@ local options = {
file name uniqueness in the preserve directory. file name uniqueness in the preserve directory.
On Win32, it is also possible to end with "\\". However, When a On Win32, it is also possible to end with "\\". However, When a
separating comma is following, you must use "//", since "\\" will separating comma is following, you must use "//", since "\\" will
include the comma in the file name. Therefore it is recommended to include the comma in the file name. Therefore it is recommended to
use '//', instead of '\\'. use '//', instead of '\\'.
- Spaces after the comma are ignored, other spaces are considered part - Spaces after the comma are ignored, other spaces are considered part
of the directory name. To have a space at the start of a directory of the directory name. To have a space at the start of a directory
@@ -2806,7 +2806,7 @@ local options = {
makes a difference for error messages, the bell will be used always makes a difference for error messages, the bell will be used always
for a lot of errors without a message (e.g., hitting <Esc> in Normal for a lot of errors without a message (e.g., hitting <Esc> in Normal
mode). See 'visualbell' to make the bell behave like a screen flash mode). See 'visualbell' to make the bell behave like a screen flash
or do nothing. See 'belloff' to finetune when to ring the bell. or do nothing. See 'belloff' to finetune when to ring the bell.
]=], ]=],
full_name = 'errorbells', full_name = 'errorbells',
scope = { 'global' }, scope = { 'global' },
@@ -3853,7 +3853,7 @@ local options = {
:s///gg subst. all subst. one :s///gg subst. all subst. one
NOTE: Setting this option may break plugins that rely on the default NOTE: Setting this option may break plugins that rely on the default
behavior of the 'g' flag. This will also make the 'g' flag have the behavior of the 'g' flag. This will also make the 'g' flag have the
opposite effect of that documented in |:s_g|. opposite effect of that documented in |:s_g|.
]=], ]=],
full_name = 'gdefault', full_name = 'gdefault',
@@ -4694,7 +4694,7 @@ local options = {
avoid that Vim hangs while you are typing the pattern. avoid that Vim hangs while you are typing the pattern.
The |hl-IncSearch| highlight group determines the highlighting. The |hl-IncSearch| highlight group determines the highlighting.
When 'hlsearch' is on, all matched strings are highlighted too while When 'hlsearch' is on, all matched strings are highlighted too while
typing a search command. See also: 'hlsearch'. typing a search command. See also: 'hlsearch'.
If you don't want to turn 'hlsearch' on, but want to highlight all If you don't want to turn 'hlsearch' on, but want to highlight all
matches while searching, you can turn on and off 'hlsearch' with matches while searching, you can turn on and off 'hlsearch' with
autocmd. Example: >vim autocmd. Example: >vim
@@ -5296,8 +5296,8 @@ local options = {
than at the last character that fits on the screen. Unlike than at the last character that fits on the screen. Unlike
'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
it only affects the way the file is displayed, not its contents. it only affects the way the file is displayed, not its contents.
If 'breakindent' is set, line is visually indented. Then, the value If 'breakindent' is set, line is visually indented. Then, the value
of 'showbreak' is used to put in front of wrapped lines. This option of 'showbreak' is used to put in front of wrapped lines. This option
is not used when the 'wrap' option is off. is not used when the 'wrap' option is off.
Note that <Tab> characters after an <EOL> are mostly not displayed Note that <Tab> characters after an <EOL> are mostly not displayed
with the right amount of white space. with the right amount of white space.
@@ -6142,8 +6142,8 @@ local options = {
defaults = false, defaults = false,
desc = [=[ desc = [=[
When on, mouse move events are delivered to the input queue and are When on, mouse move events are delivered to the input queue and are
available for mapping |<MouseMove>|. The default, off, avoids the mouse available for mapping |<MouseMove>|. The default, off, avoids the
movement overhead except when needed. mouse movement overhead except when needed.
Warning: Setting this option can make pending mappings to be aborted Warning: Setting this option can make pending mappings to be aborted
when the mouse is moved. when the mouse is moved.
]=], ]=],
@@ -6296,7 +6296,7 @@ local options = {
bin If included, numbers starting with "0b" or "0B" will be bin If included, numbers starting with "0b" or "0B" will be
considered to be binary. Example: Using CTRL-X on considered to be binary. Example: Using CTRL-X on
"0b1000" subtracts one, resulting in "0b0111". "0b1000" subtracts one, resulting in "0b0111".
unsigned If included, numbers are recognized as unsigned. Thus a unsigned If included, numbers are recognized as unsigned. Thus a
leading dash or negative sign won't be considered as part of leading dash or negative sign won't be considered as part of
the number. Examples: the number. Examples:
Using CTRL-X on "2020" in "9-2020" results in "9-2019" Using CTRL-X on "2020" in "9-2020" results in "9-2019"
@@ -6370,14 +6370,14 @@ local options = {
desc = [=[ desc = [=[
Minimal number of columns to use for the line number. Only relevant Minimal number of columns to use for the line number. Only relevant
when the 'number' or 'relativenumber' option is set or printing lines when the 'number' or 'relativenumber' option is set or printing lines
with a line number. Since one space is always between the number and with a line number. Since one space is always between the number and
the text, there is one less character for the number itself. the text, there is one less character for the number itself.
The value is the minimum width. A bigger width is used when needed to The value is the minimum width. A bigger width is used when needed to
fit the highest line number in the buffer respectively the number of fit the highest line number in the buffer respectively the number of
rows in the window, depending on whether 'number' or 'relativenumber' rows in the window, depending on whether 'number' or 'relativenumber'
is set. Thus with the Vim default of 4 there is room for a line number is set. Thus with the Vim default of 4 there is room for a line
up to 999. When the buffer has 1000 lines five columns will be used. number up to 999. When the buffer has 1000 lines five columns will be
The minimum value is 1, the maximum value is 20. used. The minimum value is 1, the maximum value is 20.
]=], ]=],
full_name = 'numberwidth', full_name = 'numberwidth',
redraw = { 'current_window' }, redraw = { 'current_window' },
@@ -6924,12 +6924,12 @@ local options = {
defaults = false, defaults = false,
desc = [=[ desc = [=[
Show the line number relative to the line with the cursor in front of Show the line number relative to the line with the cursor in front of
each line. Relative line numbers help you use the |count| you can each line. Relative line numbers help you use the |count| you can
precede some vertical motion commands (e.g. j k + -) with, without precede some vertical motion commands (e.g. j k + -) with, without
having to calculate it yourself. Especially useful in combination with having to calculate it yourself. Especially useful in combination
other commands (e.g. y d c < > gq gw =). with other commands (e.g. y d c < > gq gw =).
When the 'n' option is excluded from 'cpoptions' a wrapped When the 'n' option is excluded from 'cpoptions' a wrapped line will
line will not use the column of line numbers. not use the column of line numbers.
The 'numberwidth' option can be used to set the room used for the line The 'numberwidth' option can be used to set the room used for the line
number. number.
When a long, wrapped line doesn't start with the first character, '-' When a long, wrapped line doesn't start with the first character, '-'
@@ -7922,7 +7922,7 @@ local options = {
the "!" and ":!" commands. Includes the redirection. See the "!" and ":!" commands. Includes the redirection. See
'shellquote' to exclude the redirection. It's probably not useful 'shellquote' to exclude the redirection. It's probably not useful
to set both options. to set both options.
When the value is '(' then ')' is appended. When the value is '"(' When the value is '(' then ')' is appended. When the value is '"('
then ')"' is appended. then ')"' is appended.
When the value is '(' then also see 'shellxescape'. When the value is '(' then also see 'shellxescape'.
This option cannot be set from a |modeline| or in the |sandbox|, for This option cannot be set from a |modeline| or in the |sandbox|, for
@@ -8267,12 +8267,12 @@ local options = {
'number', 'number',
}, },
desc = [=[ desc = [=[
When and how to draw the signcolumn. Valid values are: When and how to draw the signcolumn. Valid values are:
"auto" only when there is a sign to display "auto" only when there is a sign to display
"auto:[1-9]" resize to accommodate multiple signs up to the "auto:[1-9]" resize to accommodate multiple signs up to the
given number (maximum 9), e.g. "auto:4" given number (maximum 9), e.g. "auto:4"
"auto:[1-8]-[2-9]" "auto:[1-8]-[2-9]"
resize to accommodate multiple signs up to the resize to accommodate multiple signs up to the
given maximum number (maximum 9) while keeping given maximum number (maximum 9) while keeping
at least the given minimum (maximum 8) fixed at least the given minimum (maximum 8) fixed
space. The minimum number should always be less space. The minimum number should always be less
@@ -8280,8 +8280,8 @@ local options = {
"no" never "no" never
"yes" always "yes" always
"yes:[1-9]" always, with fixed space for signs up to the given "yes:[1-9]" always, with fixed space for signs up to the given
number (maximum 9), e.g. "yes:3" number (maximum 9), e.g. "yes:3"
"number" display signs in the 'number' column. If the number "number" display signs in the 'number' column. If the number
column is not present, then behaves like "auto". column is not present, then behaves like "auto".
]=], ]=],
full_name = 'signcolumn', full_name = 'signcolumn',
@@ -8364,7 +8364,7 @@ local options = {
desc = [=[ desc = [=[
Scrolling works with screen lines. When 'wrap' is set and the first Scrolling works with screen lines. When 'wrap' is set and the first
line in the window wraps part of it may not be visible, as if it is line in the window wraps part of it may not be visible, as if it is
above the window. "<<<" is displayed at the start of the first line, above the window. "<<<" is displayed at the start of the first line,
highlighted with |hl-NonText|. highlighted with |hl-NonText|.
You may also want to add "lastline" to the 'display' option to show as You may also want to add "lastline" to the 'display' option to show as
much of the last line as possible. much of the last line as possible.
@@ -8498,7 +8498,7 @@ local options = {
the two-letter, lower case region name. You can use more than one the two-letter, lower case region name. You can use more than one
region by listing them: "en_us,en_ca" supports both US and Canadian region by listing them: "en_us,en_ca" supports both US and Canadian
English, but not words specific for Australia, New Zealand or Great English, but not words specific for Australia, New Zealand or Great
Britain. (Note: currently en_au and en_nz dictionaries are older than Britain. (Note: currently en_au and en_nz dictionaries are older than
en_ca, en_gb and en_us). en_ca, en_gb and en_us).
If the name "cjk" is included East Asian characters are excluded from If the name "cjk" is included East Asian characters are excluded from
spell checking. This is useful when editing text that also has Asian spell checking. This is useful when editing text that also has Asian
@@ -8667,9 +8667,9 @@ local options = {
topline Keep the topline the same. topline Keep the topline the same.
For the "screen" and "topline" values, the cursor position will be For the "screen" and "topline" values, the cursor position will be
changed when necessary. In this case, the jumplist will be populated changed when necessary. In this case, the jumplist will be populated
with the previous cursor position. For "screen", the text cannot always with the previous cursor position. For "screen", the text cannot
be kept on the same screen line when 'wrap' is enabled. always be kept on the same screen line when 'wrap' is enabled.
]=], ]=],
full_name = 'splitkeep', full_name = 'splitkeep',
scope = { 'global' }, scope = { 'global' },
@@ -9611,7 +9611,7 @@ local options = {
defaults = '', defaults = '',
desc = [=[ desc = [=[
This option specifies a function to be used for thesaurus completion This option specifies a function to be used for thesaurus completion
with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|. with CTRL-X CTRL-T. |i_CTRL-X_CTRL-T| See |compl-thesaurusfunc|.
The value can be the name of a function, a |lambda| or a |Funcref|. The value can be the name of a function, a |lambda| or a |Funcref|.
See |option-value-function| for more information. See |option-value-function| for more information.
@@ -9983,9 +9983,9 @@ local options = {
cb = 'did_set_vartabstop', cb = 'did_set_vartabstop',
defaults = '', defaults = '',
desc = [=[ desc = [=[
Defines variable-width tab stops. The value is a comma-separated list Defines variable-width tab stops. The value is a comma-separated list
of widths in columns. Each width defines the number of columns of widths in columns. Each width defines the number of columns before
before the next tab stop; the last value repeats indefinitely. the next tab stop; the last value repeats indefinitely.
For example: > For example: >
:set vartabstop=4,8 :set vartabstop=4,8
@@ -10468,16 +10468,16 @@ local options = {
expressions or with 'smartcase' enabled. However, the expressions or with 'smartcase' enabled. However, the
case of the appended matched word may not exactly case of the appended matched word may not exactly
match the case of the word in the buffer. match the case of the word in the buffer.
fuzzy Use |fuzzy-matching| to find completion matches. When fuzzy Use |fuzzy-matching| to find completion matches. When
this value is specified, wildcard expansion will not this value is specified, wildcard expansion will not
be used for completion. The matches will be sorted by be used for completion. The matches will be sorted by
the "best match" rather than alphabetically sorted. the "best match" rather than alphabetically sorted.
This will find more matches than the wildcard This will find more matches than the wildcard
expansion. Currently fuzzy matching based completion expansion. Currently fuzzy matching based completion
is not supported for file and directory names and is not supported for file and directory names and
instead wildcard expansion is used. instead wildcard expansion is used.
pum Display the completion matches using the popup menu pum Display the completion matches using the popup menu in
in the same style as the |ins-completion-menu|. the same style as the |ins-completion-menu|.
tagfile When using CTRL-D to list matching tags, the kind of tagfile When using CTRL-D to list matching tags, the kind of
tag and the file of the tag is listed. Only one match tag and the file of the tag is listed. Only one match
is displayed per line. Often used tag kinds are: is displayed per line. Often used tag kinds are: