aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/options.lua
diff options
context:
space:
mode:
authorJosh Rahm <joshuarahm@gmail.com>2024-03-09 14:57:57 -0700
committerJosh Rahm <joshuarahm@gmail.com>2024-03-09 14:57:57 -0700
commitc324271b99eee4c621463f368914d57cd729bd9c (patch)
tree5d979d333a2d5f9c080991d5482fd5916f8579c6 /src/nvim/options.lua
parent931bffbda3668ddc609fc1da8f9eb576b170aa52 (diff)
parentade1b12f49c3b3914c74847d791eb90ea90b56b7 (diff)
downloadrneovim-c324271b99eee4c621463f368914d57cd729bd9c.tar.gz
rneovim-c324271b99eee4c621463f368914d57cd729bd9c.tar.bz2
rneovim-c324271b99eee4c621463f368914d57cd729bd9c.zip
Merge remote-tracking branch 'upstream/master' into userreg
Diffstat (limited to 'src/nvim/options.lua')
-rw-r--r--src/nvim/options.lua1474
1 files changed, 739 insertions, 735 deletions
diff --git a/src/nvim/options.lua b/src/nvim/options.lua
index 0e2bd83806..632732d7b7 100644
--- a/src/nvim/options.lua
+++ b/src/nvim/options.lua
@@ -2,10 +2,11 @@
--- @field full_name string
--- @field desc? string
--- @field abbreviation? string
+--- @field alias? string|string[]
--- @field short_desc? string|fun(): string
--- @field varname? string
--- @field pv_name? string
---- @field type 'bool'|'number'|'string'
+--- @field type 'boolean'|'number'|'string'
--- @field immutable? boolean
--- @field list? 'comma'|'onecomma'|'commacolon'|'onecommacolon'|'flags'|'flagscomma'
--- @field scope vim.option_scope[]
@@ -44,10 +45,10 @@
--- |'statuslines'
--- |'tabline'
--- |'current_window'
---- |'current_window_only'
--- |'current_buffer'
--- |'all_windows'
--- |'curswant'
+--- |'highlight_only'
--- |'ui_option'
--- @param s string
@@ -60,7 +61,7 @@ end
--- @return fun(): string
local function macros(s)
return function()
- return s
+ return '.string=' .. s
end
end
@@ -68,7 +69,7 @@ end
--- @return fun(): string
local function imacros(s)
return function()
- return '(intptr_t)' .. s
+ return '.number=' .. s
end
end
@@ -84,6 +85,7 @@ end
return {
cstr = cstr,
--- @type vim.option_meta[]
+ --- The order of the options MUST be alphabetic for ":set all".
options = {
{
abbreviation = 'al',
@@ -94,56 +96,6 @@ return {
type = 'number',
},
{
- abbreviation = 'arab',
- cb = 'did_set_arabic',
- defaults = { if_true = false },
- desc = [=[
- This option can be set to start editing Arabic text.
- Setting this option will:
- - Set the 'rightleft' option, unless 'termbidi' is set.
- - Set the 'arabicshape' option, unless 'termbidi' is set.
- - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
- between typing English and Arabic key mapping.
- - Set the 'delcombine' option
-
- Resetting this option will:
- - Reset the 'rightleft' option.
- - Disable the use of 'keymap' (without changing its value).
- Note that 'arabicshape' and 'delcombine' are not reset (it is a global
- option).
- Also see |arabic.txt|.
- ]=],
- full_name = 'arabic',
- redraw = { 'curswant' },
- scope = { 'window' },
- short_desc = N_('Arabic as a default second language'),
- type = 'bool',
- },
- {
- abbreviation = 'arshape',
- defaults = { if_true = true },
- desc = [=[
- When on and 'termbidi' is off, the required visual character
- corrections that need to take place for displaying the Arabic language
- take effect. Shaping, in essence, gets enabled; the term is a broad
- one which encompasses:
- a) the changing/morphing of characters based on their location
- within a word (initial, medial, final and stand-alone).
- b) the enabling of the ability to compose characters
- c) the enabling of the required combining of some characters
- When disabled the display shows each character's true stand-alone
- form.
- Arabic is a complex language which requires other settings, for
- further details see |arabic.txt|.
- ]=],
- full_name = 'arabicshape',
- redraw = { 'all_windows', 'ui_option' },
- scope = { 'global' },
- short_desc = N_('do shaping for Arabic characters'),
- type = 'bool',
- varname = 'p_arshape',
- },
- {
abbreviation = 'ari',
defaults = { if_true = false },
desc = [=[
@@ -155,7 +107,7 @@ return {
full_name = 'allowrevins',
scope = { 'global' },
short_desc = N_('allow CTRL-_ in Insert and Command-line mode'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_ari',
},
{
@@ -203,6 +155,56 @@ return {
varname = 'p_ambw',
},
{
+ abbreviation = 'arab',
+ cb = 'did_set_arabic',
+ defaults = { if_true = false },
+ desc = [=[
+ This option can be set to start editing Arabic text.
+ Setting this option will:
+ - Set the 'rightleft' option, unless 'termbidi' is set.
+ - Set the 'arabicshape' option, unless 'termbidi' is set.
+ - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
+ between typing English and Arabic key mapping.
+ - Set the 'delcombine' option
+
+ Resetting this option will:
+ - Reset the 'rightleft' option.
+ - Disable the use of 'keymap' (without changing its value).
+ Note that 'arabicshape' and 'delcombine' are not reset (it is a global
+ option).
+ Also see |arabic.txt|.
+ ]=],
+ full_name = 'arabic',
+ redraw = { 'curswant' },
+ scope = { 'window' },
+ short_desc = N_('Arabic as a default second language'),
+ type = 'boolean',
+ },
+ {
+ abbreviation = 'arshape',
+ defaults = { if_true = true },
+ desc = [=[
+ When on and 'termbidi' is off, the required visual character
+ corrections that need to take place for displaying the Arabic language
+ take effect. Shaping, in essence, gets enabled; the term is a broad
+ one which encompasses:
+ a) the changing/morphing of characters based on their location
+ within a word (initial, medial, final and stand-alone).
+ b) the enabling of the ability to compose characters
+ c) the enabling of the required combining of some characters
+ When disabled the display shows each character's true stand-alone
+ form.
+ Arabic is a complex language which requires other settings, for
+ further details see |arabic.txt|.
+ ]=],
+ full_name = 'arabicshape',
+ redraw = { 'all_windows', 'ui_option' },
+ scope = { 'global' },
+ short_desc = N_('do shaping for Arabic characters'),
+ type = 'boolean',
+ varname = 'p_arshape',
+ },
+ {
abbreviation = 'acd',
cb = 'did_set_autochdir',
defaults = { if_true = false },
@@ -217,7 +219,7 @@ return {
full_name = 'autochdir',
scope = { 'global' },
short_desc = N_('change directory to the file in the current window'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_acd',
},
{
@@ -239,7 +241,7 @@ return {
full_name = 'autoindent',
scope = { 'buffer' },
short_desc = N_('take indent for new line from previous line'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_ai',
},
{
@@ -252,14 +254,14 @@ return {
from before it was deleted. When it appears again then it is read.
|timestamp|
If this option has a local value, use this command to switch back to
- using the global value: >
- :set autoread<
+ using the global value: >vim
+ set autoread<
<
]=],
full_name = 'autoread',
scope = { 'global', 'buffer' },
short_desc = N_('autom. read file when changed outside of Vim'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_ar',
},
{
@@ -284,7 +286,7 @@ return {
full_name = 'autowrite',
scope = { 'global' },
short_desc = N_('automatically write file if changed'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_aw',
},
{
@@ -299,7 +301,7 @@ return {
full_name = 'autowriteall',
scope = { 'global' },
short_desc = N_("as 'autowrite', but works with more commands"),
- type = 'bool',
+ type = 'boolean',
varname = 'p_awa',
},
{
@@ -316,23 +318,19 @@ return {
See |:hi-normal| if you want to set the background color explicitly.
*g:colors_name*
When a color scheme is loaded (the "g:colors_name" variable is set)
- setting 'background' will cause the color scheme to be reloaded. If
+ changing 'background' will cause the color scheme to be reloaded. If
the color scheme adjusts to the value of 'background' this will work.
However, if the color scheme sets 'background' itself the effect may
be undone. First delete the "g:colors_name" variable when needed.
Normally this option would be set in the vimrc file. Possibly
- depending on the terminal name. Example: >
- :if $TERM ==# "xterm"
- : set background=dark
- :endif
- < When this option is set, the default settings for the highlight groups
+ depending on the terminal name. Example: >vim
+ if $TERM ==# "xterm"
+ set background=dark
+ endif
+ < When this option is changed, the default settings for the highlight groups
will change. To use other settings, place ":highlight" commands AFTER
the setting of the 'background' option.
- This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
- to select the colors for syntax highlighting. After changing this
- option, you must load syntax.vim again to see the result. This can be
- done with ":syntax on".
]=],
expand_cb = 'expand_set_background',
full_name = 'background',
@@ -387,7 +385,7 @@ return {
full_name = 'backup',
scope = { 'global' },
short_desc = N_('keep backup file after overwriting a file'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_bk',
},
{
@@ -498,12 +496,12 @@ return {
use '//', instead of '\\'.
- Environment variables are expanded |:set_env|.
- Careful with '\' characters, type one before a space, type two to
- get one in the option (see |option-backslash|), for example: >
- :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
+ get one in the option (see |option-backslash|), for example: >vim
+ set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
<
See also 'backup' and 'writebackup' options.
- If you want to hide your backup files on Unix, consider this value: >
- :set backupdir=./.backup,~/.backup,.,/tmp
+ If you want to hide your backup files on Unix, consider this value: >vim
+ set backupdir=./.backup,~/.backup,.,/tmp
< You must create a ".backup" directory in each directory and in your
home directory for this to work properly.
The use of |:set+=| and |:set-=| is preferred when adding or removing
@@ -535,8 +533,8 @@ return {
If you like to keep a lot of backups, you could use a BufWritePre
autocommand to change 'backupext' just before writing the file to
- include a timestamp. >
- :au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
+ include a timestamp. >vim
+ au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
< Use 'backupdir' to put the backup in a different directory.
]=],
full_name = 'backupext',
@@ -573,7 +571,7 @@ return {
Note that environment variables are not expanded. If you want to use
$HOME you must expand it explicitly, e.g.: >vim
- :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
+ let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
< Note that the default also makes sure that "crontab -e" works (when a
backup would be made by renaming the original file crontab won't see
@@ -671,7 +669,7 @@ return {
redraw = { 'statuslines' },
scope = { 'buffer' },
short_desc = N_('read/write/edit file in binary mode'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_bin',
},
{
@@ -699,7 +697,7 @@ return {
redraw = { 'statuslines' },
scope = { 'buffer' },
short_desc = N_('a Byte Order Mark to the file'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_bomb',
},
{
@@ -733,7 +731,7 @@ return {
redraw = { 'current_window' },
scope = { 'window' },
short_desc = N_('wrapped line repeats indent'),
- type = 'bool',
+ type = 'boolean',
},
{
abbreviation = 'briopt',
@@ -848,7 +846,7 @@ return {
scope = { 'buffer' },
short_desc = N_('whether the buffer shows up in the buffer list'),
tags = { 'E85' },
- type = 'bool',
+ type = 'boolean',
varname = 'p_bl',
},
{
@@ -950,7 +948,7 @@ return {
scope = { 'global' },
secure = true,
short_desc = N_(':cd without argument goes to the home directory'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_cdh',
},
{
@@ -971,8 +969,8 @@ return {
in the current directory first.
If the default value taken from $CDPATH is not what you want, include
a modified version of the following command in your vimrc file to
- override it: >
- :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
+ override it: >vim
+ let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
< This option cannot be set from a |modeline| or in the |sandbox|, for
security reasons.
(parts of 'cdpath' can be passed to the shell to expand file names).
@@ -997,9 +995,9 @@ return {
The key used in Command-line Mode to open the command-line window.
Only non-printable keys are allowed.
The key can be specified as a single character, but it is difficult to
- type. The preferred way is to use the <> notation. Examples: >
- :exe "set cedit=\\<C-Y>"
- :exe "set cedit=\\<Esc>"
+ type. The preferred way is to use the <> notation. Examples: >vim
+ exe "set cedit=\\<C-Y>"
+ exe "set cedit=\\<Esc>"
< |Nvi| also has this option, but it only uses the first character.
See |cmdwin|.
]=],
@@ -1045,7 +1043,7 @@ return {
Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
is done internally by Vim, 'charconvert' is not used for this.
Also used for Unicode conversion.
- Example: >
+ Example: >vim
set charconvert=CharConvert()
fun CharConvert()
system("recode "
@@ -1088,7 +1086,7 @@ return {
full_name = 'cindent',
scope = { 'buffer' },
short_desc = N_('do C program indenting'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_cin',
},
{
@@ -1129,6 +1127,25 @@ return {
varname = 'p_cino',
},
{
+ abbreviation = 'cinsd',
+ alloced = true,
+ defaults = { if_true = 'public,protected,private' },
+ deny_duplicates = true,
+ desc = [=[
+ Keywords that are interpreted as a C++ scope declaration by |cino-g|.
+ Useful e.g. for working with the Qt framework that defines additional
+ scope declarations "signals", "public slots" and "private slots": >vim
+ set cinscopedecls+=signals,public\ slots,private\ slots
+ <
+ ]=],
+ full_name = 'cinscopedecls',
+ list = 'onecomma',
+ scope = { 'buffer' },
+ short_desc = N_("words that are recognized by 'cino-g'"),
+ type = 'string',
+ varname = 'p_cinsd',
+ },
+ {
abbreviation = 'cinw',
alloced = true,
defaults = { if_true = 'if,else,while,do,for,switch' },
@@ -1149,25 +1166,6 @@ return {
varname = 'p_cinw',
},
{
- abbreviation = 'cinsd',
- alloced = true,
- defaults = { if_true = 'public,protected,private' },
- deny_duplicates = true,
- desc = [=[
- Keywords that are interpreted as a C++ scope declaration by |cino-g|.
- Useful e.g. for working with the Qt framework that defines additional
- scope declarations "signals", "public slots" and "private slots": >
- set cinscopedecls+=signals,public\ slots,private\ slots
- <
- ]=],
- full_name = 'cinscopedecls',
- list = 'onecomma',
- scope = { 'buffer' },
- short_desc = N_("words that are recognized by 'cino-g'"),
- type = 'string',
- varname = 'p_cinsd',
- },
- {
abbreviation = 'cb',
cb = 'did_set_clipboard',
defaults = { if_true = '' },
@@ -1253,26 +1251,27 @@ return {
highlighted with ColorColumn |hl-ColorColumn|. Useful to align
text. Will make screen redrawing slower.
The screen column can be an absolute number, or a number preceded with
- '+' or '-', which is added to or subtracted from 'textwidth'. >
+ '+' or '-', which is added to or subtracted from 'textwidth'. >vim
- :set cc=+1 " highlight column after 'textwidth'
- :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
- :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
+ set cc=+1 " highlight column after 'textwidth'
+ set cc=+1,+2,+3 " highlight three columns after 'textwidth'
+ hi ColorColumn ctermbg=lightgrey guibg=lightgrey
<
When 'textwidth' is zero then the items with '-' and '+' are not used.
A maximum of 256 columns are highlighted.
]=],
full_name = 'colorcolumn',
list = 'onecomma',
- redraw = { 'current_window' },
+ redraw = { 'current_window', 'highlight_only' },
scope = { 'window' },
short_desc = N_('columns to highlight'),
type = 'string',
},
{
abbreviation = 'co',
+ cb = 'did_set_lines_or_columns',
defaults = {
- if_true = macros('DFLT_COLS'),
+ if_true = imacros('DFLT_COLS'),
doc = '80 or terminal width',
},
desc = [=[
@@ -1285,8 +1284,8 @@ return {
number of columns of the display, the display may be messed up. For
the GUI it is always possible and Vim limits the number of columns to
what fits on the screen. You can use this command to get the widest
- window possible: >
- :set columns=9999
+ window possible: >vim
+ set columns=9999
< Minimum value is 12, maximum value is 10000.
]=],
full_name = 'columns',
@@ -1341,7 +1340,7 @@ return {
full_name = 'compatible',
scope = { 'global' },
short_desc = N_('No description'),
- type = 'bool',
+ type = 'boolean',
immutable = true,
},
{
@@ -1363,8 +1362,8 @@ return {
k scan the files given with the 'dictionary' option
kspell use the currently active spell checking |spell|
k{dict} scan the file {dict}. Several "k" flags can be given,
- patterns are valid too. For example: >
- :set cpt=k/usr/dict/*,k~/spanish
+ patterns are valid too. For example: >vim
+ set cpt=k/usr/dict/*,k~/spanish
< s scan the files given with the 'thesaurus' option
s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
are valid too.
@@ -1394,65 +1393,6 @@ return {
varname = 'p_cpt',
},
{
- abbreviation = 'cocu',
- alloced = true,
- cb = 'did_set_concealcursor',
- defaults = { if_true = '' },
- desc = [=[
- Sets the modes in which text in the cursor line can also be concealed.
- When the current mode is listed then concealing happens just like in
- other lines.
- n Normal mode
- v Visual mode
- i Insert mode
- c Command line editing, for 'incsearch'
-
- 'v' applies to all lines in the Visual area, not only the cursor.
- A useful value is "nc". This is used in help files. So long as you
- are moving around text is concealed, but when starting to insert text
- or selecting a Visual area the concealed text is displayed, so that
- you can see what you are doing.
- Keep in mind that the cursor position is not always where it's
- displayed. E.g., when moving vertically it may change column.
- ]=],
- expand_cb = 'expand_set_concealcursor',
- full_name = 'concealcursor',
- list = 'flags',
- redraw = { 'current_window' },
- scope = { 'window' },
- short_desc = N_('whether concealable text is hidden in cursor line'),
- type = 'string',
- },
- {
- abbreviation = 'cole',
- defaults = { if_true = 0 },
- desc = [=[
- Determine how text with the "conceal" syntax attribute |:syn-conceal|
- is shown:
-
- Value Effect ~
- 0 Text is shown normally
- 1 Each block of concealed text is replaced with one
- character. If the syntax item does not have a custom
- replacement character defined (see |:syn-cchar|) the
- character defined in 'listchars' is used.
- It is highlighted with the "Conceal" highlight group.
- 2 Concealed text is completely hidden unless it has a
- custom replacement character defined (see
- |:syn-cchar|).
- 3 Concealed text is completely hidden.
-
- Note: in the cursor line concealed text is not hidden, so that you can
- edit and copy the text. This can be changed with the 'concealcursor'
- option.
- ]=],
- full_name = 'conceallevel',
- redraw = { 'current_window' },
- scope = { 'window' },
- short_desc = N_('whether concealable text is shown or hidden'),
- type = 'number',
- },
- {
abbreviation = 'cfu',
alloced = true,
cb = 'did_set_completefunc',
@@ -1502,13 +1442,17 @@ return {
completion in the preview window. Only works in
combination with "menu" or "menuone".
- noinsert Do not insert any text for a match until the user selects
+ noinsert Do not insert any text for a match until the user selects
a match from the menu. Only works in combination with
"menu" or "menuone". No effect if "longest" is present.
- noselect Do not select a match in the menu, force the user to
+ noselect Do not select a match in the menu, force the user to
select one from the menu. Only works in combination with
"menu" or "menuone".
+
+ popup Show extra information about the currently selected
+ completion in a popup window. Only works in combination
+ with "menu" or "menuone". Overrides "preview".
]=],
expand_cb = 'expand_set_completeopt',
full_name = 'completeopt',
@@ -1543,6 +1487,65 @@ return {
varname = 'p_csl',
},
{
+ abbreviation = 'cocu',
+ alloced = true,
+ cb = 'did_set_concealcursor',
+ defaults = { if_true = '' },
+ desc = [=[
+ Sets the modes in which text in the cursor line can also be concealed.
+ When the current mode is listed then concealing happens just like in
+ other lines.
+ n Normal mode
+ v Visual mode
+ i Insert mode
+ c Command line editing, for 'incsearch'
+
+ 'v' applies to all lines in the Visual area, not only the cursor.
+ A useful value is "nc". This is used in help files. So long as you
+ are moving around text is concealed, but when starting to insert text
+ or selecting a Visual area the concealed text is displayed, so that
+ you can see what you are doing.
+ Keep in mind that the cursor position is not always where it's
+ displayed. E.g., when moving vertically it may change column.
+ ]=],
+ expand_cb = 'expand_set_concealcursor',
+ full_name = 'concealcursor',
+ list = 'flags',
+ redraw = { 'current_window' },
+ scope = { 'window' },
+ short_desc = N_('whether concealable text is hidden in cursor line'),
+ type = 'string',
+ },
+ {
+ abbreviation = 'cole',
+ defaults = { if_true = 0 },
+ desc = [=[
+ Determine how text with the "conceal" syntax attribute |:syn-conceal|
+ is shown:
+
+ Value Effect ~
+ 0 Text is shown normally
+ 1 Each block of concealed text is replaced with one
+ character. If the syntax item does not have a custom
+ replacement character defined (see |:syn-cchar|) the
+ character defined in 'listchars' is used.
+ It is highlighted with the "Conceal" highlight group.
+ 2 Concealed text is completely hidden unless it has a
+ custom replacement character defined (see
+ |:syn-cchar|).
+ 3 Concealed text is completely hidden.
+
+ Note: in the cursor line concealed text is not hidden, so that you can
+ edit and copy the text. This can be changed with the 'concealcursor'
+ option.
+ ]=],
+ full_name = 'conceallevel',
+ redraw = { 'current_window' },
+ scope = { 'window' },
+ short_desc = N_('whether concealable text is shown or hidden'),
+ type = 'number',
+ },
+ {
abbreviation = 'cf',
defaults = { if_true = false },
desc = [=[
@@ -1558,7 +1561,7 @@ return {
full_name = 'confirm',
scope = { 'global' },
short_desc = N_('ask what to do about unsaved/read-only files'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_confirm',
},
{
@@ -1578,7 +1581,7 @@ return {
full_name = 'copyindent',
scope = { 'buffer' },
short_desc = N_("make 'autoindent' use existing indent structure"),
- type = 'bool',
+ type = 'boolean',
varname = 'p_ci',
},
{
@@ -1706,9 +1709,6 @@ return {
when it didn't exist when editing it. This is a
protection against a file unexpectedly created by
someone else. Vi didn't complain about this.
- *cpo-p*
- p Vi compatible Lisp indenting. When not present, a
- slightly better algorithm is used.
*cpo-P*
P When included, a ":write" command that appends to a
file will set the file name for the current buffer, if
@@ -1843,7 +1843,7 @@ return {
pv_name = 'p_crbind',
scope = { 'window' },
short_desc = N_('move cursor in window as it moves in other windows'),
- type = 'bool',
+ type = 'boolean',
},
{
abbreviation = 'cuc',
@@ -1853,16 +1853,16 @@ return {
|hl-CursorColumn|. Useful to align text. Will make screen redrawing
slower.
If you only want the highlighting in the current window you can use
- these autocommands: >
+ these autocommands: >vim
au WinLeave * set nocursorline nocursorcolumn
au WinEnter * set cursorline cursorcolumn
<
]=],
full_name = 'cursorcolumn',
- redraw = { 'current_window_only' },
+ redraw = { 'current_window', 'highlight_only' },
scope = { 'window' },
short_desc = N_('highlight the screen column of the cursor'),
- type = 'bool',
+ type = 'boolean',
},
{
abbreviation = 'cul',
@@ -1874,10 +1874,10 @@ return {
easier to see the selected text.
]=],
full_name = 'cursorline',
- redraw = { 'current_window_only' },
+ redraw = { 'current_window', 'highlight_only' },
scope = { 'window' },
short_desc = N_('highlight the screen line of the cursor'),
- type = 'bool',
+ type = 'boolean',
},
{
abbreviation = 'culopt',
@@ -1902,7 +1902,7 @@ return {
expand_cb = 'expand_set_cursorlineopt',
full_name = 'cursorlineopt',
list = 'onecomma',
- redraw = { 'current_window_only' },
+ redraw = { 'current_window', 'highlight_only' },
scope = { 'window' },
short_desc = N_("settings for 'cursorline'"),
type = 'string',
@@ -1950,7 +1950,7 @@ return {
< If the function is defined with `func_name : function() {...`: >
^\s*\ze\i\+\s*[:]\s*(*function\s*(
< When using the ":set" command, you need to double the backslashes!
- To avoid that use `:let` with a single quote string: >
+ To avoid that use `:let` with a single quote string: >vim
let &l:define = '^\s*\ze\k\+\s*=\s*function('
<
]=],
@@ -1978,7 +1978,7 @@ return {
full_name = 'delcombine',
scope = { 'global' },
short_desc = N_('delete combining characters on their own'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_deco',
},
{
@@ -2030,7 +2030,7 @@ return {
redraw = { 'current_window' },
scope = { 'window' },
short_desc = N_('diff mode for the current window'),
- type = 'bool',
+ type = 'boolean',
},
{
abbreviation = 'dex',
@@ -2157,11 +2157,11 @@ return {
patience patience diff algorithm
histogram histogram diff algorithm
- Examples: >
- :set diffopt=internal,filler,context:4
- :set diffopt=
- :set diffopt=internal,filler,foldcolumn:3
- :set diffopt-=internal " do NOT use the internal diff parser
+ Examples: >vim
+ set diffopt=internal,filler,context:4
+ set diffopt=
+ set diffopt=internal,filler,foldcolumn:3
+ set diffopt-=internal " do NOT use the internal diff parser
<
]=],
expand_cb = 'expand_set_diffopt',
@@ -2183,7 +2183,7 @@ return {
full_name = 'digraph',
scope = { 'global' },
short_desc = N_('enable the entering of digraphs in Insert mode'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_dg',
},
{
@@ -2222,8 +2222,8 @@ return {
- A directory name may end in an ':' or '/'.
- Environment variables are expanded |:set_env|.
- Careful with '\' characters, type one before a space, type two to
- get one in the option (see |option-backslash|), for example: >
- :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
+ get one in the option (see |option-backslash|), for example: >vim
+ set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
<
Editing the same file twice will result in a warning. Using "/tmp" on
is discouraged: if the system crashes you lose the swap file. And
@@ -2299,7 +2299,7 @@ return {
full_name = 'edcompatible',
scope = { 'global' },
short_desc = N_('No description'),
- type = 'bool',
+ type = 'boolean',
immutable = true,
},
{
@@ -2317,7 +2317,7 @@ return {
redraw = { 'all_windows', 'ui_option' },
scope = { 'global' },
short_desc = N_('No description'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_emoji',
},
{
@@ -2354,7 +2354,7 @@ return {
redraw = { 'statuslines' },
scope = { 'buffer' },
short_desc = N_('write CTRL-Z for last line in file'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_eof',
},
{
@@ -2380,7 +2380,7 @@ return {
redraw = { 'statuslines' },
scope = { 'buffer' },
short_desc = N_('write <EOL> for last line in file'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_eol',
},
{
@@ -2406,7 +2406,7 @@ return {
full_name = 'equalalways',
scope = { 'global' },
short_desc = N_('windows are automatically made the same size'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_ea',
},
{
@@ -2442,7 +2442,7 @@ return {
full_name = 'errorbells',
scope = { 'global' },
short_desc = N_('ring the bell for error messages'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_eb',
},
{
@@ -2493,8 +2493,8 @@ return {
A list of autocommand event names, which are to be ignored.
When set to "all" or when "all" is one of the items, all autocommand
events are ignored, autocommands will not be executed.
- Otherwise this is a comma-separated list of event names. Example: >
- :set ei=WinEnter,WinLeave
+ Otherwise this is a comma-separated list of event names. Example: >vim
+ set ei=WinEnter,WinLeave
<
]=],
expand_cb = 'expand_set_eventignore',
@@ -2517,7 +2517,7 @@ return {
full_name = 'expandtab',
scope = { 'buffer' },
short_desc = N_('use spaces when <Tab> is inserted'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_et',
},
{
@@ -2539,7 +2539,7 @@ return {
scope = { 'global' },
secure = true,
short_desc = N_('read .nvimrc and .exrc in the current directory'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_exrc',
},
{
@@ -2614,7 +2614,7 @@ return {
will work and the first entry of 'fileencodings' will be used (except
"ucs-bom", which requires the BOM to be present). If you prefer
another encoding use an BufReadPost autocommand event to test if your
- preferred encoding is to be used. Example: >
+ preferred encoding is to be used. Example: >vim
au BufReadPost * if search('\S', 'w') == 0 |
\ set fenc=iso-2022-jp | endif
< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
@@ -2622,8 +2622,8 @@ return {
When the |++enc| argument is used then the value of 'fileencodings' is
not used.
Note that 'fileencodings' is not used for a new file, the global value
- of 'fileencoding' is used instead. You can set it with: >
- :setglobal fenc=iso-8859-2
+ of 'fileencoding' is used instead. You can set it with: >vim
+ setglobal fenc=iso-8859-2
< This means that a non-existing file may get a different encoding than
an empty file.
The special value "ucs-bom" can be used to check for a Unicode BOM
@@ -2769,7 +2769,7 @@ return {
full_name = 'fileignorecase',
scope = { 'global' },
short_desc = N_('ignore case when using file names'),
- type = 'bool',
+ type = 'boolean',
varname = 'p_fic',
},
{
@@ -2787,11 +2787,11 @@ return {
this use the ":filetype on" command. |:filetype|
Setting this option to a different value is most useful in a modeline,
for a file for which the file type is not automatically recognized.
- Example, for in an IDL file: >
+ Example, for in an IDL file: >c
/* vim: set filetype=idl : */
< |FileType| |filetypes|
When a dot appears in the value then this separates two filetype
- names. Example: >
+ names. Example: >c
/* vim: set filetype=c.doxygen : */
< This will use the "c" filetype first, then the "doxygen" filetype.
This works both for filetype plugins and for syntax files. More than
@@ -2818,7 +2818,7 @@ return {
Characters to fill the statuslines, vertical separators and special
lines in the window.
It is a comma-separated list of items. Each item has a name, a colon
- and the value of that item:
+ and the value of that item: |E1511|
item default Used for ~
stl ' ' statusline of the current window
@@ -2851,12 +2851,12 @@ return {
"vert", "vertleft", "vertright", "verthoriz", "foldsep" and "fold"
default to single-byte alternatives.
- Example: >
- :set fillchars=stl:\ ,stlnc:\ ,vert:│,fold:·,diff:-
+ Example: >vim
+ set fillchars=stl:\ ,stlnc:\ ,vert:│,fold