Nvim :help
pages, generated
from source
using the tree-sitter-vimdoc parser.
boolean
toggle
number has a numeric value
string has a string value:se
:set
:se[t][!] Show all options that differ from their default value.
When [!] is present every option is on a separate
line.E518
E519
:se[t] {option}
Show value of {option}
.
NOTE: some legacy options were removed. nvim-removed{option}
Toggle option: set, switch it on.
Number option: show value.
String option: show value.:set-default
:set-&
:set-&vi
:set-&vim
:se[t] {option}
& Reset option to its default value.
:se[t] {option}
&vi Reset option to its Vi default value.
:se[t] {option}
&vim Reset option to its Vim default value.:set-args
:set=
E487
E521
:se[t] {option}
={value} or
:se[t] {option}
:{value}
Set string or number option to {value}
.
For numeric options the value can be given in decimal,
hex (preceded with 0x) or octal (preceded with '0' or
'0o').
The old value can be inserted by typing 'wildchar' (by
default this is a <Tab>
). Many string options with
fixed syntax also support completing known values.
See cmdline-completion and complete-set-option.
White space between {option}
and '=' is allowed and
will be ignored. White space between '=' and {value}
is not allowed.
See option-backslash for using white space and
backslashes in {value}
.{option}
+={value} :set+=
{value}
to a number option, or append the
{value}
to a string option. When the option is a
comma-separated list, a comma is added, unless the
value was empty.
If the option is a list of flags, superfluous flags
are removed. When adding a flag that was already
present the option value doesn't change.
Also see :set-args above.{option}
^={value} :set^=
{value}
to a number option, or prepend
the {value}
to a string option. When the option is a
comma-separated list, a comma is added, unless the
value was empty.
Also see :set-args above.{option}
-={value} :set-=
{value}
from a number option, or remove
the {value}
from a string option, if it is there.
If the {value}
is not found in a string option, there
is no error or warning. When the option is a comma-
separated list, a comma is deleted, unless the option
becomes empty.
When the option is a list of flags, {value}
must be
exactly as they appear in the option. Remove flags
one by one to avoid problems.
The individual values from a comma separated list or
list of flags can be inserted by typing 'wildchar'.
See complete-set-option.
Also see :set-args above.{option}
arguments to ":set" may be repeated. For example::set ai nosi sw=3 ts=3If you make an error in one of the arguments, an error message will be given and the following arguments will be ignored.
:set-verbose
:verbose set shiftwidth cindent?
option-backslash
:set makeprg=make\ file results in "make file" :let &makeprg='make file' (same as above) :set makeprg=make\\\ file results in "make\ file" :set tags=tags\ /usr/tags results in "tags" and "/usr/tags" :set tags=tags\\\ file results in "tags file" :let &tags='tags\ file' (same as above) :set makeprg=make,file results in "make,file" :set makeprg=make\\,file results in "make\,file" :set tags=tags,file results in "tags" and "file" :set tags=tags\\,file results in "tags,file" :let &tags='tags\,file' (same as above)The "|" character separates a ":set" command from a following command. To include the "|" in the option value, use "\|" instead. This example sets the 'titlestring' option to "hi|there":
:set titlestring=hi\|thereThis sets the 'titlestring' option to "hi" and 'iconstring' to "there":
:set titlestring=hi|set iconstring=thereSimilarly, the double quote character starts a comment. To include the '"' in the option value, use '\"' instead. This example sets the 'titlestring' option to "hi "there"":
:set titlestring=hi\ \"there\"For Win32 backslashes in file names are mostly not removed. More precise: For options that expect a file name (those where environment variables are expanded) a backslash before a normal file name character is not removed. But a backslash before a special character (space, backslash, comma, etc.) is used like explained above. There is one special situation, when the value starts with "\\":
:set dir=\\machine\path results in "\\machine\path" :set dir=\\\\machine\\path results in "\\machine\path" :set dir=\\path\\file results in "\\path\file" (wrong!)For the first one the start is kept, but for the second one the backslashes are halved. This makes sure it works both when you expect backslashes to be halved and when you expect the backslashes to be kept. The third gives a result which is probably not what you want. Avoid it.
add-option-flags
remove-option-flags
E539
:set guioptions+=aRemove a flag from an option like this:
:set guioptions-=aThis removes the 'a' flag from 'guioptions'. Note that you should add or remove one flag at a time. If 'guioptions' has the value "ab", using "set guioptions-=ba" won't work, because the string "ba" doesn't appear.
:set_env
expand-env
expand-environment-var
Environment variables in specific string options will be expanded. If the
environment variable exists the '$' and the following environment variable
name is replaced with its value. If it does not exist the '$' and the name
are not modified. Any non-id character (not a letter, digit or '_') may
follow the environment variable name. That character and what follows is
appended to the value of the environment variable. Examples::set term=$TERM.new :set path=/usr/$INCLUDE,$HOME/include,.When adding or removing a string from an option with ":set opt-=val" or ":set opt+=val" the expansion is done before the adding or removing.
local-options
:e one :set list :e twoNow the 'list' option will also be set in "two", since with the ":set list" command you have also set the global value.
:set nolist :e one :setlocal list :e twoNow the 'list' option is not set, because ":set nolist" resets the global value, ":setlocal list" only changes the local value and ":e two" gets the global value. Note that if you do this next:
:e oneYou will get back the 'list' value as it was the last time you edited "one". The options local to a window are remembered for each buffer. This also happens when the buffer is not loaded, but they are lost when the buffer is wiped out :bwipe.
local-noglobal
:setl
:setlocal
:setl[ocal][!] ... Like ":set" but set only the value local to the
current buffer or window. Not all options have a
local value. If the option does not have a local
value the global value is set.
With the "all" argument: display local values for all
local options.
Without argument: Display local values for all local
options which are different from the default.
When displaying a specific local option, show the
local value. For a global/local boolean option, when
the global value is being used, "--" is displayed
before the option name.
For a global option the global value is
shown (but that might change in the future).{option}
< Set the effective value of {option}
to its global
value.
For string global-local options, the local value is
removed, so that the global value will be used.
For all other options, the global value is copied to
the local value.{option}
< Set the effective value of {option}
to its global
value.
For number and boolean global-local options, the
local value is removed, so that the global value will
be used.
For all other options, including string global-local
options, the global value is copied to the local
value.:setg
:setglobal
:setg[lobal][!] ... Like ":set" but set only the global value for a local
option without changing the local value.
When displaying an option, the global value is shown.
With the "all" argument: display global values for all
local options.
Without argument: display global values for all local
options which are different from the default.global-local
:set makeprg=gmakethen the other window will switch to the same value. There is no need to set the 'makeprg' option in the other C source window too. However, if you start editing a Perl file in a new window, you want to use another 'makeprg' for it, without changing the value used for the C source files. You use this command:
:setlocal makeprg=perlmakeYou can switch back to using the global value by making the local value empty:
:setlocal makeprg=This only works for a string option. For a number or boolean option you need to use the "<" flag, like this:
:setlocal autoread<Note that for non-boolean and non-number options using "<" copies the global value to the local value, it doesn't switch back to using the global value (that matters when the global value changes later). You can also use:
:set path<This will make the local value of 'path' empty, so that the global value is used. Thus it does the same as:
:setlocal path=Note: In the future more global options can be made global-local. Using ":setlocal" on a global option might work differently then.
option-value-function
set opfunc=MyOpFunc set opfunc=function('MyOpFunc') set opfunc=funcref('MyOpFunc') set opfunc={a\ ->\ MyOpFunc(a)}Set to a script-local function:
set opfunc=s:MyLocalFunc set opfunc=<SID>MyLocalFuncSet using a funcref variable:
let Fn = function('MyTagFunc') let &tagfunc = FnSet using a lambda expression:
let &tagfunc = {t -> MyTagFunc(t)}Set using a variable with lambda expression:
let L = {a, b, c -> MyTagFunc(a, b , c)} let &tagfunc = LCalling a function in an expr option
expr-option-function
lua << EOF
function _G.MyFoldFunc()
-- ... compute fold level for line v:lnum
return level
end
EOF
set foldexpr=v:lua.MyFoldFunc()
Setting the filetype{filetype}
:setf
:setfiletype
Set the 'filetype' option to {filetype}
, but only if
not done yet in a sequence of (nested) autocommands.
This is short for::if !did_filetype() : setlocal filetype={filetype} :endif
option-window
optwin
:bro[wse] se[t] :set-browse
:browse-set
:opt
:options
:opt[ions] Open a window for viewing and setting all options.
Options are grouped by function.
Offers short help for each option. Hit <CR>
on the
short help to open a help window with more help for
the option.
Modify the value of the option and hit <CR>
on the
"set" line to set the new value. For window and
buffer specific options, the last accessed window is
used to set the option value in, unless this is a help
window, in which case the window below help window is
used (skipping the option-window).$HOME
:set path=~mool/include,/usr/include,.On Unix systems the form "${HOME}" can be used too. The name between {} can contain non-id characters then. Note that if you want to use this for the "gf" command, you need to add the '{' and '}' characters to 'isfname'.
$HOME-windows
:echo system('set | findstr ^HOME=')and
:echo luaeval('os.getenv("HOME")')should echo nothing (an empty string) despite exists('$HOME') being true. When setting $HOME to a non-empty string it will be exported to the subprocesses.
modeline
vim:
vi:
ex:
E520
There are two forms of modelines. The first form:
[text{white}]{vi:|vim:|ex:}[white]{options}<Space>
or <Tab>
); "ex:" always requires at
least one blank character
{vi:|vim:|ex:}
the string "vi:", "vim:" or "ex:"
[white] optional white space
{options}
a list of option settings, separated with white space
or ':', where each part between ':' is the argument
for a ":set" command (can be empty){options}
:[text]<Space>
or <Tab>
); "ex:" always requires at
least one blank character
{vi:|vim:|Vim:|ex:}
the string "vi:", "vim:", "Vim:" or "ex:"
[white] optional white space
se[t] the string "set " or "se " (note the space); When
"Vim" is used it must be "set".
{options}
a list of options, separated with white space, which
is the argument for a ":set" command
: a colon
[text] any text or empty/* vim: set ai tw=75: */ /* Vim: set ai tw=75: */The white space before
{vi:|vim:|Vim:|ex:}
is required. This minimizes the
chance that a normal word like "lex:" is caught. There is one exception:
"vi:" and "vim:" can also be at the start of the line (for compatibility with
version 3.0). Using "ex:" at the start of the line will be ignored (this
could be short for "example:").modeline-local
modeline-version
{vers}
or later
vim<{vers}: version before {vers}
vim={vers}: version {vers}
vim>{vers}: version after {vers}
{vers}
is 700 for Vim 7.0 (hundred times the major version plus minor).
For example, to use a modeline only for Vim 7.0:/* vim700: set foldmethod=marker */To use a modeline for Vim after version 7.2:
/* vim>702: set cole=2: */There can be no blanks between "vim" and the ":". The modeline is ignored if
{vers}
does not fit in an integer./* vi:ts=4: */will give an error message for the trailing "*/". This line is OK:
/* vi:set ts=4: */If an error is detected the rest of the line is skipped.
/* vi:set fillchars=stl\:^,vert\:\|: */This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash before the ':' is removed. Thus to include "\:" you have to specify "\\:".
E992
au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endifAnd define a function SetVar() that does something with the line containing "VAR".
if exists('&foo')This also returns true for a hidden option. To test if option "foo" is really supported use something like this:
if exists('+foo')
'allowrevins'
'ari'
'noallowrevins'
'noari'
'allowrevins' 'ari' boolean (default off)
global
Allow CTRL-_
in Insert mode. This is default off, to avoid that users
that accidentally type CTRL-_
instead of SHIFT-_ get into reverse
Insert mode, and don't know how to get out. See 'revins'.'ambiwidth'
'ambw'
'ambiwidth' 'ambw' string (default "single")
global
Tells Vim what to do with characters with East Asian Width Class
Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
letters, Cyrillic letters).E834
E835
The value "double" cannot be used if 'listchars' or 'fillchars'
contains a character that would be double width. These errors may
also be given when calling setcellwidths().'arabic'
'arab'
'noarabic'
'noarab'
'arabic' 'arab' boolean (default off)
local to window
This option can be set to start editing Arabic text.
Setting this option will:
CTRL-^
toggles
between typing English and Arabic key mapping.
'arabicshape'
'arshape'
'noarabicshape'
'noarshape'
'arabicshape' 'arshape' boolean (default on)
global
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.'autochdir'
'acd'
'noautochdir'
'noacd'
'autochdir' 'acd' boolean (default off)
global
When on, Vim will change the current working directory whenever you
open a file, switch buffers, delete a buffer or open/close a window.
It will change to the directory containing the file which was opened
or selected. When a buffer has no name it also has no directory, thus
the current directory won't change when navigating to it.
Note: When this option is on some plugins may not work.'autoindent'
'ai'
'noautoindent'
'noai'
'autoindent' 'ai' boolean (default on)
local to buffer
Copy indent from current line when starting a new line (typing <CR>
in Insert mode or when using the "o" or "O" command). If you do not
type anything on the new line except <BS>
or CTRL-D
and then type
<Esc>
, CTRL-O
or <CR>
, the indent is deleted again. Moving the cursor
to another line has the same effect, unless the 'I' flag is included
in 'cpoptions'.
When autoindent is on, formatting (with the "gq" command or when you
reach 'textwidth' in Insert mode) uses the indentation of the first
line.
When 'smartindent' or 'cindent' is on the indent is changed in
a different way.'autoread'
'ar'
'noautoread'
'noar'
'autoread' 'ar' boolean (default on)
global or local to buffer global-local
When a file has been detected to have been changed outside of Vim and
it has not been changed inside of Vim, automatically read it again.
When the file has been deleted this is not done, so you have the text
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<
'autowrite'
'aw'
'noautowrite'
'noaw'
'autowrite' 'aw' boolean (default off)
global
Write the contents of the file, if it has been modified, on each
:next
, :rewind
, :last
, :first
, :previous
, :stop
,
:suspend
, :tag
, :!
, :make
, CTRL-]
and CTRL-^
command; and when
a :buffer
, CTRL-O
, CTRL-I
, '{A-Z0-9}
, or{A-Z0-9} command takes one
to another file.
A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
set to "hide" and :next
is used.
Note that for some commands the 'autowrite' option is not used, see
'autowriteall' for that.
Some buffers will not be written, specifically when 'buftype' is
"nowrite", "nofile", "terminal" or "prompt".
USE WITH CARE: If you make temporary changes to a buffer that you
don't want to be saved this option may cause it to be saved anyway.
Renaming the buffer with ":file {name}
" may help avoid this.'autowriteall'
'awa'
'noautowriteall'
'noawa'
'autowriteall' 'awa' boolean (default off)
global
Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
":qall", ":exit", ":xit", ":recover" and closing the Vim window.
Setting this option also implies that Vim behaves like 'autowrite' has
been set.'background'
'bg'
'background' 'bg' string (default "dark")
global
When set to "dark" or "light", adjusts the default color groups for
that background type. The TUI or other UI sets this on startup
(triggering OptionSet) if it can detect the background color.g:colors_name
if $TERM ==# "xterm"
set background=dark
endif
'backspace'
'bs'
'backspace' 'bs' string (default "indent,eol,start")
global
Influences the working of <BS>
, <Del>
, CTRL-W
and CTRL-U
in Insert
mode. This is a list of items, separated by commas. Each item allows
a way to backspace over something:
CTRL-W
and CTRL-U
stop once at the start of insert.
nostop like start, except CTRL-W
and CTRL-U
do not stop at the start of
insert.'backup'
'bk'
'nobackup'
'nobk'
'backup' 'bk' boolean (default off)
global
Make a backup before overwriting a file. Leave it around after the
file has been successfully written. If you do not want to keep the
backup file, but you do want a backup while the file is being
written, reset this option and set the 'writebackup' option (this is
the default). If you do not want a backup file at all reset both
options (use this if your file system is almost full). See the
backup-table for more explanations.
When the 'backupskip' pattern matches, a backup is not made anyway.
When 'patchmode' is set, the backup may be renamed to become the
oldest version of a file.'backupcopy'
'bkc'
'backupcopy' 'bkc' string (default "auto")
global or local to buffer global-local
When writing a file and a backup is made, this option tells how it's
done. This is a comma-separated list of words.crontab
'backupdir'
'bdir'
'backupdir' 'bdir' string (default ".,$XDG_STATE_HOME/nvim/backup//")
global
List of directories for the backup file, separated with commas.
set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
set backupdir=./.backup,~/.backup,.,/tmp
'backupext'
'bex'
E589
'backupext' 'bex' string (default "~")
global
String which is appended to a file name to make the name of the
backup file. The default is quite unusual, because this avoids
accidentally overwriting existing files with a backup file. You might
prefer using ".bak", but make sure that you don't have files with
".bak" that you want to keep.
Only normal file name characters can be used; /\*?[|<>
are illegal.au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
'backupskip'
'bsk'
'backupskip' 'bsk' string (default "$TMPDIR/*,$TMP/*,$TEMP/*"
Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
global
A list of file patterns. When one of the patterns matches with the
name of the file which is written, no backup file is created. Both
the specified file name and the full path name of the file are used.
The pattern is used like with :autocmd, see autocmd-pattern.
Watch out for special characters, see option-backslash.
When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
default value. "/tmp/*" is only used for Unix.let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
'belloff'
'bo'
'belloff' 'bo' string (default "all")
global
Specifies for which events the bell will not be rung. It is a comma-
separated list of items. For each item that is present, the bell
will be silenced. This is most useful to specify specific events in
insert mode to be silenced.<BS>
or <Del>
and deleting results in an
error.
cursor Fail to move around using the cursor keys or
<PageUp>
/<PageDown> in Insert-mode.
complete Error occurred when using i_CTRL-X_CTRL-K or
i_CTRL-X_CTRL-T.
copy Cannot copy char from insert mode using i_CTRL-Y or
i_CTRL-E.
ctrlg Unknown Char after <C-G>
in Insert mode.
error Other Error occurred (e.g. try to join last line)
(mostly used in Normal-mode or Cmdline-mode).
esc hitting <Esc>
in Normal-mode.
hangul Ignored.
lang Calling the beep module for Lua/Mzscheme/TCL.
mess No output available for g<.
showmatch Error occurred for 'showmatch' function.
operator Empty region error cpo-E.
register Unknown register after <C-R>
in Insert-mode.
shell Bell from shell output :!.
spell Error happened on spell suggest.
wildmode More matches in cmdline-completion available
(depends on the 'wildmode' setting).'binary'
'bin'
'nobinary'
'nobin'
'binary' 'bin' boolean (default off)
local to buffer
This option should be set before editing a binary file. You can also
use the -b Vim argument. When this option is switched on a few
options will be changed (also when it already was on):
'textwidth' will be set to 0
'wrapmargin' will be set to 0
'modeline' will be off
'expandtab' will be off
Also, 'fileformat' and 'fileformats' options will not be used, the
file is read and written like 'fileformat' was "unix" (a single <NL>
separates lines).
The 'fileencoding' and 'fileencodings' options will not be used, the
file is read without conversion.
NOTE: When you start editing a(nother) file while the 'bin' option is
on, settings from autocommands may change the settings again (e.g.,
'textwidth'), causing trouble when editing. You might want to set
'bin' again when the file has been loaded.
The previous values of these options are remembered and restored when
'bin' is switched from on to off. Each buffer has its own set of
saved option values.
To edit a file with 'binary' set you can use the ++bin argument.
This avoids you have to do ":set bin", which would have effect for all
files you edit.
When writing a file the <EOL>
for the last line is only written if
there was one in the original file (normally Vim appends an <EOL>
to
the last line if there is none; this would make the file longer). See
the 'endofline' option.'bomb'
'nobomb'
'bomb' boolean (default off)
local to buffer
When writing a file and the following conditions are met, a BOM (Byte
Order Mark) is prepended to the file:
'breakat'
'brk'
'breakat' 'brk' string (default " ^I!@*-+;:,./?")
global
This option lets you choose which characters might cause a line
break if 'linebreak' is on. Only works for ASCII characters.'breakindent'
'bri'
'nobreakindent'
'nobri'
'breakindent' 'bri' boolean (default off)
local to window
Every wrapped line will continue visually indented (same amount of
space as the beginning of that line), thus preserving horizontal blocks
of text.'breakindentopt'
'briopt'
'breakindentopt' 'briopt' string (default "")
local to window
Settings for 'breakindent'. It can consist of the following optional
items and must be separated by a comma:
min:{n} Minimum text width that will be kept after
applying 'breakindent', even if the resulting
text should normally be narrower. This prevents
text indented almost to the right window border
occupying lots of vertical space when broken.
(default: 20)
shift:{n} After applying 'breakindent', the wrapped line's
beginning will be shifted by the given number of
characters. It permits dynamic French paragraph
indentation (negative) or emphasizing the line
continuation (positive).
(default: 0)
sbr Display the 'showbreak' value before applying the
additional indent.
(default: off)
list:{n} Adds an additional indent for lines that match a
numbered or bulleted list (using the
'formatlistpat' setting).
(default: 0)
list:-1 Uses the width of a match with 'formatlistpat' for
indentation.
column:{n} Indent at column {n}
. Will overrule the other
sub-options. Note: an additional indent may be
added for the 'showbreak' setting.
(default: off)'browsedir'
'bsdir'
'browsedir' 'bsdir' string (default "last")
global
Which directory to use for the file browser:
last Use same directory as with last file browser, where a
file was opened or saved.
buffer Use the directory of the related buffer.
current Use the current directory.
{path}
Use the specified directory'bh'
'bufhidden' 'bh' string (default "")
local to buffer local-noglobal
This option specifies what happens when a buffer is no longer
displayed in a window:
<empty>
follow the global 'hidden' option
hide hide the buffer (don't unload it), even if 'hidden' is
not set
unload unload the buffer, even if 'hidden' is set; the
:hide command will also unload the buffer
delete delete the buffer from the buffer list, even if
'hidden' is set; the :hide command will also delete
the buffer, making it behave like :bdelete
wipe wipe the buffer from the buffer list, even if
'hidden' is set; the :hide command will also wipe
out the buffer, making it behave like :bwipeout'buflisted'
'bl'
'nobuflisted'
'nobl'
E85
'buflisted' 'bl' boolean (default on)
local to buffer
When this option is set, the buffer shows up in the buffer list. If
it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
This option is reset by Vim for buffers that are only used to remember
a file name or marks. Vim sets it when starting to edit a buffer.
But not when moving to a buffer with ":buffer".'buftype'
'bt'
E382
'buftype' 'bt' string (default "")
local to buffer local-noglobal
The value of this option specifies the type of a buffer:
<empty>
normal buffer
acwrite buffer will always be written with BufWriteCmds
help help buffer (do not set this manually)
nofile buffer is not related to a file, will not be written
nowrite buffer will not be written
quickfix list of errors :cwindow or locations :lwindow
terminal terminal-emulator buffer
prompt buffer where only the last line can be edited, meant
to be used by a plugin, see prompt-bufferE676
'casemap'
'cmp'
'casemap' 'cmp' string (default "internal,keepascii")
global
Specifies details about changing the case of letters. It may contain
these words, separated by a comma:
internal Use internal case mapping functions, the current
locale does not change the case mapping. When
"internal" is omitted, the towupper() and towlower()
system library functions are used when available.
keepascii For the ASCII characters (0x00 to 0x7f) use the US
case mapping, the current locale is not effective.
This probably only matters for Turkish.'cdhome'
'cdh'
'nocdhome'
'nocdh'
'cdhome' 'cdh' boolean (default off)
global
When on, :cd, :tcd and :lcd without an argument changes the
current working directory to the $HOME directory like in Unix.
When off, those commands just print the current directory name.
On Unix this option has no effect.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'cdpath'
'cd'
E344
E346
'cdpath' 'cd' string (default equivalent to $CDPATH or ",,")
global
This is a list of directories which will be searched when using the
:cd, :tcd and :lcd commands, provided that the directory being
searched for has a relative path, not an absolute part starting with
"/", "./" or "../", the 'cdpath' option is not used then.
The 'cdpath' option's value has the same form and semantics as
'path'. Also see file-searching.
The default value is taken from $CDPATH, with a "," prepended to look
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')
'cedit'
CTRL-F
)
global
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 key-notation (e.g. <Up>
, <C-F>
) or
a letter preceded with a caret (e.g. ^F
is CTRL-F
). Examples:set cedit=^Y
set cedit=<Esc>
'channel'
'charconvert'
'ccv'
E202
E214
E513
'charconvert' 'ccv' string (default "")
global
An expression that is used for character encoding conversion. It is
evaluated when a file that is to be read or has been written has a
different encoding from what is desired.
'charconvert' is not used when the internal iconv() function is
supported and is able to do the conversion. Using iconv() is
preferred, because it is much faster.
'charconvert' is not used when reading stdin --, because there is no
file to convert from. You will have to save the text in a file first.
The expression must return zero, false or an empty string for success,
non-zero or true for failure.
See encoding-names for possible encoding names.
Additionally, names given in 'fileencodings' and 'fileencoding' are
used.
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:set charconvert=CharConvert()
fun CharConvert()
system("recode "
\ .. v:charconvert_from .. ".." .. v:charconvert_to
\ .. " <" .. v:fname_in .. " >" .. v:fname_out)
return v:shell_error
endfun
set charconvert=s:MyConvert()
set charconvert=<SID>SomeConvert()
'cindent'
'cin'
'nocindent'
'nocin'
'cindent' 'cin' boolean (default off)
local to buffer
Enables automatic C program indenting. See 'cinkeys' to set the keys
that trigger reindenting in insert mode and 'cinoptions' to set your
preferred indent style.
If 'indentexpr' is not empty, it overrules 'cindent'.
If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
the "=" operator indents using this algorithm rather than calling an
external program.
See C-indenting.
When you don't like the way 'cindent' works, try the 'smartindent'
option or 'indentexpr'.'cinkeys'
'cink'
'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
local to buffer
A list of keys that, when typed in Insert mode, cause reindenting of
the current line. Only used if 'cindent' is on and 'indentexpr' is
empty.
For the format of this option see cinkeys-format.
See C-indenting.'cinoptions'
'cino'
'cinoptions' 'cino' string (default "")
local to buffer
The 'cinoptions' affect the way 'cindent' reindents lines in a C
program. See cinoptions-values for the values of this option, and
C-indenting for info on C indenting in general.'cinscopedecls'
'cinsd'
'cinscopedecls' 'cinsd' string (default "public,protected,private")
local to buffer
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
'cinwords'
'cinw'
'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
local to buffer
These keywords start an extra indent in the next line when
'smartindent' or 'cindent' is set. For 'cindent' this is only done at
an appropriate place (inside {}).
Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
matter, include the keyword both the uppercase and lowercase:
"if,If,IF".'clipboard'
'cb'
'clipboard' 'cb' string (default "")
global
This option is a list of comma-separated names.
These names are recognized:clipboard-unnamed
clipboard-unnamedplus
'cmdheight'
'ch'
'cmdheight' 'ch' number (default 1)
global or local to tab page global-local
Number of screen lines to use for the command-line. Helps avoiding
hit-enter prompts.
The value of this option is stored with the tab page, so that each tab
page can have a different value.cmdheight=0
is considered experimental. Expect some
unwanted behaviour. Some 'shortmess' flags and similar
mechanism might fail to take effect, causing unwanted hit-enter
prompts. Some informative messages, both from Nvim itself and
plugins, will not be displayed.'cmdwinheight'
'cwh'
'cmdwinheight' 'cwh' number (default 7)
global
Number of screen lines to use for the command-line window. cmdwin'colorcolumn'
'cc'
'colorcolumn' 'cc' string (default "")
local to window
'colorcolumn' is a comma-separated list of screen columns that are
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'.set cc=+1 " highlight column after 'textwidth'
set cc=+1,+2,+3 " highlight three columns after 'textwidth'
hi ColorColumn ctermbg=lightgrey guibg=lightgrey
'columns'
'co'
E594
'columns' 'co' number (default 80 or terminal width)
global
Number of columns of the screen. Normally this is set by the terminal
initialization and does not have to be set by hand.
When Vim is running in the GUI or in a resizable window, setting this
option will cause the window size to be changed. When you only want
to use the size for the GUI, put the command in your ginit.vim file.
When you set this option and Vim is unable to change the physical
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
'comments'
'com'
E524
E525
'comments' 'com' string (default "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-,fb:•")
local to buffer
A comma-separated list of strings that can start a comment line. See
format-comments. See option-backslash about using backslashes to
insert a space.'commentstring'
'cms'
E537
'commentstring' 'cms' string (default "")
local to buffer
A template for a comment. The "%s" in the value is replaced with the
comment text, and should be padded with a space when possible.
Used for commenting and to add markers for folding, see fold-marker.'complete'
'cpt'
E535
'complete' 'cpt' string (default ".,w,b,u,t")
local to buffer
This option specifies how keyword completion ins-completion works
when CTRL-P
or CTRL-N
are used. It is also used for whole-line
completion i_CTRL-X_CTRL-L. It indicates the type of completion
and the places to scan. It is a comma-separated list of flags:
. scan the current buffer ('wrapscan' is ignored)
w scan buffers from other windows
b scan other loaded buffers that are in the buffer list
u scan the unloaded buffers that are in the buffer list
U scan the buffers that are not in the buffer list
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
{tsr}
. Several "s" flags can be given, patterns
are valid too.
i scan current and included files
d scan current and included files for defined name or macro
i_CTRL-X_CTRL-D
] tag completion
t same as "]"
f scan the buffer names (as opposed to buffer contents)CTRL-N
and CTRL-P
can be used to do any 'iskeyword'-
based expansion (e.g., dictionary i_CTRL-X_CTRL-K, included patterns
i_CTRL-X_CTRL-I, tags i_CTRL-X_CTRL-] and normal expansions).'completefunc'
'cfu'
'completefunc' 'cfu' string (default "")
local to buffer
This option specifies a function to be used for Insert mode completion
with CTRL-X
CTRL-U
. i_CTRL-X_CTRL-U
See complete-functions for an explanation of how the function is
invoked and what it should return. The value can be the name of a
function, a lambda or a Funcref. See option-value-function for
more information.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'completeitemalign'
'cia'
'completeitemalign' 'cia' string (default "abbr,kind,menu")
global
A comma-separated list of complete-items that controls the alignment
and display order of items in the popup menu during Insert mode
completion. The supported values are abbr, kind, and menu. These
options allow to customize how the completion items are shown in the
popup menu. Note: must always contain those three values in any
order.'completeopt'
'cot'
'completeopt' 'cot' string (default "menu,preview")
global or local to buffer global-local
A comma-separated list of options for Insert mode completion
ins-completion. The supported values are:CTRL-L
to add more
characters. Whether case is ignored depends on the kind
of completion. For buffer text the 'ignorecase' option is
used.'completeslash'
'csl'
'completeslash' 'csl' string (default "")
local to buffer
only for MS-Windows
When this option is set it overrules 'shellslash' for completion:
'concealcursor'
'cocu'
'concealcursor' 'cocu' string (default "")
local to window
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''conceallevel'
'cole'
'conceallevel' 'cole' number (default 0)
local to window
Determine how text with the "conceal" syntax attribute :syn-conceal
is shown:'confirm'
'cf'
'noconfirm'
'nocf'
'confirm' 'cf' boolean (default off)
global
When 'confirm' is on, certain operations that would normally
fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
instead raise a dialog asking if you wish to save the current
file(s). You can still use a ! to unconditionally abandon a buffer.
If 'confirm' is off you can still activate confirmation for one
command only (this is most useful in mappings) with the :confirm
command.
Also see the confirm() function and the 'v' flag in 'guioptions'.'copyindent'
'ci'
'nocopyindent'
'noci'
'copyindent' 'ci' boolean (default off)
local to buffer
Copy the structure of the existing lines indent when autoindenting a
new line. Normally the new indent is reconstructed by a series of
tabs followed by spaces as required (unless 'expandtab' is enabled,
in which case only spaces are used). Enabling this option makes the
new line copy whatever characters were used for indenting on the
existing line. 'expandtab' has no effect on these characters, a Tab
remains a Tab. If the new indent is greater than on the existing
line, the remaining space is filled in the normal manner.
See 'preserveindent'.'cpoptions'
'cpo'
cpo
'cpoptions' 'cpo' string (default "aABceFs_")
global
A sequence of single character flags. When a character is present
this indicates Vi-compatible behavior. This is used for things where
not being Vi-compatible is mostly or sometimes preferred.
'cpoptions' stands for "compatible-options".
Commas can be added for readability.
To avoid problems with flags that are added in the future, use the
"+=" and "-=" feature of ":set" add-option-flags.cpo-a
cpo-A
cpo-b
CTRL-V
instead of a backslash to
include the '|' in the mapping. Applies to all
mapping, abbreviation, menu and autocmd commands.
See also map_bar.
cpo-B
CTRL-V
. For example, the command
":map X \<Esc>" results in X being mapped to:
'B' included: "\^[" (^[ is a real <Esc>
)
'B' excluded: "<Esc>" (5 characters)
cpo-c
cpo-C
cpo-d
cpo-D
CTRL-K
to enter a digraph after Normal mode
commands with a character argument, like r, f and
t.
cpo-e
<CR>
to the last line, also when the register is not
linewise. If this flag is not present, the register
is not linewise and the last line does not end in a
<CR>
, then the last line is put on the command-line
and can be edited before hitting <CR>
.
cpo-E
cpo-f
cpo-F
cpo-i
cpo-I
cpo-J
<Tab>
is not recognized as
white space.
cpo-K
<F1>
<F1>
when only part of the second <F1>
has been
read. It enables cancelling the mapping by typing
<F1>
<Esc>
.
cpo-l
<Space>
, '\' and 't'
'l' excluded: "/[ \t]" finds <Space>
and <Tab>
cpo-L
<Tab>
as two characters, instead of
the normal behavior of a <Tab>
.
cpo-m
cpo-M
cpo-n
cpo-o
cpo-O
cpo-P
cpo-q
cpo-r
cpo-R
cpo-s
cpo-S
cpo-t
cpo-u
cpo-v
cpo-W
cpo-x
<Esc>
on the command-line executes the command-line.
The default in Vim is to abandon the command-line,
because <Esc>
normally aborts a command. c_<Esc>
cpo-X
cpo-y
cpo-Z
cpo-!
cpo-$
cpo-%
cpo-+
cpo->
cpo-;
cpo-_
'cursorbind'
'crb'
'nocursorbind'
'nocrb'
'cursorbind' 'crb' boolean (default off)
local to window
When this option is set, as the cursor in the current
window moves other cursorbound windows (windows that also have
this option set) move their cursors to the corresponding line and
column. This option is useful for viewing the
differences between two versions of a file (see 'diff'); in diff mode,
inserted and deleted lines (though not characters within a line) are
taken into account.'cursorcolumn'
'cuc'
'nocursorcolumn'
'nocuc'
'cursorcolumn' 'cuc' boolean (default off)
local to window
Highlight the screen column of the cursor with CursorColumn
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:au WinLeave * set nocursorline nocursorcolumn
au WinEnter * set cursorline cursorcolumn
'cursorline'
'cul'
'nocursorline'
'nocul'
'cursorline' 'cul' boolean (default off)
local to window
Highlight the text line of the cursor with CursorLine hl-CursorLine.
Useful to easily spot the cursor. Will make screen redrawing slower.
When Visual mode is active the highlighting isn't used to make it
easier to see the selected text.'cursorlineopt'
'culopt'
'cursorlineopt' 'culopt' string (default "both")
local to window
Comma-separated list of settings for how 'cursorline' is displayed.
Valid values:
"line" Highlight the text line of the cursor with
CursorLine hl-CursorLine.
"screenline" Highlight only the screen line of the cursor with
CursorLine hl-CursorLine.
"number" Highlight the line number of the cursor with
CursorLineNr hl-CursorLineNr.'debug'
'define'
'def'
'define' 'def' string (default "")
global or local to buffer global-local
Pattern to be used to find a macro definition. It is a search
pattern, just like for the "/" command. This option is used for the
commands like "[i" and "[d" include-search. The 'isident' option is
used to recognize the defined name after the match:{match with 'define'}{non-ID chars}{defined name}{non-ID char}
^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
func_name = function(args)
:^\s*\ze\i\+\s*=\s*function(
func_name : function() {...
:^\s*\ze\i\+\s*[:]\s*(*function\s*(
:let
with a single quote string:let &l:define = '^\s*\ze\k\+\s*=\s*function('
'delcombine'
'deco'
'nodelcombine'
'nodeco'
'delcombine' 'deco' boolean (default off)
global
If editing Unicode and this option is set, backspace and Normal mode
"x" delete each combining character on its own. When it is off (the
default) the character along with its combining characters are
deleted.
Note: When 'delcombine' is set "xx" may work differently from "2x"!'dictionary'
'dict'
'dictionary' 'dict' string (default "")
global or local to buffer global-local
List of file names, separated by commas, that are used to lookup words
for keyword completion commands i_CTRL-X_CTRL-K. Each file should
contain a list of words. This can be one word per line, or several
words per line, separated by non-keyword characters (white space is
preferred). Maximum line length is 510 bytes.'diff'
'nodiff'
'diff' boolean (default off)
local to window
Join the current window in the group of windows that shows differences
between files. See diff-mode.'diffexpr'
'dex'
'diffexpr' 'dex' string (default "")
global
Expression which is evaluated to obtain a diff file (either ed-style
or unified-style) from two versions of a file. See diff-diffexpr.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'diffopt'
'dip'
'diffopt' 'dip' string (default "internal,filler,closeoff")
global
Option settings for diff mode. It can consist of the following items.
All are optional. Items must be separated by a comma.{n}
lines between a change
and a fold that contains unchanged lines.
When omitted a context of six lines is used.
When using zero the context is actually one,
since folds require a line in between, also
for a deleted line. Set it to a very large
value (999999) to disable folding completely.
See fold-diff.:diffoff
in that window. This undoes a
:diffsplit
command.{n}
when
starting diff mode. Without this 2 is used.E960
When running out of memory when writing a
buffer this item will be ignored for diffs
involving that buffer. Set the 'verbose'
option to see when this happens.{n}
, the
second stage diff will not be performed as
very large hunks can cause noticeable lag. A
recommended setting is "linematch:60", as this
will enable alignment for a 2 buffer diff with
hunks of up to 30 lines each, or a 3 buffer
diff with hunks of up to 20 lines each.set diffopt=internal,filler,context:4
set diffopt=
set diffopt=internal,filler,foldcolumn:3
set diffopt-=internal " do NOT use the internal diff parser
'digraph'
'dg'
'nodigraph'
'nodg'
'digraph' 'dg' boolean (default off)
global
Enable the entering of digraphs in Insert mode with {char1}
<BS>
{char2}
. See digraphs.'directory'
'dir'
'directory' 'dir' string (default "$XDG_STATE_HOME/nvim/swap//")
global
List of directory names for the swap file, separated with commas.set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
'display'
'dy'
'display' 'dy' string (default "lastline")
global
Change the way text is displayed. This is a comma-separated list of
flags:
lastline When included, as much as possible of the last line
in a window will be displayed. "@@@" is put in the
last columns of the last screen line to indicate the
rest of the line is not displayed.
truncate Like "lastline", but "@@@" is displayed in the first
column of the last screen line. Overrules "lastline".
uhex Show unprintable characters hexadecimal as <xx>
instead of using ^C and ~C.
msgsep Obsolete flag. Allowed but takes no effect. msgsep'eadirection'
'ead'
'eadirection' 'ead' string (default "both")
global
Tells when the 'equalalways' option applies:
ver vertically, width of windows is not affected
hor horizontally, height of windows is not affected
both width and height of windows is affected'emoji'
'emo'
'noemoji'
'noemo'
'emoji' 'emo' boolean (default on)
global
When on all Unicode emoji characters are considered to be full width.
This excludes "text emoji" characters, which are normally displayed as
single width. However, such "text emoji" are treated as full-width
emoji if they are followed by the U+FE0F variant selector.'encoding'
'enc'
'encoding' 'enc' string (default "utf-8")
global
String-encoding used internally and for RPC communication.
Always UTF-8.'endoffile'
'eof'
'noendoffile'
'noeof'
'endoffile' 'eof' boolean (default off)
local to buffer
Indicates that a CTRL-Z
character was found at the end of the file
when reading it. Normally only happens when 'fileformat' is "dos".
When writing a file and this option is off and the 'binary' option
is on, or 'fixeol' option is off, no CTRL-Z
will be written at the
end of the file.
See eol-and-eof for example settings.'endofline'
'eol'
'noendofline'
'noeol'
'endofline' 'eol' boolean (default on)
local to buffer
When writing a file and this option is off and the 'binary' option
is on, or 'fixeol' option is off, no <EOL>
will be written for the
last line in the file. This option is automatically set or reset when
starting to edit a new file, depending on whether file has an <EOL>
for the last line in the file. Normally you don't have to set or
reset this option.
When 'binary' is off and 'fixeol' is on the value is not used when
writing the file. When 'binary' is on or 'fixeol' is off it is used
to remember the presence of a <EOL>
for the last line in the file, so
that when you write the file the situation from the original file can
be kept. But you can change it if you want to.
See eol-and-eof for example settings.'equalalways'
'ea'
'noequalalways'
'noea'
'equalalways' 'ea' boolean (default on)
global
When on, all the windows are automatically made the same size after
splitting or closing a window. This also happens the moment the
option is switched on. When off, splitting a window will reduce the
size of the current window and leave the other windows the same. When
closing a window the extra lines are given to the window next to it
(depending on 'splitbelow' and 'splitright').
When mixing vertically and horizontally split windows, a minimal size
is computed and some windows may be larger if there is room. The
'eadirection' option tells in which direction the size is affected.
Changing the height and width of a window can be avoided by setting
'winfixheight' and 'winfixwidth', respectively.
If a window size is specified when creating a new window sizes are
currently not equalized (it's complicated, but may be implemented in
the future).'equalprg'
'ep'
'equalprg' 'ep' string (default "")
global or local to buffer global-local
External program to use for "=" command. When this option is empty
the internal formatting functions are used; either 'lisp', 'cindent'
or 'indentexpr'.
Environment variables are expanded :set_env. See option-backslash
about including spaces and backslashes.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'errorbells'
'eb'
'noerrorbells'
'noeb'
'errorbells' 'eb' boolean (default off)
global
Ring the bell (beep or screen flash) for error messages. This only
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
mode). See 'visualbell' to make the bell behave like a screen flash
or do nothing. See 'belloff' to finetune when to ring the bell.'errorfile'
'ef'
'errorfile' 'ef' string (default "errors.err")
global
Name of the errorfile for the QuickFix mode (see :cf).
When the "-q" command-line argument is used, 'errorfile' is set to the
following argument. See -q.
NOT used for the ":make" command. See 'makeef' for that.
Environment variables are expanded :set_env.
See option-backslash about including spaces and backslashes.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'errorformat'
'efm'
'errorformat' 'efm' string (default is very long)
global or local to buffer global-local
Scanf-like description of the format for the lines in the error file
(see errorformat).'eventignore'
'ei'
'eventignore' 'ei' string (default "")
global
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
'expandtab'
'et'
'noexpandtab'
'noet'
'expandtab' 'et' boolean (default off)
local to buffer
In Insert mode: Use the appropriate number of spaces to insert a
<Tab>
. Spaces are used in indents with the '>' and '<' commands and
when 'autoindent' is on. To insert a real tab when 'expandtab' is
on, use CTRL-V
<Tab>
. See also :retab and ins-expandtab.'exrc'
'ex'
'noexrc'
'noex'
'exrc' 'ex' boolean (default off)
global
Automatically execute .nvim.lua, .nvimrc, and .exrc files in the
current directory, if the file is in the trust list. Use :trust to
manage trusted files. See also vim.secure.read().'fileencoding'
'fenc'
E213
'fileencoding' 'fenc' string (default "")
local to buffer
File-content encoding for the current buffer. Conversion is done with
iconv() or as specified with 'charconvert'.'fileencodings'
'fencs'
'fileencodings' 'fencs' string (default "ucs-bom,utf-8,default,latin1")
global
This is a list of character encodings considered when starting to edit
an existing file. When a file is read, Vim tries to use the first
mentioned character encoding. If an error is detected, the next one
in the list is tried. When an encoding is found that works,
'fileencoding' is set to it. If all fail, 'fileencoding' is set to
an empty string, which means that UTF-8 is used.
WARNING: Conversion can cause loss of information! You can use
the ++bad argument to specify what is done with characters
that can't be converted.
For an empty file or a file with only ASCII characters most encodings
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:au BufReadPost * if search('\S', 'w') == 0 |
\ set fenc=iso-2022-jp | endif
setglobal fenc=iso-8859-2
'fileformat'
'ff'
'fileformat' 'ff' string (default Windows: "dos", Unix: "unix")
local to buffer
This gives the <EOL>
of the current buffer, which is used for
reading/writing the buffer from/to a file:
dos <CR>
<NL>
unix <NL>
mac <CR>
When "dos" is used, CTRL-Z
at the end of a file is ignored.
See file-formats and file-read.
For the character encoding of the file see 'fileencoding'.
When 'binary' is set, the value of 'fileformat' is ignored, file I/O
works like it was set to "unix".
This option is set automatically when starting to edit a file and
'fileformats' is not empty and 'binary' is off.
When this option is set, after starting to edit a file, the 'modified'
option is set, because the file would be different when written.
This option cannot be changed when 'modifiable' is off.'fileformats'
'ffs'
'fileformats' 'ffs' string (default Windows: "dos,unix", Unix: "unix,dos")
global
This gives the end-of-line (<EOL>
) formats that will be tried when
starting to edit a new buffer and when reading a file into an existing
buffer:
<EOL>
detection will be done when reading a file. When starting to
edit a file, a check is done for the <EOL>
:
1. If all lines end in <CR>
<NL>
, and 'fileformats' includes "dos",
'fileformat' is set to "dos".
2. If a <NL>
is found and 'fileformats' includes "unix", 'fileformat'
is set to "unix". Note that when a <NL>
is found without a
preceding <CR>
, "unix" is preferred over "dos".
3. If 'fileformat' has not yet been set, and if a <CR>
is found, and
if 'fileformats' includes "mac", 'fileformat' is set to "mac".
This means that "mac" is only chosen when:
"unix" is not present or no <NL>
is found in the file, and
"dos" is not present or no <CR>
<NL>
is found in the file.
Except: if "unix" was chosen, but there is a <CR>
before
the first <NL>
, and there appear to be more <CR>
s than <NL>
s in
the first few lines, "mac" is used.
4. If 'fileformat' is still not set, the first name from
'fileformats' is used.
When reading a file into an existing buffer, the same is done, but
this happens like 'fileformat' has been set appropriately for that
file only, the option is not changed.
When 'binary' is set, the value of 'fileformats' is not used.
<EOL>
(<CR>
<NL>
), when reading files that
are ":source"ed and for vimrc files, automatic <EOL>
detection may be
done:
<NL>
in the file: If there is a
<CR>
in front of it, Dos format is used, otherwise Unix format is
used.
Also see file-formats.
'fileignorecase'
'fic'
'nofileignorecase'
'nofic'
'fileignorecase' 'fic' boolean (default on for systems where case in file
names is normally ignored)
global
When set case is ignored when using file names and directories.
See 'wildignorecase' for only ignoring case when doing completion.'filetype'
'ft'
'filetype' 'ft' string (default "")
local to buffer local-noglobal
When this option is set, the FileType autocommand event is triggered.
All autocommands that match with the value of this option will be
executed. Thus the value of 'filetype' is used in place of the file
name.
Otherwise this option does not always reflect the current file type.
This option is normally set when the file type is detected. To enable
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:/* vim: set filetype=idl : */
/* vim: set filetype=c.doxygen : */
'fillchars'
'fcs'
'fillchars' 'fcs' string (default "")
global or local to window global-local
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: E1511set fillchars=stl:\ ,stlnc:\ ,vert:│,fold:·,diff:-
'fixendofline'
'fixeol'
'nofixendofline'
'nofixeol'
'fixendofline' 'fixeol' boolean (default on)
local to buffer
When writing a file and this option is on, <EOL>
at the end of file
will be restored if missing. Turn this option off if you want to
preserve the situation from the original file.
When the 'binary' option is set the value of this option doesn't
matter.
See the 'endofline' option.
See eol-and-eof for example settings.'foldclose'
'fcl'
'foldclose' 'fcl' string (default "")
global
When set to "all", a fold is closed when the cursor isn't in it and
its level is higher than 'foldlevel'. Useful if you want folds to
automatically close when moving out of them.'foldcolumn'
'fdc'
'foldcolumn' 'fdc' string (default "0")
local to window
When and how to draw the foldcolumn. Valid values are:
"auto": resize to the minimum amount of folds to display.
"auto:[1-9]": resize to accommodate multiple folds up to the
selected level
"0": to disable foldcolumn
"[1-9]": to display a fixed number of columns
See folding.'foldenable'
'fen'
'nofoldenable'
'nofen'
'foldenable' 'fen' boolean (default on)
local to window
When off, all folds are open. This option can be used to quickly
switch between showing all text unfolded and viewing the text with
folds (including manually opened or closed folds). It can be toggled
with the zi command. The 'foldcolumn' will remain blank when
'foldenable' is off.
This option is set by commands that create a new fold or close a fold.
See folding.'foldexpr'
'fde'
'foldexpr' 'fde' string (default "0")
local to window
The expression used for when 'foldmethod' is "expr". It is evaluated
for each line to obtain its fold level. The context is set to the
script where 'foldexpr' was set, script-local items can be accessed.
See fold-expr for the usage.'foldignore'
'fdi'
'foldignore' 'fdi' string (default "#")
local to window
Used only when 'foldmethod' is "indent". Lines starting with
characters in 'foldignore' will get their fold level from surrounding
lines. White space is skipped before checking for this character.
The default "#" works well for C programs. See fold-indent.'foldlevel'
'fdl'
'foldlevel' 'fdl' number (default 0)
local to window
Sets the fold level: Folds with a higher level will be closed.
Setting this option to zero will close all folds. Higher numbers will
close fewer folds.
This option is set by commands like zm, zM and zR.
See fold-foldlevel.'foldlevelstart'
'fdls'
'foldlevelstart' 'fdls' number (default -1)
global
Sets 'foldlevel' when starting to edit another buffer in a window.
Useful to always start editing with all folds closed (value zero),
some folds closed (one) or no folds closed (99).
This is done before reading any modeline, thus a setting in a modeline
overrules this option. Starting to edit a file for diff-mode also
ignores this option and closes all folds.
It is also done before BufReadPre autocommands, to allow an autocmd to
overrule the 'foldlevel' value for specific files.
When the value is negative, it is not used.'foldmarker'
'fmr'
E536
'foldmarker' 'fmr' string (default "{{{,}}}")
local to window
The start and end marker used when 'foldmethod' is "marker". There
must be one comma, which separates the start and end marker. The
marker is a literal string (a regular expression would be too slow).
See fold-marker.'foldmethod'
'fdm'
'foldmethod' 'fdm' string (default "manual")
local to window
The kind of folding used for the current window. Possible values:
fold-manual manual Folds are created manually.
fold-indent indent Lines with equal indent form a fold.
fold-expr expr 'foldexpr' gives the fold level of a line.
fold-marker marker Markers are used to specify folds.
fold-syntax syntax Syntax highlighting items specify folds.
fold-diff diff Fold text that is not changed.'foldminlines'
'fml'
'foldminlines' 'fml' number (default 1)
local to window
Sets the number of screen lines above which a fold can be displayed
closed. Also for manually closed folds. With the default value of
one a fold can only be closed if it takes up two or more screen lines.
Set to zero to be able to close folds of just one screen line.
Note that this only has an effect on what is displayed. After using
"zc" to close a fold, which is displayed open because it's smaller
than 'foldminlines', a following "zc" may close a containing fold.'foldnestmax'
'fdn'
'foldnestmax' 'fdn' number (default 20)
local to window
Sets the maximum nesting of folds for the "indent" and "syntax"
methods. This avoids that too many folds will be created. Using more
than 20 doesn't work, because the internal limit is 20.'foldopen'
'fdo'
'foldopen' 'fdo' string (default "block,hor,mark,percent,quickfix,search,tag,undo")
global
Specifies for which type of commands folds will be opened, if the
command moves the cursor into a closed fold. It is a comma-separated
list of items.
NOTE: When the command is part of a mapping this option is not used.
Add the zv command to the mapping to get the same effect.
(rationale: the mapping may want to control opening folds itself)CTRL-O
, etc.
percent "%"
quickfix ":cn", ":crew", ":make", etc.
search search for a pattern: "/", "n", "*", "gd", etc.
(not for a search pattern in a ":" command)
Also for [s and ]s.
tag jumping to a tag: ":ta", CTRL-T
, etc.
undo undo or redo: "u" and CTRL-R
When a movement command is used for an operator (e.g., "dl" or "y%")
this option is not used. This means the operator will include the
whole closed fold.
Note that vertical movements are not here, because it would make it
very difficult to move onto a closed fold.
In insert mode the folds containing the cursor will always be open
when text is inserted.
To close folds you can re-apply 'foldlevel' with the zx command or
set the 'foldclose' option to "all".'foldtext'
'fdt'
'foldtext' 'fdt' string (default "foldtext()")
local to window
An expression which is used to specify the text displayed for a closed
fold. The context is set to the script where 'foldexpr' was set,
script-local items can be accessed. See fold-foldtext for the
usage.'formatexpr'
'fex'
'formatexpr' 'fex' string (default "")
local to buffer
Expression which is evaluated to format a range of lines for the gq
operator or automatic formatting (see 'formatoptions'). When this
option is empty 'formatprg' is used.set formatexpr=mylang#Format()
set formatexpr=s:MyFormatExpr()
set formatexpr=<SID>SomeFormatExpr()
'formatlistpat'
'flp'
'formatlistpat' 'flp' string (default "^\s*\d\+[\]:.)}\t ]\s*")
local to buffer
A pattern that is used to recognize a list header. This is used for
the "n" flag in 'formatoptions'.
The pattern must match exactly the text that will be the indent for
the line below it. You can use /\ze to mark the end of the match
while still checking more characters. There must be a character
following the pattern, when it matches the whole line it is handled
like there is no match.
The default recognizes a number, followed by an optional punctuation
character and white space.'formatoptions'
'fo'
'formatoptions' 'fo' string (default "tcqj")
local to buffer
This is a sequence of letters which describes how automatic
formatting is to be done.
See fo-table for possible values and gq for how to format text.
Commas can be inserted for readability.
To avoid problems with flags that are added in the future, use the
"+=" and "-=" feature of ":set" add-option-flags.'formatprg'
'fp'
'formatprg' 'fp' string (default "")
global or local to buffer global-local
The name of an external program that will be used to format the lines
selected with the gq operator. The program must take the input on
stdin and produce the output on stdout. The Unix program "fmt" is
such a program.
If the 'formatexpr' option is not empty it will be used instead.
Otherwise, if 'formatprg' option is an empty string, the internal
format function will be used C-indenting.
Environment variables are expanded :set_env. See option-backslash
about including spaces and backslashes.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'fsync'
'fs'
'nofsync'
'nofs'
'fsync' 'fs' boolean (default on)
global
When on, the OS function fsync() will be called after saving a file
(:write, writefile(), …), swap-file, undo-persistence and shada-file.
This flushes the file to disk, ensuring that it is safely written.
Slow on some systems: writing buffers, quitting Nvim, and other
operations may sometimes take a few seconds.'gdefault'
'gd'
'nogdefault'
'nogd'
'gdefault' 'gd' boolean (default off)
global
When on, the ":substitute" flag 'g' is default on. This means that
all matches in a line are substituted instead of one. When a 'g' flag
is given to a ":substitute" command, this will toggle the substitution
of all or one match. See complex-change.'grepformat'
'gfm'
'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
global
Format to recognize for the ":grep" command output.
This is a scanf-like string that uses the same format as the
'errorformat' option: see errorformat.%f:%l:%c:%m
.'grepprg'
'gp'
'grepprg' 'gp' string (default see below)
global or local to buffer global-local
Program to use for the :grep command. This option may contain '%'
and '#' characters, which are expanded like when used in a command-
line. The placeholder "$*" is allowed to specify where the arguments
will be included. Environment variables are expanded :set_env. See
option-backslash about including spaces and backslashes.
Special value: When 'grepprg' is set to "internal" the :grep command
works like :vimgrep, :lgrep like :lvimgrep, :grepadd like
:vimgrepadd and :lgrepadd like :lvimgrepadd.
See also the section :make_makeprg, since most of the comments there
apply equally to 'grepprg'.
This option cannot be set from a modeline or in the sandbox, for
security reasons.
This option defaults to:
rg --vimgrep -uu
if ripgrep is available (:checkhealth),
grep -HIn $* /dev/null
on Unix,
findstr /n $* nul
on Windows.
Ripgrep can perform additional filtering such as using .gitignore rules
and skipping hidden files. This is disabled by default (see the -u option)
to more closely match the behaviour of standard grep.
You can make ripgrep match Vim's case handling using the
-i/--ignore-case and -S/--smart-case options.
An OptionSet autocmd can be used to set it up to match automatically.
'guicursor'
'gcr'
E545
E546
E548
E549
'guicursor' 'gcr' string (default "n-v-c-sm:block,i-ci-ve:ver25,r-cr-o:hor20")
global
Configures the cursor style for each mode. Works in the GUI and many
terminals. See tui-cursor-shape.set guicursor=
set guicursor=n-v-c:block,i-ci-ve:ver25,r-cr:hor20,o:hor50
\,a:blinkwait700-blinkoff400-blinkon250-Cursor/lCursor
\,sm:block-blinkwait175-blinkoff150-blinkon175
{N}
percent of the character height
ver{N} vertical bar, {N}
percent of the character width
block block cursor, fills the whole character
cursor-blinking
set guicursor=n:blinkon0
{group-name}
Highlight group that decides the color and font of the
cursor.
In the TUI:
{group-name}
/{group-name}
Two highlight group names, the first is used when
no language mappings are used, the other when they
are. language-mapping
highlight Cursor gui=reverse guifg=NONE guibg=NONE
highlight Cursor gui=NONE guifg=bg guibg=fg
'guifont'
'gfn'
E235
E596
'guifont' 'gfn' string (default "")
global
This is a list of fonts which will be used for the GUI version of Vim.
In its simplest form the value is just one font name. When
the font cannot be found you will get an error message. To try other
font names a list can be specified, font names separated with commas.
The first valid font is used.set guifont=Screen15,\ 7x13,font\\,with\\,commas
set guifont=*
set guifont=Monaco:h10
E236
E244
E245
set guifont=courier_new:h12:w5:b:cRUSSIAN
set guifont=Andale_Mono:h7.5:w4.5
'guifontwide'
'gfw'
E231
E533
E534
'guifontwide' 'gfw' string (default "")
global
Comma-separated list of fonts to be used for double-width characters.
The first font that can be loaded is used.
Note: The size of these fonts must be exactly twice as wide as the one
specified with 'guifont' and the same height.'guioptions'
'go'
'guioptions' 'go' string (default "egmrLT" (MS-Windows))
global
This option only has an effect in the GUI version of Vim. It is a
sequence of letters which describes what components and options of the
GUI should be used.
To avoid problems with flags that are added in the future, use the
"+=" and "-=" feature of ":set" add-option-flags.guioptions_a
'go-a'
'a' Autoselect: If present, then whenever VISUAL mode is started,
or the Visual area extended, Vim tries to become the owner of
the windowing system's global selection. This means that the
Visually highlighted text is available for pasting into other
applications as well as into Vim itself. When the Visual mode
ends, possibly due to an operation on the text, or when an
application wants to paste the selection, the highlighted text
is automatically yanked into the "* selection register.
Thus the selection is still available for pasting into other
applications after the VISUAL mode has ended.
If not present, then Vim won't become the owner of the
windowing system's global selection unless explicitly told to
by a yank or delete operation for the "* register.
The same applies to the modeless selection.
'go-P'
'go-A'
'go-c'
'go-d'
'go-e'
'go-i'
'go-m'
'go-M'
:syntax on
and :filetype on
commands load the menu too).
'go-g'
'go-T'
'go-r'
'go-R'
'go-l'
'go-L'
'go-b'
'go-h'
'go-v'
'go-p'
'go-k'
'guitablabel'
'gtl'
'guitablabel' 'gtl' string (default "")
global
When non-empty describes the text to use in a label of the GUI tab
pages line. When empty and when the result is empty Vim will use a
default label. See setting-guitablabel for more info.'guitabtooltip'
'gtt'
'guitabtooltip' 'gtt' string (default "")
global
When non-empty describes the text to use in a tooltip for the GUI tab
pages line. When empty Vim will use a default tooltip.
This option is otherwise just like 'guitablabel' above.
You can include a line break. Simplest method is to use :let:let &guitabtooltip = "line one\nline two"
'helpfile'
'hf'
'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
(others) "$VIMRUNTIME/doc/help.txt")
global
Name of the main help file. All distributed help files should be
placed together in one directory. Additionally, all "doc" directories
in 'runtimepath' will be used.
Environment variables are expanded :set_env. For example:
"$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
tried. Also see $VIMRUNTIME and option-backslash about including
spaces and backslashes.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'helpheight'
'hh'
'helpheight' 'hh' number (default 20)
global
Minimal initial height of the help window when it is opened with the
":help" command. The initial height of the help window is half of the
current window, or (when the 'ea' option is on) the same as other
windows. When the height is less than 'helpheight', the height is
set to 'helpheight'. Set to zero to disable.'helplang'
'hlg'
'helplang' 'hlg' string (default messages language or empty)
global
Comma-separated list of languages. Vim will use the first language
for which the desired help can be found. The English help will always
be used as a last resort. You can add "en" to prefer English over
another language, but that will only find tags that exist in that
language and not in the English help.
Example:set helplang=de,it
'hid'
'nohid'
'hidden' 'hid' boolean (default on)
global
When off a buffer is unloaded (including loss of undo information)
when it is abandoned. When on a buffer becomes hidden when it is
abandoned. A buffer displayed in another window does not become
hidden, of course.{command}
" :hide.'history'
'hi'
'history' 'hi' number (default 10000)
global
A history of ":" commands, and a history of previous search patterns
is remembered. This option decides how many entries may be stored in
each of these histories (see cmdline-editing).
The maximum value is 10000.'hlsearch'
'hls'
'nohlsearch'
'nohls'
'hlsearch' 'hls' boolean (default on)
global
When there is a previous search pattern, highlight all its matches.
The hl-Search highlight group determines the highlighting for all
matches not under the cursor while the hl-CurSearch highlight group
(if defined) determines the highlighting for the match under the
cursor. If hl-CurSearch is not defined, then hl-Search is used for
both. Note that only the matching text is highlighted, any offsets
are not applied.
See also: 'incsearch' and :match.
When you get bored looking at the highlighted matches, you can turn it
off with :nohlsearch. This does not change the option value, as
soon as you use a search command, the highlighting comes back.
'redrawtime' specifies the maximum time spent on finding matches.
When the search pattern can match an end-of-line, Vim will try to
highlight all of the matched text. However, this depends on where the
search starts. This will be the first line in the window or the first
line below a closed fold. A match in a previous line which is not
drawn may not continue in a newly drawn line.
You can specify whether the highlight status is restored on startup
with the 'h' flag in 'shada' shada-h.'icon'
'noicon'
'icon' boolean (default off, on when title can be restored)
global
When on, the icon text of the window will be set to the value of
'iconstring' (if it is not empty), or to the name of the file
currently being edited. Only the last part of the name is used.
Overridden by the 'iconstring' option.
Only works if the terminal supports setting window icons.'iconstring'
'ignorecase'
'ic'
'noignorecase'
'noic'
'ignorecase' 'ic' boolean (default off)
global
Ignore case in search patterns, cmdline-completion, when
searching in the tags file, and expr-==.
Also see 'smartcase' and 'tagcase'.
Can be overruled by using "\c" or "\C" in the pattern, see
/ignorecase.'imcmdline'
'imc'
'noimcmdline'
'noimc'
'imcmdline' 'imc' boolean (default off)
global
When set the Input Method is always on when starting to edit a command
line, unless entering a search pattern (see 'imsearch' for that).
Setting this option is useful when your input method allows entering
English characters directly, e.g., when it's used to type accented
characters with dead keys.'imdisable'
'imd'
'noimdisable'
'noimd'
'imdisable' 'imd' boolean (default off, on for some systems (SGI))
global
When set the Input Method is never used. This is useful to disable
the IM when it doesn't work properly.
Currently this option is on by default for SGI/IRIX machines. This
may change in later releases.'iminsert'
'imi'
'iminsert' 'imi' number (default 0)
local to buffer
Specifies whether :lmap or an Input Method (IM) is to be used in
Insert mode. Valid values:
0 :lmap is off and IM is off
1 :lmap is ON and IM is off
2 :lmap is off and IM is ON
To always reset the option to zero when leaving Insert mode with <Esc>
this can be used:inoremap <ESC> <ESC>:set iminsert=0<CR>
CTRL-^
in Insert mode
i_CTRL-^.
The value is set to 1 when setting 'keymap' to a valid keymap name.
It is also used for the argument of commands like "r" and "f".'imsearch'
'ims'
'imsearch' 'ims' number (default -1)
local to buffer
Specifies whether :lmap or an Input Method (IM) is to be used when
entering a search pattern. Valid values:
-1 the value of 'iminsert' is used, makes it look like
'iminsert' is also used when typing a search pattern
0 :lmap is off and IM is off
1 :lmap is ON and IM is off
2 :lmap is off and IM is ON
Note that this option changes when using CTRL-^
in Command-line mode
c_CTRL-^.
The value is set to 1 when it is not -1 and setting the 'keymap'
option to a valid keymap name.'inccommand'
'icm'
'inccommand' 'icm' string (default "nosplit")
global
When nonempty, shows the effects of :substitute, :smagic,
:snomagic and user commands with the :command-preview flag as you
type.'include'
'inc'
'include' 'inc' string (default "")
global or local to buffer global-local
Pattern to be used to find an include command. It is a search
pattern, just like for the "/" command (See pattern). This option
is used for the commands "[i", "]I", "[d", etc.
Normally the 'isfname' option is used to recognize the file name that
comes after the matched pattern. But if "\zs" appears in the pattern
then the text matched from "\zs" to the end, or until "\ze" if it
appears, is used as the file name. Use this to include characters
that are not in 'isfname', such as a space. You can then use
'includeexpr' to process the matched text.
See option-backslash about including spaces and backslashes.'includeexpr'
'inex'
'includeexpr' 'inex' string (default "")
local to buffer
Expression to be used to transform the string found with the 'include'
option to a file name. Mostly useful to change "." to "/" for Java:setlocal includeexpr=substitute(v:fname,'\\.','/','g')
:set
command first halves them, then
one remains in the value, where "\." matches a dot literally. For
simple character replacements tr()
avoids the need for escaping:setlocal includeexpr=tr(v:fname,'.','/')
setlocal includeexpr=s:MyIncludeExpr()
setlocal includeexpr=<SID>SomeIncludeExpr()
'incsearch'
'is'
'noincsearch'
'nois'
'incsearch' 'is' boolean (default on)
global
While typing a search command, show where the pattern, as it was typed
so far, matches. The matched string is highlighted. If the pattern
is invalid or not found, nothing is shown. The screen will be updated
often, this is only useful on fast terminals.
Note that the match will be shown, but the cursor will return to its
original position when no match is found and when pressing <Esc>
. You
still need to finish the search command with <Enter>
to move the
cursor to the match.
You can use the CTRL-G
and CTRL-T
keys to move to the next and
previous match. c_CTRL-G c_CTRL-T
Vim only searches for about half a second. With a complicated
pattern and/or a lot of text the match may not be found. This is to
avoid that Vim hangs while you are typing the pattern.
The hl-IncSearch highlight group determines the highlighting.
When 'hlsearch' is on, all matched strings are highlighted too while
typing a search command. See also: 'hlsearch'.
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
autocmd. Example:augroup vimrc-incsearch-highlight
autocmd!
autocmd CmdlineEnter /,\? :set hlsearch
autocmd CmdlineLeave /,\? :set nohlsearch
augroup END
CTRL-L
can be used to add one character from after the current match
to the command line. If 'ignorecase' and 'smartcase' are set and the
command line has no uppercase characters, the added character is
converted to lowercase.
CTRL-R
CTRL-W
can be used to add the word at the end of the current
match, excluding the characters that were already typed.'indentexpr'
'inde'
'indentexpr' 'inde' string (default "")
local to buffer
Expression which is evaluated to obtain the proper indent for a line.
It is used when a new line is created, for the = operator and
in Insert mode as specified with the 'indentkeys' option.
When this option is not empty, it overrules the 'cindent' and
'smartindent' indenting. When 'lisp' is set, this option is
only used when 'lispoptions' contains "expr:1".
The expression is evaluated with v:lnum set to the line number for
which the indent is to be computed. The cursor is also in this line
when the expression is evaluated (but it may be moved around).set indentexpr=s:MyIndentExpr()
set indentexpr=<SID>SomeIndentExpr()
set indentexpr=GetMyIndent()
'indentkeys'
'indk'
'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
local to buffer
A list of keys that, when typed in Insert mode, cause reindenting of
the current line. Only happens if 'indentexpr' isn't empty.
The format is identical to 'cinkeys', see indentkeys-format.
See C-indenting and indent-expression.'infercase'
'inf'
'noinfercase'
'noinf'
'infercase' 'inf' boolean (default off)
local to buffer
When doing keyword completion in insert mode ins-completion, and
'ignorecase' is also on, the case of the match is adjusted depending
on the typed text. If the typed text contains a lowercase letter
where the match has an upper case letter, the completed part is made
lowercase. If the typed text has no lowercase letters and the match
has a lowercase letter where the typed text has an uppercase letter,
and there is a letter before it, the completed part is made uppercase.
With 'noinfercase' the match is used as-is.'isfname'
'isf'
'isfname' 'isf' string (default for Windows:
"@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],@-@,!,~,="
otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
global
The characters specified by this option are included in file names and
path names. Filenames are used for commands like "gf", "[i" and in
the tags file. It is also used for "\f" in a pattern.
Multi-byte characters 256 and above are always included, only the
characters up to 255 are specified with this option.
For UTF-8 the characters 0xa0 to 0xff are included as well.
Think twice before adding white space to this option. Although a
space may appear inside a file name, the effect will be that Vim
doesn't know where a file name starts or ends when doing completion.
It most likely works better without a space in 'isfname'.<Tab>
.
See option-backslash about including spaces and backslashes.'isident'
'isi'
'isident' 'isi' string (default for Windows:
"@,48-57,_,128-167,224-235"
otherwise: "@,48-57,_,192-255")
global
The characters given by this option are included in identifiers.
Identifiers are used in recognizing environment variables and after a
match of the 'define' option. It is also used for "\i" in a
pattern. See 'isfname' for a description of the format of this
option. For '@' only characters up to 255 are used.
Careful: If you change this option, it might break expanding
environment variables. E.g., when '/' is included and Vim tries to
expand "$HOME/.local/state/nvim/shada/main.shada". Maybe you should
change 'iskeyword' instead.'iskeyword'
'isk'
'iskeyword' 'isk' string (default "@,48-57,_,192-255")
local to buffer
Keywords are used in searching and recognizing with many commands:
"w", "*", "[i", etc. It is also used for "\k" in a pattern. See
'isfname' for a description of the format of this option. For '@'
characters above 255 check the "word" character class (any character
that is not white space or punctuation).
For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
For a help file it is set to all non-blank printable characters except
"*", '"' and '|' (so that CTRL-]
on a command finds the help for that
command).
When the 'lisp' option is on the '-' character is always included.
This option also influences syntax highlighting, unless the syntax
uses :syn-iskeyword.'isprint'
'isp'
'isprint' 'isp' string (default "@,161-255")
global
The characters given by this option are displayed directly on the
screen. It is also used for "\p" in a pattern. The characters from
space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
even when they are not included in 'isprint' or excluded. See
'isfname' for a description of the format of this option.<xx>
, with the hexadecimal value of the byte.
When 'display' contains "uhex" all unprintable characters are
displayed as <xx>
.
The SpecialKey highlighting will be used for unprintable characters.
hl-SpecialKey<xxxx>
.
There is no option to specify these characters.'joinspaces'
'js'
'nojoinspaces'
'nojs'
'joinspaces' 'js' boolean (default off)
global
Insert two spaces after a '.', '?' and '!' with a join command.
Otherwise only one space is inserted.'jumpoptions'
'jop'
'jumpoptions' 'jop' string (default "clean")
global
List of words that change the behavior of the jumplist.
stack Make the jumplist behave like the tagstack.
Relative location of entries in the jumplist is
preserved at the cost of discarding subsequent entries
when navigating backwards in the jumplist and then
jumping to a location. jumplist-stack'keymap'
'kmp'
'keymap' 'kmp' string (default "")
local to buffer
Name of a keyboard mapping. See mbyte-keymap.
Setting this option to a valid keymap name has the side effect of
setting 'iminsert' to one, so that the keymap becomes effective.
'imsearch' is also set to one, unless it was -1
Only alphanumeric characters, '.', '-' and '_' can be used.'keymodel'
'km'
'keymodel' 'km' string (default "")
global
List of comma-separated words, which enable special things that keys
can do. These values can be used:
startsel Using a shifted special key starts selection (either
Select mode or Visual mode, depending on "key" being
present in 'selectmode').
stopsel Using a not-shifted special key stops selection.
Special keys in this context are the cursor keys, <End>
, <Home>
,
<PageUp>
and <PageDown>
.'keywordprg'
'kp'
'keywordprg' 'kp' string (default ":Man", Windows: ":help")
global or local to buffer global-local
Program to use for the K command. Environment variables are
expanded :set_env. ":help" may be used to access the Vim internal
help. (Note that previously setting the global option to the empty
value did this, which is now deprecated.)
When the first character is ":", the command is invoked as a Vim
Ex command prefixed with [count].
When "man" or "man -s" is used, Vim will automatically translate
a [count] for the "K" command to a section number.
See option-backslash about including spaces and backslashes.
Example:set keywordprg=man\ -s
set keywordprg=:Man
'langmap'
'lmap'
E357
E358
'langmap' 'lmap' string (default "")
global
This option allows switching your keyboard into a special language
mode. When you are typing text in Insert mode the characters are
inserted directly. When in Normal mode the 'langmap' option takes
care of translating these special characters to the original meaning
of the key. This means you don't have to change the keyboard mode to
be able to execute Normal mode commands.
This is the opposite of the 'keymap' option, where characters are
mapped in Insert mode.
Also consider setting 'langremap' to off, to prevent 'langmap' from
applying to characters resulting from a mapping.
This option cannot be set from a modeline or in the sandbox, for
security reasons.greek
set langmap=ΑA,ΒB,ΨC,ΔD,ΕE,ΦF,ΓG,ΗH,ΙI,ΞJ,ΚK,ΛL,ΜM,ΝN,ΟO,ΠP,QQ,ΡR,ΣS,ΤT,ΘU,ΩV,WW,ΧX,ΥY,ΖZ,αa,βb,ψc,δd,εe,φf,γg,ηh,ιi,ξj,κk,λl,μm,νn,οo,πp,qq,ρr,σs,τt,θu,ωv,ςw,χx,υy,ζz
set langmap=zy,yz,ZY,YZ
CTRL-R
o Insert/Replace Mode: Mappings
Characters entered in Command-line mode will NOT be affected by
this option. Note that this option can be changed at any time
allowing to switch between mappings for different languages/encodings.
Use a mapping to avoid having to type it each time!'langmenu'
'lm'
'langmenu' 'lm' string (default "")
global
Language to use for menu translation. Tells which file is loaded
from the "lang" directory in 'runtimepath':"lang/menu_" .. &langmenu .. ".vim"
set langmenu=nl_NL.ISO_8859-1
/\*?[|<>
are illegal.
If your $LANG is set to a non-English language but you do want to use
the English menus:set langmenu=none
source $VIMRUNTIME/delmenu.vim
set langmenu=de_DE.ISO_8859-1
source $VIMRUNTIME/menu.vim
'langremap'
'lrm'
'nolangremap'
'nolrm'
'langremap' 'lrm' boolean (default off)
global
When off, setting 'langmap' does not apply to characters resulting from
a mapping. If setting 'langmap' disables some of your mappings, make
sure this option is off.'laststatus'
'ls'
'laststatus' 'ls' number (default 2)
global
The value of this option influences when the last window will have a
status line:
0: never
1: only if there are at least two windows
2: always
3: always and ONLY the last window
The screen looks nicer with a status line if you have several
windows, but it takes another screen line. status-line'lazyredraw'
'lz'
'nolazyredraw'
'nolz'
'lazyredraw' 'lz' boolean (default off)
global
When this option is set, the screen will not be redrawn while
executing macros, registers and other commands that have not been
typed. Also, updating the window title is postponed. To force an
update use :redraw.
This may occasionally cause display errors. It is only meant to be set
temporarily when performing an operation where redrawing may cause
flickering or cause a slowdown.'linebreak'
'lbr'
'nolinebreak'
'nolbr'
'linebreak' 'lbr' boolean (default off)
local to window
If on, Vim will wrap long lines at a character in 'breakat' rather
than at the last character that fits on the screen. Unlike
'wrapmargin' and 'textwidth', this does not insert <EOL>
s in the file,
it only affects the way the file is displayed, not its contents.
If 'breakindent' is set, line is visually indented. Then, the value
of 'showbreak' is used to put in front of wrapped lines. This option
is not used when the 'wrap' option is off.
Note that <Tab>
characters after an <EOL>
are mostly not displayed
with the right amount of white space.'lines'
E593
'lines' number (default 24 or terminal height)
global
Number of lines of the Vim window.
Normally you don't need to set this. It is done automatically by the
terminal initialization code.
When Vim is running in the GUI or in a resizable window, setting this
option will cause the window size to be changed. When you only want
to use the size for the GUI, put the command in your gvimrc file.
Vim limits the number of lines to what fits on the screen. You can
use this command to get the tallest window possible:set lines=999
'linespace'
'lsp'
'linespace' 'lsp' number (default 0)
global
only in the GUI
Number of pixel lines inserted between characters. Useful if the font
uses the full character cell height, making lines touch each other.
When non-zero there is room for underlining.
With some fonts there can be too much room between lines (to have
space for ascents and descents). Then it makes sense to set
'linespace' to a negative value. This may cause display problems
though!'lisp'
'nolisp'
'lisp' boolean (default off)
local to buffer
Lisp mode: When <Enter>
is typed in insert mode set the indent for
the next line to Lisp standards (well, sort of). Also happens with
"cc" or "S". 'autoindent' must also be on for this to work. The 'p'
flag in 'cpoptions' changes the method of indenting: Vi compatible or
better. Also see 'lispwords'.
The '-' character is included in keyword characters. Redefines the
"=" operator to use this same indentation algorithm rather than
calling an external program if 'equalprg' is empty.'lispoptions'
'lop'
'lispoptions' 'lop' string (default "")
local to buffer
Comma-separated list of items that influence the Lisp indenting when
enabled with the 'lisp' option. Currently only one item is
supported:
expr:1 use 'indentexpr' for Lisp indenting when it is set
expr:0 do not use 'indentexpr' for Lisp indenting (default)
Note that when using 'indentexpr' the =
operator indents all the
lines, otherwise the first line is not indented (Vi-compatible).'lispwords'
'lw'
'lispwords' 'lw' string (default is very long)
global or local to buffer global-local
Comma-separated list of words that influence the Lisp indenting when
enabled with the 'lisp' option.'list'
'nolist'
'list' boolean (default off)
local to window
List mode: By default, show tabs as ">", trailing spaces as "-", and
non-breakable space characters as "+". Useful to see the difference
between tabs and spaces and for trailing blanks. Further changed by
the 'listchars' option.set list lcs=tab:\ \
'listchars'
'lcs'
'listchars' 'lcs' string (default "tab:> ,trail:-,nbsp:+")
global or local to window global-local
Strings to use in 'list' mode and for the :list command. It is a
comma-separated list of string settings. E1511
lcs-eol
lcs-tab
> >- >-- etc.
> <> <-> <--> etc.
lcs-space
lcs-multispace
:set listchars=multispace:---+
shows ten consecutive
spaces as:---+---+--
lcs-lead
set listchars+=tab:>-,lead:.
lcs-leadmultispace
:set listchars=leadmultispace:---+
shows ten
consecutive leading spaces as:---+---+--XXX
lcs-trail
lcs-extends
lcs-precedes
lcs-conceal
lcs-nbsp
E1512
set listchars=eol:\\x24
set listchars=eol:\\u21b5
set listchars=eol:\\U000021b5
set lcs=tab:>-,trail:-
set lcs=tab:>-,eol:<,nbsp:%
set lcs=extends:>,precedes:<
'loadplugins'
'lpl'
'noloadplugins'
'nolpl'
'loadplugins' 'lpl' boolean (default on)
global
When on the plugin scripts are loaded when starting up load-plugins.
This option can be reset in your vimrc file to disable the loading
of plugins.
Note that using the "-u NONE" and "--noplugin" command line arguments
reset this option. -u --noplugin'magic'
'nomagic'
'magic' boolean (default on)
global
Changes the special characters that can be used in search patterns.
See pattern.
WARNING: Switching this option off most likely breaks plugins! That
is because many patterns assume it's on and will fail when it's off.
Only switch it off when working with old Vi scripts. In any other
situation write patterns that work when 'magic' is on. Include "\M"
when you want to /\M.'makeef'
'mef'
'makeef' 'mef' string (default "")
global
Name of the errorfile for the :make command (see :make_makeprg)
and the :grep command.
When it is empty, an internally generated temp file will be used.
When "##" is included, it is replaced by a number to make the name
unique. This makes sure that the ":make" command doesn't overwrite an
existing file.
NOT used for the ":cf" command. See 'errorfile' for that.
Environment variables are expanded :set_env.
See option-backslash about including spaces and backslashes.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'makeencoding'
'menc'
'makeencoding' 'menc' string (default "")
global or local to buffer global-local
Encoding used for reading the output of external commands. When empty,
encoding is not converted.
This is used for :make
, :lmake
, :grep
, :lgrep
, :grepadd
,
:lgrepadd
, :cfile
, :cgetfile
, :caddfile
, :lfile
, :lgetfile
,
and :laddfile
.set makeencoding=char " system locale is used
'makeprg'
'mp'
'makeprg' 'mp' string (default "make")
global or local to buffer global-local
Program to use for the ":make" command. See :make_makeprg.
This option may contain '%' and '#' characters (see :_% and :_#),
which are expanded to the current and alternate file name. Use ::S
to escape file names in case they contain special characters.
Environment variables are expanded :set_env. See option-backslash
about including spaces and backslashes.
Note that a '|' must be escaped twice: once for ":set" and once for
the interpretation of a command. When you use a filter called
"myfilter" do it like this:set makeprg=gmake\ \\\|\ myfilter
set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
'matchpairs'
'mps'
'matchpairs' 'mps' string (default "(:),{:}
,[:]")
local to buffer
Characters that form pairs. The % command jumps from one to the
other.
Only character pairs are allowed that are different, thus you cannot
jump between two double quotes.
The characters must be separated by a colon.
The pairs must be separated by a comma. Example for including '<' and
'>' (for HTML):set mps+=<:>
au FileType c,cpp,java set mps+==:;
'matchtime'
'mat'
'matchtime' 'mat' number (default 5)
global
Tenths of a second to show the matching paren, when 'showmatch' is
set. Note that this is not in milliseconds, like other options that
set a time. This is to be compatible with Nvi.'maxfuncdepth'
'mfd'
'maxfuncdepth' 'mfd' number (default 100)
global
Maximum depth of function calls for user functions. This normally
catches endless recursion. When using a recursive function with
more depth, set 'maxfuncdepth' to a bigger number. But this will use
more memory, there is the danger of failing when memory is exhausted.
Increasing this limit above 200 also changes the maximum for Ex
command recursion, see E169.
See also :function.
Also used for maximum depth of callback functions.'maxmapdepth'
'mmd'
E223
'maxmapdepth' 'mmd' number (default 1000)
global
Maximum number of times a mapping is done without resulting in a
character to be used. This normally catches endless mappings, like
":map x y" with ":map y x". It still does not catch ":map g wg",
because the 'w' is used before the next mapping is done. See also
key-mapping.'maxmempattern'
'mmp'
'maxmempattern' 'mmp' number (default 1000)
global
Maximum amount of memory (in Kbyte) to use for pattern matching.
The maximum value is about 2000000. Use this to work without a limit.
E363
CTRL-C
was typed.
Running into the limit often means that the pattern is very
inefficient or too complex. This may already happen with the pattern
"\(.\)*" on a very long line. ".*" works much better.
Might also happen on redraw, when syntax rules try to match a complex
text structure.
Vim may run out of memory before hitting the 'maxmempattern' limit, in
which case you get an "Out of memory" error instead.'menuitems'
'mis'
'menuitems' 'mis' number (default 25)
global
Maximum number of items to use in a menu. Used for menus that are
generated from a list of items, e.g., the Buffers menu. Changing this
option has no direct effect, the menu must be refreshed first.'mkspellmem'
'msm'
'mkspellmem' 'msm' string (default "460000,2000,500")
global
Parameters for :mkspell. This tunes when to start compressing the
word tree. Compression can be slow when there are many words, but
it's needed to avoid running out of memory. The amount of memory used
per word depends very much on how similar the words are, that's why
this tuning is complicated.{start},{inc},{added}
{start}
gives the amount of memory in Kbyte that can be used before any
compression is done. It should be a bit smaller than the amount of
memory that is available to Vim.{start}
limit the {inc}
number specifies the
amount of memory in Kbyte that can be allocated before another
compression is done. A low number means compression is done after
less words are added, which is slow. A high number means more memory
will be allocated.{added}
times 1024 words can be added before
the {inc}
limit is ignored and compression is done when any extra
amount of memory is needed. A low number means there is a smaller
chance of hitting the {inc}
limit, less memory is used but it's
slower.set mkspellmem=900000,3000,800
'modeline'
'ml'
'nomodeline'
'noml'
'modeline' 'ml' boolean (default on (off for root))
local to buffer
If 'modeline' is on 'modelines' gives the number of lines that is
checked for set commands. If 'modeline' is off or 'modelines' is zero
no lines are checked. See modeline.'modelineexpr'
'mle'
'nomodelineexpr'
'nomle'
'modelineexpr' 'mle' boolean (default off)
global
When on allow some options that are an expression to be set in the
modeline. Check the option for whether it is affected by
'modelineexpr'. Also see modeline.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'modelines'
'mls'
'modelines' 'mls' number (default 5)
global
If 'modeline' is on 'modelines' gives the number of lines that is
checked for set commands. If 'modeline' is off or 'modelines' is zero
no lines are checked. See modeline.'modifiable'
'ma'
'nomodifiable'
'noma'
E21
'modifiable' 'ma' boolean (default on)
local to buffer
When off the buffer contents cannot be changed. The 'fileformat' and
'fileencoding' options also can't be changed.
Can be reset on startup with the -M command line argument.'modified'
'mod'
'nomodified'
'nomod'
'modified' 'mod' boolean (default off)
local to buffer local-noglobal
When on, the buffer is considered to be modified. This option is set
when:
1. A change was made to the text since it was last written. Using the
undo command to go back to the original text will reset the
option. But undoing changes that were made before writing the
buffer will set the option again, since the text is different from
when it was written.
2. 'fileformat' or 'fileencoding' is different from its original
value. The original value is set when the buffer is read or
written. A ":set nomodified" command also resets the original
values to the current values and the 'modified' option will be
reset.
Similarly for 'eol' and 'bomb'.
This option is not set when a change is made to the buffer as the
result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
FileAppendPost or VimLeave autocommand event. See gzip-example for
an explanation.
When 'buftype' is "nowrite" or "nofile" this option may be set, but
will be ignored.
Note that the text may actually be the same, e.g. 'modified' is set
when using "rA" on an "A".'more'
'nomore'
'more' boolean (default on)
global
When on, listings pause when the whole screen is filled. You will get
the more-prompt. When this option is off there are no pauses, the
listing continues until finished.'mouse'
set mouse=nv
'mousefocus'
'mousef'
'nomousefocus'
'nomousef'
'mousefocus' 'mousef' boolean (default off)
global
The window that the mouse pointer is on is automatically activated.
When changing the window layout or window focus in another way, the
mouse pointer is moved to the window with keyboard focus. Off is the
default because it makes using the pull down menus a little goofy, as
a pointer transit may activate a window unintentionally.'mousehide'
'mh'
'nomousehide'
'nomh'
'mousehide' 'mh' boolean (default on)
global
only in the GUI
When on, the mouse pointer is hidden when characters are typed.
The mouse pointer is restored when the mouse is moved.'mousemodel'
'mousem'
'mousemodel' 'mousem' string (default "popup_setpos")
global
Sets the model to use for the mouse. The name mostly specifies what
the right mouse button is used for:
extend Right mouse button extends a selection. This works
like in an xterm.
popup Right mouse button pops up a menu. The shifted left
mouse button extends a selection. This works like
with Microsoft Windows.
popup_setpos Like "popup", but the cursor will be moved to the
position where the mouse was clicked, and thus the
selected operation will act upon the clicked object.
If clicking inside a selection, that selection will
be acted upon, i.e. no cursor move. This implies of
course, that right clicking outside a selection will
end Visual mode.
Overview of what button does what for each model:
map <S-LeftMouse> <RightMouse>
map <S-LeftDrag> <RightDrag>
map <S-LeftRelease> <RightRelease>
map <2-S-LeftMouse> <2-RightMouse>
map <2-S-LeftDrag> <2-RightDrag>
map <2-S-LeftRelease> <2-RightRelease>
map <3-S-LeftMouse> <3-RightMouse>
map <3-S-LeftDrag> <3-RightDrag>
map <3-S-LeftRelease> <3-RightRelease>
map <4-S-LeftMouse> <4-RightMouse>
map <4-S-LeftDrag> <4-RightDrag>
map <4-S-LeftRelease> <4-RightRelease>
'mousemoveevent'
'mousemev'
'nomousemoveevent'
'nomousemev'
'mousemoveevent' 'mousemev' boolean (default off)
global
When on, mouse move events are delivered to the input queue and are
available for mapping. The default, off, avoids the mouse movement
overhead except when needed.
Warning: Setting this option can make pending mappings to be aborted
when the mouse is moved.'mousescroll'
E5080
'mousescroll' string (default "ver:3,hor:6")
global
This option controls the number of lines / columns to scroll by when
scrolling with a mouse wheel (scroll-mouse-wheel). The option is
a comma-separated list. Each part consists of a direction and a count
as follows:
direction:count,direction:count
Direction is one of either "hor" or "ver". "hor" controls horizontal
scrolling and "ver" controls vertical scrolling. Count sets the amount
to scroll by for the given direction, it should be a non negative
integer. Each direction should be set at most once. If a direction
is omitted, a default value is used (6 for horizontal scrolling and 3
for vertical scrolling). You can disable mouse scrolling by using
a count of 0.set mousescroll=ver:5,hor:2
'mouseshape'
'mouses'
E547
'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
m:no,ml:up-arrow,v:rightup-arrow")
global
This option tells Vim what the mouse pointer should look like in
different modes. The option is a comma-separated list of parts, much
like used for 'guicursor'. Each part consist of a mode/location-list
and an argument-list:
mode-list:shape,mode-list:shape,..
The mode-list is a dash separated list of these modes/locations:
<number>
any X11 pointer number (see X11/cursorfont.h)set mouseshape=s:udsizing,m:no
'mousetime'
'mouset'
'mousetime' 'mouset' number (default 500)
global
Defines the maximum time in msec between two mouse clicks for the
second click to be recognized as a multi click.'nrformats'
'nf'
'nrformats' 'nf' string (default "bin,hex")
local to buffer
This defines what bases Vim will consider for numbers when using the
CTRL-A
and CTRL-X
commands for adding to and subtracting from a number
respectively; see CTRL-A for more info on these commands.
alpha If included, single alphabetical characters will be
incremented or decremented. This is useful for a list with a
letter index a), b), etc. octal-nrformats
CTRL-A
on "007" results in "010".
hex If included, numbers starting with "0x" or "0X" will be
considered to be hexadecimal. Example: Using CTRL-X
on
"0x100" results in "0x0ff".
bin If included, numbers starting with "0b" or "0B" will be
considered to be binary. Example: Using CTRL-X
on
"0b1000" subtracts one, resulting in "0b0111".
unsigned If included, numbers are recognized as unsigned. Thus a
leading dash or negative sign won't be considered as part of
the number. Examples:
Using CTRL-X
on "2020" in "9-2020" results in "9-2019"
(without "unsigned" it would become "9-2021").
Using CTRL-A
on "2020" in "9-2020" results in "9-2021"
(without "unsigned" it would become "9-2019").
Using CTRL-X
on "0" or CTRL-A
on "18446744073709551615"
(2^64 - 1) has no effect, overflow is prevented.
blank If included, treat numbers as signed or unsigned based on
preceding whitespace. If a number with a leading dash has its
dash immediately preceded by a non-whitespace character (i.e.,
not a tab or a " "), the negative sign won't be considered as
part of the number. For example:
Using CTRL-A
on "14" in "Carbon-14" results in "Carbon-15"
(without "blank" it would become "Carbon-13").
Using CTRL-X
on "8" in "Carbon -8" results in "Carbon -9"
(because -8 is preceded by whitespace. If "unsigned" was
set, it would result in "Carbon -7").
If this format is included, overflow is prevented as if
"unsigned" were set. If both this format and "unsigned" are
included, "unsigned" will take precedence.'number'
'nu'
'nonumber'
'nonu'
'number' 'nu' boolean (default off)
local to window
Print the line number in front of each line. When the 'n' option is
excluded from 'cpoptions' a wrapped line will not use the column of
line numbers.
Use the 'numberwidth' option to adjust the room for the line number.
When a long, wrapped line doesn't start with the first character, '-'
characters are put before the number.
For highlighting see hl-LineNr, hl-CursorLineNr, and the
:sign-define "numhl" argument.
number_relativenumber
|apple | 1 apple | 2 apple | 2 apple |pear | 2 pear | 1 pear | 1 pear |nobody | 3 nobody | 0 nobody |3 nobody |there | 4 there | 1 there | 1 there
'numberwidth'
'nuw'
'numberwidth' 'nuw' number (default 4)
local to window
Minimal number of columns to use for the line number. Only relevant
when the 'number' or 'relativenumber' option is set or printing lines
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 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
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
up to 999. When the buffer has 1000 lines five columns will be used.
The minimum value is 1, the maximum value is 20.'omnifunc'
'ofu'
'omnifunc' 'ofu' string (default "")
local to buffer
This option specifies a function to be used for Insert mode omni
completion with CTRL-X
CTRL-O
. i_CTRL-X_CTRL-O
See complete-functions for an explanation of how the function is
invoked and what it should return. The value can be the name of a
function, a lambda or a Funcref. See option-value-function for
more information.
This option is usually set by a filetype plugin:
:filetype-plugin-on
This option cannot be set from a modeline or in the sandbox, for
security reasons.'opendevice'
'odev'
'noopendevice'
'noodev'
'opendevice' 'odev' boolean (default off)
global
only for Windows
Enable reading and writing from devices. This may get Vim stuck on a
device that can be opened but doesn't actually do the I/O. Therefore
it is off by default.
Note that on Windows editing "aux.h", "lpt1.txt" and the like also
result in editing a device.'operatorfunc'
'opfunc'
'operatorfunc' 'opfunc' string (default "")
global
This option specifies a function to be called by the g@ operator.
See :map-operator for more info and an example. The value can be
the name of a function, a lambda or a Funcref. See
option-value-function for more information.'packpath'
'pp'
'packpath' 'pp' string (default see 'runtimepath')
global
Directories used to find packages.
See packages and packages-runtimepath.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'paragraphs'
'para'
'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
global
Specifies the nroff macros that separate paragraphs. These are pairs
of two letters (see object-motions).'patchexpr'
'pex'
'patchexpr' 'pex' string (default "")
global
Expression which is evaluated to apply a patch to a file and generate
the resulting new version of the file. See diff-patchexpr.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'patchmode'
'pm'
E205
E206
'patchmode' 'pm' string (default "")
global
When non-empty the oldest version of a file is kept. This can be used
to keep the original version of a file if you are changing files in a
source distribution. Only the first time that a file is written a
copy of the original file will be kept. The name of the copy is the
name of the original file with the string in the 'patchmode' option
appended. This option should start with a dot. Use a string like
".orig" or ".org". 'backupdir' must not be empty for this to work
(Detail: The backup file is renamed to the patchmode file after the
new file has been successfully written, that's why it must be possible
to write a backup file). If there was no file to be backed up, an
empty file is created.
When the 'backupskip' pattern matches, a patchmode file is not made.
Using 'patchmode' for compressed files appends the extension at the
end (e.g., "file.gz.orig"), thus the resulting name isn't always
recognized as a compressed file.
Only normal file name characters can be used, /\*?[|<>
are illegal.'path'
'pa'
E343
E345
E347
E854
'path' 'pa' string (default ".,,")
global or local to buffer global-local
This is a list of directories which will be searched when using the
gf, [f, ]f, ^Wf, :find, :sfind, :tabfind and other commands,
provided that the file being searched for has a relative path (not
starting with "/", "./" or "../"). The directories in the 'path'
option may be relative or absolute.
set path=.,/usr/local/include,/usr/include
set path=.,/dir/with\\\ space
set path=.,/dir/with\\,comma
set path=.
set path=,,
set path=.,c:\\include
set path=.,c:/include
set path-=
set path+=
let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
'preserveindent'
'pi'
'nopreserveindent'
'nopi'
'preserveindent' 'pi' boolean (default off)
local to buffer
When changing the indent of the current line, preserve as much of the
indent structure as possible. Normally the indent is replaced by a
series of tabs followed by spaces as required (unless 'expandtab' is
enabled, in which case only spaces are used). Enabling this option
means the indent will preserve as many existing characters as possible
for indenting, and only add additional tabs or spaces as required.
'expandtab' does not apply to the preserved white space, a Tab remains
a Tab.
NOTE: When using ">>" multiple times the resulting indent is a mix of
tabs and spaces. You might not like this.
Also see 'copyindent'.
Use :retab to clean up white space.'previewheight'
'pvh'
'previewheight' 'pvh' number (default 12)
global
Default height for a preview window. Used for :ptag and associated
commands. Used for CTRL-W_} when no count is given.'previewwindow'
'pvw'
'nopreviewwindow'
'nopvw'
E590
'previewwindow' 'pvw' boolean (default off)
local to window local-noglobal
Identifies the preview window. Only one window can have this option
set. It's normally not set directly, but by using one of the commands
:ptag, :pedit, etc.'pumblend'
'pb'
'pumblend' 'pb' number (default 0)
global
Enables pseudo-transparency for the popup-menu. Valid values are in
the range of 0 for fully opaque popupmenu (disabled) to 100 for fully
transparent background. Values between 0-30 are typically most useful.set pumblend=15
hi PmenuSel blend=0
'pumheight'
'ph'
'pumheight' 'ph' number (default 0)
global
Maximum number of items to show in the popup menu
(ins-completion-menu). Zero means "use available screen space".'pumwidth'
'pw'
'pumwidth' 'pw' number (default 15)
global
Minimum width for the popup menu (ins-completion-menu). If the
cursor column + 'pumwidth' exceeds screen width, the popup menu is
nudged to fit on the screen.'pyxversion'
'pyx'
'pyxversion' 'pyx' number (default 3)
global
Specifies the python version used for pyx* functions and commands
python_x. As only Python 3 is supported, this always has the value
3
. Setting any other value is an error.'quickfixtextfunc'
'qftf'
'quickfixtextfunc' 'qftf' string (default "")
global
This option specifies a function to be used to get the text to display
in the quickfix and location list windows. This can be used to
customize the information displayed in the quickfix or location window
for each entry in the corresponding quickfix or location list. See
quickfix-window-function for an explanation of how to write the
function and an example. The value can be the name of a function, a
lambda or a Funcref. See option-value-function for more
information.'quoteescape'
'qe'
'quoteescape' 'qe' string (default "\")
local to buffer
The characters that are used to escape quotes in a string. Used for
objects like a', a" and a` a'.
When one of the characters in this option is found inside a string,
the following character will be skipped. The default value makes the
text "foo\"bar\\" considered to be one string.'readonly'
'ro'
'noreadonly'
'noro'
'readonly' 'ro' boolean (default off)
local to buffer local-noglobal
If on, writes fail unless you use a '!'. Protects you from
accidentally overwriting a file. Default on when Vim is started
in read-only mode ("vim -R") or when the executable is called "view".
When using ":w!" the 'readonly' option is reset for the current
buffer, unless the 'Z' flag is in 'cpoptions'.
When using the ":view" command the 'readonly' option is set for the
newly edited buffer.
See 'modifiable' for disallowing changes to the buffer.'redrawdebug'
'rdb'
'redrawdebug' 'rdb' string (default "")
global
Flags to change the way redrawing works, for debugging purposes.
Most useful with 'writedelay' set to some reasonable value.
Supports the following flags:
compositor Indicate each redraw event handled by the compositor
by briefly flashing the redrawn regions in colors
indicating the redraw type. These are the highlight
groups used (and their default colors):
RedrawDebugNormal gui=reverse normal redraw passed through
RedrawDebugClear guibg=Yellow clear event passed through
RedrawDebugComposed guibg=Green redraw event modified by the
compositor (due to
overlapping grids, etc)
RedrawDebugRecompose guibg=Red redraw generated by the
compositor itself, due to a
grid being moved or deleted.
line introduce a delay after each line drawn on the screen.
When using the TUI or another single-grid UI, "compositor"
gives more information and should be preferred (every
line is processed as a separate event by the compositor)
flush introduce a delay after each "flush" event.
nothrottle Turn off throttling of the message grid. This is an
optimization that joins many small scrolls to one
larger scroll when drawing the message area (with
'display' msgsep flag active).
invalid Enable stricter checking (abort) of inconsistencies
of the internal screen state. This is mostly
useful when running nvim inside a debugger (and
the test suite).
nodelta Send all internally redrawn cells to the UI, even if
they are unchanged from the already displayed state.'redrawtime'
'rdt'
'redrawtime' 'rdt' number (default 2000)
global
Time in milliseconds for redrawing the display. Applies to
'hlsearch', 'inccommand', :match highlighting and syntax
highlighting.
When redrawing takes more than this many milliseconds no further
matches will be highlighted.
For syntax highlighting the time applies per window. When over the
limit syntax highlighting is disabled until CTRL-L is used.
This is used to avoid that Vim hangs when using a very complicated
pattern.'regexpengine'
're'
'regexpengine' 're' number (default 0)
global
This selects the default regexp engine. two-engines
The possible values are:
0 automatic selection
1 old engine
2 NFA engine
Note that when using the NFA engine and the pattern contains something
that is not supported the pattern will not match. This is only useful
for debugging the regexp engine.
Using automatic selection enables Vim to switch the engine, if the
default engine becomes too costly. E.g., when the NFA engine uses too
many states. This should prevent Vim from hanging on a combination of
a complex pattern with long text.'relativenumber'
'rnu'
'norelativenumber'
'nornu'
'relativenumber' 'rnu' boolean (default off)
local to window
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
precede some vertical motion commands (e.g. j k + -) with, without
having to calculate it yourself. Especially useful in combination with
other commands (e.g. y d c < > gq gw =).
When the 'n' option is excluded from 'cpoptions' a wrapped
line will not use the column of line numbers.
The 'numberwidth' option can be used to set the room used for the line
number.
When a long, wrapped line doesn't start with the first character, '-'
characters are put before the number.
See hl-LineNr and hl-CursorLineNr for the highlighting used for
the number.'report'
'revins'
'ri'
'norevins'
'nori'
'revins' 'ri' boolean (default off)
global
Inserting characters in Insert mode will work backwards. See "typing
backwards" ins-reverse. This option can be toggled with the CTRL-_
command in Insert mode, when 'allowrevins' is set.'rightleft'
'rl'
'norightleft'
'norl'
'rightleft' 'rl' boolean (default off)
local to window
When on, display orientation becomes right-to-left, i.e., characters
that are stored in the file appear from the right to the left.
Using this option, it is possible to edit files for languages that
are written from the right to the left such as Hebrew and Arabic.
This option is per window, so it is possible to edit mixed files
simultaneously, or to view the same file in both ways (this is
useful whenever you have a mixed text file with both right-to-left
and left-to-right strings so that both sets are displayed properly
in different windows). Also see rileft.txt.'rightleftcmd'
'rlc'
'rightleftcmd' 'rlc' string (default "search")
local to window
Each word in this option enables the command line editing to work in
right-to-left mode for a group of commands:'ruler'
'ru'
'noruler'
'noru'
'ruler' 'ru' boolean (default on)
global
Show the line and column number of the cursor position, separated by a
comma. When there is room, the relative position of the displayed
text in the file is shown on the far right:
Top first line is visible
Bot last line is visible
All first and last line are visible
45% relative position in the file
If 'rulerformat' is set, it will determine the contents of the ruler.
Each window has its own ruler. If a window has a status line, the
ruler is shown there. If a window doesn't have a status line and
'cmdheight' is zero, the ruler is not shown. Otherwise it is shown in
the last line of the screen. If the statusline is given by
'statusline' (i.e. not empty), this option takes precedence over
'ruler' and 'rulerformat'.
If the number of characters displayed is different from the number of
bytes in the text (e.g., for a TAB or a multibyte character), both
the text column (byte number) and the screen column are shown,
separated with a dash.
For an empty line "0-1" is shown.
For an empty buffer the line number will also be zero: "0,0-1".
If you don't want to see the ruler all the time but want to know where
you are, use "g CTRL-G
" g_CTRL-G.'rulerformat'
'ruf'
'rulerformat' 'ruf' string (default "")
global
When this option is not empty, it determines the content of the ruler
string, as displayed for the 'ruler' option.
The format of this option is like that of 'statusline'.
This option cannot be set in a modeline when 'modelineexpr' is off.set rulerformat=%15(%c%V\ %p%%%)
'runtimepath'
'rtp'
vimfiles
'runtimepath' 'rtp' string (default "$XDG_CONFIG_HOME/nvim,
$XDG_CONFIG_DIRS[1]/nvim,
$XDG_CONFIG_DIRS[2]/nvim,
…
$XDG_DATA_HOME/nvim[-data]/site,
$XDG_DATA_DIRS[1]/nvim/site,
$XDG_DATA_DIRS[2]/nvim/site,
…
$VIMRUNTIME,
…
$XDG_DATA_DIRS[2]/nvim/site/after,
$XDG_DATA_DIRS[1]/nvim/site/after,
$XDG_DATA_HOME/nvim[-data]/site/after,
…
$XDG_CONFIG_DIRS[2]/nvim/after,
$XDG_CONFIG_DIRS[1]/nvim/after,
$XDG_CONFIG_HOME/nvim/after")
global
List of directories to be searched for these runtime files:
filetype.lua filetypes new-filetype
autoload/ automatically loaded scripts autoload-functions
colors/ color scheme files :colorscheme
compiler/ compiler files :compiler
doc/ documentation write-local-help
ftplugin/ filetype plugins write-filetype-plugin
indent/ indent scripts indent-expression
keymap/ key mapping files mbyte-keymap
lang/ menu translations :menutrans
lua/ Lua plugins
menu.vim GUI menus menu.vim
pack/ packages :packadd
parser/ treesitter syntax parsers
plugin/ plugin scripts write-plugin
queries/ treesitter queries
rplugin/ remote-plugin scripts
spell/ spell checking files spell
syntax/ syntax files mysyntaxfile
tutor/ tutorial files :Tutorstdpath("config")
. $XDG_CONFIG_HOME
2. Directories which must contain configuration files according to
xdg ($XDG_CONFIG_DIRS, defaults to /etc/xdg). This also contains
preferences from system administrator.
3. Data home directory, for plugins installed by user.
Given by stdpath("data")/site
. $XDG_DATA_HOME
4. nvim/site subdirectories for each directory in $XDG_DATA_DIRS.
This is for plugins which were installed by system administrator,
but are not part of the Nvim distribution. XDG_DATA_DIRS defaults
to /usr/local/share/:/usr/share/, so system administrators are
expected to install site plugins to /usr/share/nvim/site.
5. Session state directory, for state data such as swap, backupdir,
viewdir, undodir, etc.
Given by stdpath("state")
. $XDG_STATE_HOME
6. $VIMRUNTIME, for files distributed with Nvim.
after-directory
packages-runtimepath
set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
'scroll'
'scr'
'scroll' 'scr' number (default half the window height)
local to window local-noglobal
Number of lines to scroll with CTRL-U
and CTRL-D
commands. Will be
set to half the number of lines in the window when the window size
changes. This may happen when enabling the status-line or
'tabline' option after setting the 'scroll' option.
If you give a count to the CTRL-U
or CTRL-D
command it will
be used as the new value for 'scroll'. Reset to half the window
height with ":set scroll=0".'scrollback'
'scbk'
'scrollback' 'scbk' number (default 10000)
local to buffer
Maximum number of lines kept beyond the visible screen. Lines at the
top are deleted if new lines exceed this limit.
Minimum is 1, maximum is 100000.
Only in terminal buffers.'scrollbind'
'scb'
'noscrollbind'
'noscb'
'scrollbind' 'scb' boolean (default off)
local to window
See also scroll-binding. When this option is set, scrolling the
current window also scrolls other scrollbind windows (windows that
also have this option set). This option is useful for viewing the
differences between two versions of a file, see 'diff'.
See 'scrollopt' for options that determine how this option should be
interpreted.
This option is mostly reset when splitting a window to edit another
file. This means that ":split | edit file" results in two windows
with scroll-binding, but ":split file" does not.'scrolljump'
'sj'
'scrolljump' 'sj' number (default 1)
global
Minimal number of lines to scroll when the cursor gets off the
screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E
,
CTRL-D
). Useful if your terminal scrolls very slowly.
When set to a negative number from -1 to -100 this is used as the
percentage of the window height. Thus -50 scrolls half the window
height.'scrolloff'
'so'
'scrolloff' 'so' number (default 0)
global or local to window global-local
Minimal number of screen lines to keep above and below the cursor.
This will make some context visible around where you are working. If
you set it to a very large value (999) the cursor line will always be
in the middle of the window (except at the start or end of the file or
when long lines wrap).
After using the local value, go back the global value with one of
these two:setlocal scrolloff<
setlocal scrolloff=-1
'scrollopt'
'sbo'
'scrollopt' 'sbo' string (default "ver,jump")
global
This is a comma-separated list of words that specifies how
'scrollbind' windows should behave. 'sbo' stands for ScrollBind
Options.
The following words are available:
ver Bind vertical scrolling for 'scrollbind' windows
hor Bind horizontal scrolling for 'scrollbind' windows
jump Applies to the offset between two windows for vertical
scrolling. This offset is the difference in the first
displayed line of the bound windows. When moving
around in a window, another 'scrollbind' window may
reach a position before the start or after the end of
the buffer. The offset is not changed though, when
moving back the 'scrollbind' window will try to scroll
to the desired position when possible.
When now making that window the current one, two
things can be done with the relative offset:
1. When "jump" is not included, the relative offset is
adjusted for the scroll position in the new current
window. When going back to the other window, the
new relative offset will be used.
2. When "jump" is included, the other windows are
scrolled to keep the same relative offset. When
going back to the other window, it still uses the
same relative offset.
Also see scroll-binding.
When 'diff' mode is active there always is vertical scroll binding,
even when "ver" isn't there.'sections'
'sect'
'sections' 'sect' string (default "SHNHH HUnhsh")
global
Specifies the nroff macros that separate sections. These are pairs of
two letters (See object-motions). The default makes a section start
at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".'selection'
'sel'
'selection' 'sel' string (default "inclusive")
global
This option defines the behavior of the selection. It is only used
in Visual and Select mode.
Possible values:
'selectmode'
'slm'
'selectmode' 'slm' string (default "")
global
This is a comma-separated list of words, which specifies when to start
Select mode instead of Visual mode, when a selection is started.
Possible values:
mouse when using the mouse
key when using shifted special keys
cmd when using "v", "V" or CTRL-V
See Select-mode.'sessionoptions'
'ssop'
'sessionoptions' 'ssop' string (default "blank,buffers,curdir,folds,help,tabpages,winsize,terminal")
global
Changes the effect of the :mksession command. It is a comma-
separated list of words. Each word enables saving and restoring
something:
'shada'
'sd'
E526
E527
E528
'shada' 'sd' string (default for
Win32: !,'100,<50,s10,h,rA:,rB:
others: !,'100,<50,s10,h)
global
When non-empty, the shada file is read upon startup and written
when exiting Vim (see shada-file). The string should be a comma-
separated list of parameters, each consisting of a single character
identifying the particular parameter, followed by a number or string
which specifies the value of that parameter. If a particular
character is left out, then the default value is used for that
parameter. The following is a list of the identifying characters and
the effect of their value.
shada-!
shada-quote
shada-%
shada-'
shada-/
shada-:
shada-<
shada-@
shada-c
shada-f
shada-h
shada-n
shada-r
shada-s
s10
maximum item size may be 1 byte
(type: 7-bit integer) + 9 bytes (timestamp: up to 64-bit
integer) + 3 bytes (item size: up to 16-bit integer because
2^8 < 10240 < 2^16) + 10240 bytes (requested maximum item
contents size) = 10253 bytes.set shada='50,<1000,s100,:0,n~/nvim/shada
'shadafile'
'sdf'
'shadafile' 'sdf' string (default "")
global
When non-empty, overrides the file name used for shada (viminfo).
When equal to "NONE" no shada file will be read or written.
This option can be set with the -i command line flag. The --clean
command line flag sets it to "NONE".
This option cannot be set from a modeline or in the sandbox, for
security reasons.'shell'
'sh'
E91
'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
global
Name of the shell to use for ! and :! commands. When changing the
value also check these options: 'shellpipe', 'shellslash'
'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
It is allowed to give an argument to the command, e.g. "csh -f".
See option-backslash about including spaces and backslashes.
Environment variables are expanded :set_env.set shell=\"c:\program\ files\unix\sh.exe\"\ -f
let &shell='"C:\Program Files\unix\sh.exe" -f'
shell-unquoting
shell-powershell
let &shell = executable('pwsh') ? 'pwsh' : 'powershell'
let &shellcmdflag = '-NoLogo -ExecutionPolicy RemoteSigned -Command [Console]::InputEncoding=[Console]::OutputEncoding=[System.Text.UTF8Encoding]::new();$PSDefaultParameterValues[''Out-File:Encoding'']=''utf8'';Remove-Alias -Force -ErrorAction SilentlyContinue tee;'
let &shellredir = '2>&1 | %%{ "$_" } | Out-File %s; exit $LastExitCode'
let &shellpipe = '2>&1 | %%{ "$_" } | tee %s; exit $LastExitCode'
set shellquote= shellxquote=
'shellcmdflag'
'shcf'
'shellcmdflag' 'shcf' string (default "-c"; Windows: "/s /c")
global
Flag passed to the shell to execute "!" and ":!" commands; e.g.,
bash.exe -c ls
or cmd.exe /s /c "dir"
. For MS-Windows, the
default is set according to the value of 'shell', to reduce the need
to set this option by the user.
On Unix it can have more than one flag. Each white space separated
part is passed as an argument to the shell command.
See option-backslash about including spaces and backslashes.
See shell-unquoting which talks about separating this option into
multiple arguments.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'shellpipe'
'sp'
'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
global
String to be used to put the output of the ":make" command in the
error file. See also :make_makeprg. See option-backslash about
including spaces and backslashes.
The name of the temporary file can be represented by "%s" if necessary
(the file name is appended automatically if no %s appears in the value
of this option).
For MS-Windows the default is "2>&1| tee". The stdout and stderr are
saved in a file and echoed to the screen.
For Unix the default is "| tee". The stdout of the compiler is saved
in a file and echoed to the screen. If the 'shell' option is "csh" or
"tcsh" after initializations, the default becomes "|& tee". If the
'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
"bash", "fish", "ash" or "dash" the default becomes "2>&1| tee". This
means that stderr is also included. Before using the 'shell' option a
path is removed, thus "/bin/sh" uses "sh".
The initialization of this option is done after reading the vimrc
and the other initializations, so that when the 'shell' option is set
there, the 'shellpipe' option changes automatically, unless it was
explicitly set before.
When 'shellpipe' is set to an empty string, no redirection of the
":make" output will be done. This is useful if you use a 'makeprg'
that writes to 'makeef' by itself. If you want no piping, but do
want to include the 'makeef', set 'shellpipe' to a single space.
Don't forget to precede the space with a backslash: ":set sp=\ ".
In the future pipes may be used for filtering and this option will
become obsolete (at least for Unix).
This option cannot be set from a modeline or in the sandbox, for
security reasons.'shellquote'
'shq'
'shellquote' 'shq' string (default ""; Windows, when 'shell'
contains "sh" somewhere: "\"")
global
Quoting character(s), put around the command passed to the shell, for
the "!" and ":!" commands. The redirection is kept outside of the
quoting. See 'shellxquote' to include the redirection. It's
probably not useful to set both options.
This is an empty string by default. Only known to be useful for
third-party shells on Windows systems, such as the MKS Korn Shell
or bash, where it should be "\"". The default is adjusted according
the value of 'shell', to reduce the need to set this option by the
user.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'shellredir'
'srr'
'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
global
String to be used to put the output of a filter command in a temporary
file. See also :!. See option-backslash about including spaces
and backslashes.
The name of the temporary file can be represented by "%s" if necessary
(the file name is appended automatically if no %s appears in the value
of this option).
The default is ">". For Unix, if the 'shell' option is "csh" or
"tcsh" during initializations, the default becomes ">&". If the
'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
"bash" or "fish", the default becomes ">%s 2>&1". This means that
stderr is also included. For Win32, the Unix checks are done and
additionally "cmd" is checked for, which makes the default ">%s 2>&1".
Also, the same names with ".exe" appended are checked for.
The initialization of this option is done after reading the vimrc
and the other initializations, so that when the 'shell' option is set
there, the 'shellredir' option changes automatically unless it was
explicitly set before.
In the future pipes may be used for filtering and this option will
become obsolete (at least for Unix).
This option cannot be set from a modeline or in the sandbox, for
security reasons.'shellslash'
'ssl'
'noshellslash'
'nossl'
'shellslash' 'ssl' boolean (default off)
global
only for MS-Windows
When set, a forward slash is used when expanding file names. This is
useful when a Unix-like shell is used instead of cmd.exe. Backward
slashes can still be typed, but they are changed to forward slashes by
Vim.
Note that setting or resetting this option has no effect for some
existing file names, thus this option needs to be set before opening
any file for best results. This might change in the future.
'shellslash' only works when a backslash can be used as a path
separator. To test if this is so use:if exists('+shellslash')
'shelltemp'
'stmp'
'noshelltemp'
'nostmp'
'shelltemp' 'stmp' boolean (default on)
global
When on, use temp files for shell commands. When off use a pipe.
When using a pipe is not possible temp files are used anyway.
The advantage of using a pipe is that nobody can read the temp file
and the 'shell' command does not need to support redirection.
The advantage of using a temp file is that the file type and encoding
can be detected.
The FilterReadPre, FilterReadPost and FilterWritePre,
FilterWritePost autocommands event are not triggered when
'shelltemp' is off.
system() does not respect this option, it always uses pipes.'shellxescape'
'sxe'
'shellxescape' 'sxe' string (default "")
global
When 'shellxquote' is set to "(" then the characters listed in this
option will be escaped with a '^' character. This makes it possible
to execute most external commands with cmd.exe.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'shellxquote'
'sxq'
'shellxquote' 'sxq' string (default "", Windows: "\"")
global
Quoting character(s), put around the command passed to the shell, for
the "!" and ":!" commands. Includes the redirection. See
'shellquote' to exclude the redirection. It's probably not useful
to set both options.
When the value is '(' then ')' is appended. When the value is '"('
then ')"' is appended.
When the value is '(' then also see 'shellxescape'.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'shiftround'
'sr'
'noshiftround'
'nosr'
'shiftround' 'sr' boolean (default off)
global
Round indent to multiple of 'shiftwidth'. Applies to > and <
commands. CTRL-T
and CTRL-D
in Insert mode always round the indent to
a multiple of 'shiftwidth' (this is Vi compatible).'shiftwidth'
'sw'
'shiftwidth' 'sw' number (default 8)
local to buffer
Number of spaces to use for each step of (auto)indent. Used for
'cindent', >>, <<, etc.
When zero the 'tabstop' value will be used. Use the shiftwidth()
function to get the effective shiftwidth value.'shortmess'
'shm'
E1336
'shortmess' 'shm' string (default "ltToOCF")
global
This option helps to avoid all the hit-enter prompts caused by file
messages, for example with CTRL-G
, and to avoid some other messages.
It is a list of flags:
shm-l
m use "[+]" instead of "[Modified]" shm-m
shm-r
shm-w
and "[a]" instead of "appended" for ':w >> file' command
a all of the above abbreviations shm-a
shm-o
message for reading a file (useful for ":wn" or when
'autowrite' on)
O message for reading a file overwrites any previous shm-O
message; also for quickfix message (e.g., ":cn")
s don't give "search hit BOTTOM, continuing at TOP" or shm-s
"search hit TOP, continuing at BOTTOM" messages; when using
the search count do not show "W" before the count message
(see shm-S below)
t truncate file message at the start if it is too long shm-t
to fit on the command-line, "<" will appear in the left most
column; ignored in Ex mode
T truncate other messages in the middle if they are too shm-T
long to fit on the command line; "..." will appear in the
middle; ignored in Ex mode
W don't give "written" or "[w]" when writing a file shm-W
A don't give the "ATTENTION" message when an existing shm-A
swap file is found
I don't give the intro message when starting Vim, shm-I
shm-c
shm-C
items, for instance "scanning tags"
q do not show "recording @a" when recording a macro shm-q
F don't give the file info when editing a file, like shm-F
:silent
was used for the command; note that this also
affects messages from 'autoread' reloading
S do not show search count message when searching, e.g. shm-S
"[1/5]". When the "S" flag is not present (e.g. search count
is shown), the "search hit BOTTOM, continuing at TOP" and
"search hit TOP, continuing at BOTTOM" messages are only
indicated by a "W" (Mnemonic: Wrapped) letter before the
search count statistics.<Enter>
, but still gives as useful a message as
possible for the space available. To get the whole message that you
would have got with 'shm' empty, use ":file!"
Useful values:
shm= No abbreviation of message.
shm=a Abbreviation, but no loss of information.
shm=at Abbreviation, and truncate message when necessary.'showbreak'
'sbr'
E595
'showbreak' 'sbr' string (default "")
global or local to window global-local
String to put at the start of lines that have been wrapped. Useful
values are "> " or "+++ ":let &showbreak = "> "
let &showbreak = '+++ '
<Tab>
and
comma (in a future version the comma might be used to separate the
part that is shown at the end and at the start of a line).
The hl-NonText highlight group determines the highlighting.
Note that tabs after the showbreak will be displayed differently.
If you want the 'showbreak' to appear in between line numbers, add the
"n" flag to 'cpoptions'.
A window-local value overrules a global value. If the global value is
set and you want no value in the current window use NONE:setlocal showbreak=NONE
'showcmd'
'sc'
'noshowcmd'
'nosc'
'showcmd' 'sc' boolean (default on)
global
Show (partial) command in the last line of the screen. Set this
option off if your terminal is slow.
In Visual mode the size of the selected area is shown:
{lines}
x{columns}.
This information can be displayed in an alternative location using the
'showcmdloc' option, useful when 'cmdheight' is 0.
'showcmdloc'
'sloc'
'showcmdloc' 'sloc' string (default "last")
global
This option can be used to display the (partially) entered command in
another location. Possible values are:
last Last line of the screen (default).
statusline Status line of the current window.
tabline First line of the screen if 'showtabline' is enabled.
Setting this option to "statusline" or "tabline" means that these will
be redrawn whenever the command changes, which can be on every key
pressed.
The %S 'statusline' item can be used in 'statusline' or 'tabline' to
place the text. Without a custom 'statusline' or 'tabline' it will be
displayed in a convenient location.'showfulltag'
'sft'
'noshowfulltag'
'nosft'
'showfulltag' 'sft' boolean (default off)
global
When completing a word in insert mode (see ins-completion) from the
tags file, show both the tag name and a tidied-up form of the search
pattern (if there is one) as possible matches. Thus, if you have
matched a C function, you can see a template for what arguments are
required (coding style permitting).
Note that this doesn't work well together with having "longest" in
'completeopt', because the completion from the search pattern may not
match the typed text.'showmatch'
'sm'
'noshowmatch'
'nosm'
'showmatch' 'sm' boolean (default off)
global
When a bracket is inserted, briefly jump to the matching one. The
jump is only done if the match can be seen on the screen. The time to
show the match can be set with 'matchtime'.
A Beep is given if there is no match (no matter if the match can be
seen or not).
When the 'm' flag is not included in 'cpoptions', typing a character
will immediately move the cursor back to where it belongs.
See the "sm" field in 'guicursor' for setting the cursor shape and
blinking when showing the match.
The 'matchpairs' option can be used to specify the characters to show
matches for. 'rightleft' and 'revins' are used to look for opposite
matches.
Also see the matchparen plugin for highlighting the match when moving
around pi_paren.txt.
Note: Use of the short form is rated PG.'showmode'
'smd'
'noshowmode'
'nosmd'
'showmode' 'smd' boolean (default on)
global
If in Insert, Replace or Visual mode put a message on the last line.
The hl-ModeMsg highlight group determines the highlighting.
The option has no effect when 'cmdheight' is zero.'showtabline'
'stal'
'showtabline' 'stal' number (default 1)
global
The value of this option specifies when the line with tab page labels
will be displayed:
0: never
1: only if there are at least two tab pages
2: always
This is both for the GUI and non-GUI implementation of the tab pages
line.
See tab-page for more information about tab pages.'sidescroll'
'ss'
'sidescroll' 'ss' number (default 1)
global
The minimal number of columns to scroll horizontally. Used only when
the 'wrap' option is off and the cursor is moved off of the screen.
When it is zero the cursor will be put in the middle of the screen.
When using a slow terminal set it to a large number or 0. Not used
for "zh" and "zl" commands.'sidescrolloff'
'siso'
'sidescrolloff' 'siso' number (default 0)
global or local to window global-local
The minimal number of screen columns to keep to the left and to the
right of the cursor if 'nowrap' is set. Setting this option to a
value greater than 0 while having 'sidescroll' also at a non-zero
value makes some context visible in the line you are scrolling in
horizontally (except at beginning of the line). Setting this option
to a large value (like 999) has the effect of keeping the cursor
horizontally centered in the window, as long as one does not come too
close to the beginning of the line.
After using the local value, go back the global value with one of
these two:setlocal sidescrolloff<
setlocal sidescrolloff=-1
set nowrap sidescroll=1 listchars=extends:>,precedes:<
set sidescrolloff=1
'signcolumn'
'scl'
'signcolumn' 'scl' string (default "auto")
local to window
When and how to draw the signcolumn. Valid values are:
"auto" only when there is a sign to display
"auto:[1-9]" resize to accommodate multiple signs up to the
given number (maximum 9), e.g. "auto:4"
"auto:[1-8]-[2-9]"
resize to accommodate multiple signs up to the
given maximum number (maximum 9) while keeping
at least the given minimum (maximum 8) fixed
space. The minimum number should always be less
than the maximum number, e.g. "auto:2-5"
"no" never
"yes" always
"yes:[1-9]" always, with fixed space for signs up to the given
number (maximum 9), e.g. "yes:3"
"number" display signs in the 'number' column. If the number
column is not present, then behaves like "auto".'smartcase'
'scs'
'nosmartcase'
'noscs'
'smartcase' 'scs' boolean (default off)
global
Override the 'ignorecase' option if the search pattern contains upper
case characters. Only used when the search pattern is typed and
'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
"*" and "#" you can make 'smartcase' used by doing a "/" command,
recalling the search pattern from history and hitting <Enter>
.'smartindent'
'si'
'nosmartindent'
'nosi'
'smartindent' 'si' boolean (default off)
local to buffer
Do smart autoindenting when starting a new line. Works for C-like
programs, but can also be used for other languages. 'cindent' does
something like this, works better in most cases, but is more strict,
see C-indenting. When 'cindent' is on or 'indentexpr' is set,
setting 'si' has no effect. 'indentexpr' is a more advanced
alternative.
Normally 'autoindent' should also be on when using 'smartindent'.
An indent is automatically inserted:
CTRL-V
CTRL-H
.
When using the ">>" command, lines starting with '#' are not shifted
right.
'smarttab'
'sta'
'nosmarttab'
'nosta'
'smarttab' 'sta' boolean (default on)
global
When on, a <Tab>
in front of a line inserts blanks according to
'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
<BS>
will delete a 'shiftwidth' worth of space at the start of the
line.
When off, a <Tab>
always inserts blanks according to 'tabstop' or
'softtabstop'. 'shiftwidth' is only used for shifting text left or
right shift-left-right.
What gets inserted (a <Tab>
or spaces) depends on the 'expandtab'
option. Also see ins-expandtab. When 'expandtab' is not set, the
number of spaces is minimized by using <Tab>
s.'smoothscroll'
'sms'
'nosmoothscroll'
'nosms'
'smoothscroll' 'sms' boolean (default off)
local to window
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
above the window. "<<<" is displayed at the start of the first line,
highlighted with hl-NonText.
You may also want to add "lastline" to the 'display' option to show as
much of the last line as possible.
NOTE: partly implemented, doesn't work yet for gj and gk.'softtabstop'
'sts'
'softtabstop' 'sts' number (default 0)
local to buffer
Number of spaces that a <Tab>
counts for while performing editing
operations, like inserting a <Tab>
or using <BS>
. It "feels" like
<Tab>
s are being inserted, while in fact a mix of spaces and <Tab>
s is
used. This is useful to keep the 'ts' setting at its standard value
of 8, while being able to edit like it is set to 'sts'. However,
commands like "x" still work on the actual characters.
When 'sts' is zero, this feature is off.
When 'sts' is negative, the value of 'shiftwidth' is used.
See also ins-expandtab. When 'expandtab' is not set, the number of
spaces is minimized by using <Tab>
s.
The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
set.'spell'
'nospell'
'spell' boolean (default off)
local to window
When on spell checking will be done. See spell.
The languages are specified with 'spelllang'.'spellcapcheck'
'spc'
'spellcapcheck' 'spc' string (default "[.?!]\_[\])'"\t ]\+")
local to buffer
Pattern to locate the end of a sentence. The following word will be
checked to start with a capital letter. If not then it is highlighted
with SpellCap hl-SpellCap (unless the word is also badly spelled).
When this check is not wanted make this option empty.
Only used when 'spell' is set.
Be careful with special characters, see option-backslash about
including spaces and backslashes.
To set this option automatically depending on the language, see
set-spc-auto.'spellfile'
'spf'
'spellfile' 'spf' string (default "")
local to buffer
Name of the word list file where words are added for the zg and zw
commands. It must end in ".{encoding}.add". You need to include the
path, otherwise the file is placed in the current directory.
The path may include characters from 'isfname', ' ', ',', '@' and ':'.
E765
'spelllang'
'spl'
'spelllang' 'spl' string (default "en")
local to buffer
A comma-separated list of word list names. When the 'spell' option is
on spellchecking will be done for these languages. Example:set spelllang=en_us,nl,medical
E757
'spelloptions'
'spo'
'spelloptions' 'spo' string (default "")
local to buffer
A comma-separated list of options for spell checking:
camel When a word is CamelCased, assume "Cased" is a
separate word: every upper-case character in a word
that comes after a lower case character indicates the
start of a new word.
noplainbuffer Only spellcheck a buffer when 'syntax' is enabled,
or when extmarks are set within the buffer. Only
designated regions of the buffer are spellchecked in
this case.'spellsuggest'
'sps'
'spellsuggest' 'sps' string (default "best")
global
Methods used for spelling suggestions. Both for the z= command and
the spellsuggest() function. This is a comma-separated list of
items:{number}
The maximum number of suggestions listed for z=.
Not used for spellsuggest(). The number of
suggestions is never more than the value of 'lines'
minus two.{millisec}
milliseconds. Applies to the following
methods. When omitted the limit is 5000. When
negative there is no limit.{filename}
, which must have two columns,
separated by a slash. The first column contains the
bad word, the second column the suggested good word.
Example:
{expr}
. Use a function to avoid
trouble with spaces. Best is to call a function
without arguments, see expr-option-function.
v:val holds the badly spelled word. The expression
must evaluate to a List of Lists, each with a
suggestion and a score.
Example:
set sps=file:~/.config/nvim/sugg,best,expr:MySuggest()
'splitbelow'
'sb'
'nosplitbelow'
'nosb'
'splitbelow' 'sb' boolean (default off)
global
When on, splitting a window will put the new window below the current
one. :split'splitkeep'
'spk'
'splitkeep' 'spk' string (default "cursor")
global
The value of this option determines the scroll behavior when opening,
closing or resizing horizontal splits.'splitright'
'spr'
'nosplitright'
'nospr'
'splitright' 'spr' boolean (default off)
global
When on, splitting a window will put the new window right of the
current one. :vsplit'startofline'
'sol'
'nostartofline'
'nosol'
'startofline' 'sol' boolean (default off)
global
When "on" the commands listed below move the cursor to the first
non-blank of the line. When off the cursor is kept in the same column
(if possible). This applies to the commands:
CTRL-D
, CTRL-U
, CTRL-B
, CTRL-F
, "G", "H", "M", "L", "gg"
CTRL-^
, :bnext, :bNext, etc.)
'statuscolumn'
'stc'
'statuscolumn' 'stc' string (default "")
local to window
EXPERIMENTAL
When non-empty, this option determines the content of the area to the
side of a window, normally containing the fold, sign and number columns.
The format of this option is like that of 'statusline'." Line number with bar separator and click handlers:
set statuscolumn=%@SignCb@%s%=%T%@NumCb@%l│%T
" Line numbers in hexadecimal for non wrapped part of lines:
let &stc='%=%{v:virtnum>0?"":printf("%x",v:lnum)} '
" Human readable line numbers with thousands separator:
let &stc='%{substitute(v:lnum,"\\d\\zs\\ze\\'
. '%(\\d\\d\\d\\)\\+$",",","g")}'
" Both relative and absolute line numbers with different
" highlighting for odd and even relative numbers:
let &stc='%#NonText#%{&nu?v:lnum:""}' .
'%=%{&rnu&&(v:lnum%2)?"\ ".v:relnum:""}' .
'%#LineNr#%{&rnu&&!(v:lnum%2)?"\ ".v:relnum:""}'
'statusline'
'stl'
E540
E542
'statusline' 'stl' string (default "")
global or local to window global-local
When non-empty, this option determines the content of the status line.
Also see status-line.{item}
are optional. A single percent sign can
be given as "%%".set statusline=%!MyStatusLine()
g:statusline_winid
variable will be set to the window-ID of the
window that the status line belongs to.
The result can contain %{} items that will be evaluated too.
Note that the "%!" expression is evaluated in the context of the
current window and buffer, while %{} items are evaluated in the
context of the window that the statusline belongs to.{current}
of {max}
)
Empty if the argument file count is zero or one.
{ NF Evaluate expression between "%{" and "}" and substitute result.
Note that there is no "%" before the closing "}". The
expression cannot contain a "}" character, call a function to
work around that. See stl-%{ below.
{%
- This is almost same as "{" except the result of the expression is
re-evaluated as a statusline format string. Thus if the
return value of expr contains "%" items they will get expanded.
The expression can contain the "}" character, the end of
expression is denoted by "%}".
For example:func! Stl_filename() abort
return "%t"
endfunc
stl=%{Stl_filename()}
results in "%t"
stl=%{%Stl_filename()%}
results in "Name of current file"
%} - End of "{%" expression
( - Start of item group. Can be used for setting the width and
alignment of a section. Must be followed by %) somewhere.
) - End of item group. No width fields allowed.
T N For 'tabline': start of tab page N label. Use %T or %X to end
the label. Clicking this label with left mouse button switches
to the specified tab page, while clicking it with middle mouse
button closes the specified tab page.
X N For 'tabline': start of close tab N label. Use %X or %T to end
the label, e.g.: %3Xclose%X. Use %999X for a "close current
tab" label. Clicking this label with left mouse button closes
the specified tab page.
@ N Start of execute function label. Use %X or %T to end the label,
e.g.: %10@[email protected]%X. Clicking this label runs the
specified function: in the example when clicking once using left
mouse button on "foo.c", a SwitchBuffer(10, 1, 'l', ' ')
expression will be run. The specified function receives the
following arguments in order:
1. minwid field value or zero if no N was specified
2. number of mouse clicks to detect multiple clicks
3. mouse button used: "l", "r" or "m" for left, right or middle
button respectively; one should not rely on third argument
being only "l", "r" or "m": any other non-empty string value
that contains only ASCII lower case letters may be expected
for other mouse buttons
4. modifiers pressed: string which contains "s" if shift
modifier was pressed, "c" for control, "a" for alt and "m"
for meta; currently if modifier is not pressed string
contains space instead, but one should not rely on presence
of spaces or specific order of modifiers: use stridx() to
test whether some modifier is present; string is guaranteed
to contain only ASCII letters and spaces, one letter per
modifier; "?" modifier may also be present, but its presence
is a bug that denotes that new mouse button recognition was
added without modifying code that reacts on mouse clicks on
this label.
Use getmousepos().winid in the specified function to get the
corresponding window id of the clicked item.
< - Where to truncate line if too long. Default is at the start.
No width fields allowed.
= - Separation point between alignment sections. Each section will
be separated by an equal number of spaces. With one %= what
comes after it will be right-aligned. With two %= there is a
middle part, with white space left and right of it.
No width fields allowed.
# - Set highlight group. The name must follow and then a # again.
Thus use %#HLname# for highlight group HLname. The same
highlighting is used, also for the statusline of non-current
windows.
* - Set highlight group to User{N}, where {N}
is taken from the
minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
The difference between User{N} and StatusLine will be applied to
StatusLineNC for the statusline of non-current windows.
The number N must be between 1 and 9. See hl-User1..9set statusline=...%(\ [%M%R%H]%)...
stl-%{
g:actual_curbuf
g:actual_curwin
While evaluating %{} the current buffer and current window will be set
temporarily to that of the window (and buffer) whose statusline is
currently being drawn. The expression will evaluate in this context.
The variable "g:actual_curbuf" is set to the bufnr()
number of the
real current buffer and "g:actual_curwin" to the window-ID of the
real current window. These values are strings.:redrawstatus
.set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
let b:gzflag = 1
unlet b:gzflag
function VarExists(var, val)
if exists(a:var) | return a:val | else | return '' | endif
endfunction
'suffixes'
'su'
'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
global
Files with these suffixes get a lower priority when multiple files
match a wildcard. See suffixes. Commas can be used to separate the
suffixes. Spaces after the comma are ignored. A dot is also seen as
the start of a suffix. To avoid a dot or comma being recognized as a
separator, precede it with a backslash (see option-backslash about
including spaces and backslashes).
See 'wildignore' for completely ignoring files.
The use of :set+= and :set-= is preferred when adding or removing
suffixes from the list. This avoids problems when a future version
uses another default.'suffixesadd'
'sua'
'suffixesadd' 'sua' string (default "")
local to buffer
Comma-separated list of suffixes, which are used when searching for a
file for the "gf", "[I", etc. commands. Example:set suffixesadd=.java
'swapfile'
'swf'
'noswapfile'
'noswf'
'swapfile' 'swf' boolean (default on)
local to buffer
Use a swapfile for the buffer. This option can be reset when a
swapfile is not wanted for a specific buffer. For example, with
confidential information that even root must not be able to access.
Careful: All text will be in memory:
'switchbuf'
'swb'
'switchbuf' 'swb' string (default "uselast")
global
This option controls the behavior when switching between buffers.
This option is checked, when
'synmaxcol'
'smc'
'synmaxcol' 'smc' number (default 3000)
local to buffer
Maximum column in which to search for syntax items. In long lines the
text after this column is not highlighted and following lines may not
be highlighted correctly, because the syntax state is cleared.
This helps to avoid very slow redrawing for an XML file that is one
long line.
Set to zero to remove the limit.'syntax'
'syn'
'syntax' 'syn' string (default "")
local to buffer local-noglobal
When this option is set, the syntax with this name is loaded, unless
syntax highlighting has been switched off with ":syntax off".
Otherwise this option does not always reflect the current syntax (the
b:current_syntax variable does).
This option is most useful in a modeline, for a file which syntax is
not automatically recognized. Example, in an IDL file:/* vim: set syntax=idl : */
/* vim: set syntax=c.doxygen : */
set syntax=OFF
set syntax=ON
'tabclose'
'tcl'
'tabclose' 'tcl' string (default "")
global
This option controls the behavior when closing tab pages (e.g., using
:tabclose). When empty Vim goes to the next (right) tab page.'tabline'
'tal'
'tabline' 'tal' string (default "")
global
When non-empty, this option determines the content of the tab pages
line at the top of the Vim window. When empty Vim will use a default
tab pages line. See setting-tabline for more info.'tabpagemax'
'tpm'
'tabpagemax' 'tpm' number (default 50)
global
Maximum number of tab pages to be opened by the -p command line
argument or the ":tab all" command. tabpage'tabstop'
'ts'
'tabstop' 'ts' number (default 8)
local to buffer
Number of spaces that a <Tab>
in the file counts for. Also see
the :retab command, and the 'softtabstop' option.<Tab>
and <BS>
will
behave like a tab appears every 4 (or 3) characters.
This is the recommended way, the file will look the same with other
tools and when listing it in a terminal.
2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
'expandtab'. This way you will always insert spaces. The
formatting will never be messed up when 'tabstop' is changed (leave
it at 8 just in case). The file will be a bit larger.
You do need to check if no Tabs exist in the file. You can get rid
of them by first setting 'expandtab' and using %retab!
, making
sure the value of 'tabstop' is set correctly.
3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
'expandtab'. This way you will always insert spaces. The
formatting will never be messed up when 'tabstop' is changed.
You do need to check if no Tabs exist in the file, just like in the
item just above.
4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
modeline to set these values when editing the file again. Only
works when using Vim to edit the file, other tools assume a tabstop
is worth 8 spaces.
5. Always set 'tabstop' and 'shiftwidth' to the same value, and
'noexpandtab'. This should then work (for initial indents only)
for any tabstop setting that people use. It might be nice to have
tabs after the first non-blank inserted as spaces if you do this
though. Otherwise aligned comments will be wrong when 'tabstop' is
changed.'tagbsearch'
'tbs'
'notagbsearch'
'notbs'
'tagbsearch' 'tbs' boolean (default on)
global
When searching for a tag (e.g., for the :ta command), Vim can either
use a binary search or a linear search in a tags file. Binary
searching makes searching for a tag a LOT faster, but a linear search
will find more tags if the tags file wasn't properly sorted.
Vim normally assumes that your tags files are sorted, or indicate that
they are not sorted. Only when this is not the case does the
'tagbsearch' option need to be switched off.!_TAG_FILE_SORTED 0 /some comment/
<Tab>
]'tagcase'
'tc'
'tagcase' 'tc' string (default "followic")
global or local to buffer global-local
This option specifies how case is handled when searching the tags
file:
followic Follow the 'ignorecase' option
followscs Follow the 'smartcase' and 'ignorecase' options
ignore Ignore case
match Match case
smart Ignore case unless an upper case letter is used'tagfunc'
'tfu'
'tagfunc' 'tfu' string (default "")
local to buffer
This option specifies a function to be used to perform tag searches.
The function gets the tag pattern and should return a List of matching
tags. See tag-function for an explanation of how to write the
function and an example. The value can be the name of a function, a
lambda or a Funcref. See option-value-function for more
information.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'taglength'
'tl'
'taglength' 'tl' number (default 0)
global
If non-zero, tags are significant up to this number of characters.'tagrelative'
'tr'
'notagrelative'
'notr'
'tagrelative' 'tr' boolean (default on)
global
If on and using a tags file in another directory, file names in that
tags file are relative to the directory where the tags file is.'tags'
'tag'
E433
'tags' 'tag' string (default "./tags;,tags")
global or local to buffer global-local
Filenames for the tag command, separated by spaces or commas. To
include a space or comma in a file name, precede it with backslashes
(see option-backslash about including spaces/commas and backslashes).
When a file name starts with "./", the '.' is replaced with the path
of the current file. But only when the 'd' flag is not included in
'cpoptions'. Environment variables are expanded :set_env. Also see
tags-option.
"*", "**" and other wildcards can be used to search for tags files in
a directory tree. See file-searching. E.g., "/lib/**/tags" will
find all files named "tags" below "/lib". The filename itself cannot
contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
files called "tags?".
The tagfiles() function can be used to get a list of the file names
actually used.
The use of :set+= and :set-= is preferred when adding or removing
file names from the list. This avoids problems when a future version
uses another default.'tagstack'
'tgst'
'notagstack'
'notgst'
'tagstack' 'tgst' boolean (default on)
global
When on, the tagstack is used normally. When off, a ":tag" or
":tselect" command with an argument will not push the tag onto the
tagstack. A following ":tag" without an argument, a ":pop" command or
any other command that uses the tagstack will use the unmodified
tagstack, but does change the pointer to the active entry.
Resetting this option is useful when using a ":tag" command in a
mapping which should not change the tagstack.'termbidi'
'tbidi'
'notermbidi'
'notbidi'
'termbidi' 'tbidi' boolean (default off)
global
The terminal is in charge of Bi-directionality of text (as specified
by Unicode). The terminal is also expected to do the required shaping
that some languages (such as Arabic) require.
Setting this option implies that 'rightleft' will not be set when
'arabic' is set and the value of 'arabicshape' will be ignored.
Note that setting 'termbidi' has the immediate effect that
'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
For further details see arabic.txt.'termguicolors'
'tgc'
'notermguicolors'
'notgc'
'termguicolors' 'tgc' boolean (default off)
global
Enables 24-bit RGB color in the TUI. Uses "gui" :highlight
attributes instead of "cterm" attributes. guifg
Requires an ISO-8613-3 compatible terminal.'termpastefilter'
'tpf'
'termpastefilter' 'tpf' string (default "BS,HT,ESC,DEL")
global
A comma-separated list of options for specifying control characters
to be removed from the text pasted into the terminal window. The
supported values are:'termsync'
'notermsync'
'termsync' boolean (default on)
global
If the host terminal supports it, buffer all screen updates
made during a redraw cycle so that each screen is displayed in
the terminal all at once. This can prevent tearing or flickering
when the terminal updates faster than Nvim can redraw.'textwidth'
'tw'
'textwidth' 'tw' number (default 0)
local to buffer
Maximum width of text that is being inserted. A longer line will be
broken after white space to get this width. A zero value disables
this.
When 'textwidth' is zero, 'wrapmargin' may be used. See also
'formatoptions' and ins-textwidth.
When 'formatexpr' is set it will be used to break the line.'thesaurus'
'tsr'
'thesaurus' 'tsr' string (default "")
global or local to buffer global-local
List of file names, separated by commas, that are used to lookup words
for thesaurus completion commands i_CTRL-X_CTRL-T. See
compl-thesaurus.'thesaurusfunc'
'tsrfu'
'thesaurusfunc' 'tsrfu' string (default "")
global or local to buffer global-local
This option specifies a function to be used for thesaurus completion
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.
See option-value-function for more information.'tildeop'
'top'
'notildeop'
'notop'
'tildeop' 'top' boolean (default off)
global
When on: The tilde command "~" behaves like an operator.'timeout'
'to'
'notimeout'
'noto'
'timeout' 'to' boolean (default on)
global
This option and 'timeoutlen' determine the behavior when part of a
mapped key sequence has been received. For example, if <c-f>
is
pressed and 'timeout' is set, Nvim will wait 'timeoutlen' milliseconds
for any key that can follow <c-f>
in a mapping.'timeoutlen'
'tm'
'timeoutlen' 'tm' number (default 1000)
global
Time in milliseconds to wait for a mapped sequence to complete.'title'
'notitle'
'title' boolean (default off)
global
When on, the title of the window will be set to the value of
'titlestring' (if it is not empty), or to:
filename [+=-] (path) - Nvim
Where:
filename the name of the file being edited
- indicates the file cannot be modified, 'ma' off
+ indicates the file was modified
= indicates the file is read-only
=+ indicates the file is read-only and modified
(path) is the path of the file being edited
'titlelen'
'titleold'
'titlestring'
auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
set title titlestring=%<%F%=%l/%L-%P titlelen=70
set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
'ttimeout'
'nottimeout'
'ttimeout' boolean (default on)
global
This option and 'ttimeoutlen' determine the behavior when part of a
key code sequence has been received by the TUI.<Esc>
(the \x1b byte) is received and 'ttimeout' is
set, Nvim waits 'ttimeoutlen' milliseconds for the terminal to
complete a key code sequence. If no input arrives before the timeout,
a single <Esc>
is assumed. Many TUI cursor key codes start with <Esc>
.<Esc>
.'ttimeoutlen'
'ttm'
'ttimeoutlen' 'ttm' number (default 50)
global
Time in milliseconds to wait for a key code sequence to complete. Also
used for CTRL-\
CTRL-N
and CTRL-\
CTRL-G
when part of a command has
been typed.'undodir'
'udir'
E5003
'undodir' 'udir' string (default "$XDG_STATE_HOME/nvim/undo//")
global
List of directory names for undo files, separated with commas.
See 'backupdir' for details of the format.
"." means using the directory of the file. The undo file name for
"file.txt" is ".file.txt.un~".
For other directories the file name is the full path of the edited
file, with path separators replaced with "%".
When writing: The first directory that exists is used. "." always
works, no directories after "." will be used for writing. If none of
the directories exist Nvim will attempt to create the last directory in
the list.
When reading all entries are tried to find an undo file. The first
undo file that exists is used. When it cannot be read an error is
given, no further entry is used.
See undo-persistence.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'undofile'
'udf'
'noundofile'
'noudf'
'undofile' 'udf' boolean (default off)
local to buffer
When on, Vim automatically saves undo history to an undo file when
writing a buffer to a file, and restores undo history from the same
file on buffer read.
The directory where the undo file is stored is specified by 'undodir'.
For more information about this feature see undo-persistence.
The undo file is not read when 'undoreload' causes the buffer from
before a reload to be saved for undo.
When 'undofile' is turned off the undo file is NOT deleted.'undolevels'
'ul'
'undolevels' 'ul' number (default 1000)
global or local to buffer global-local
Maximum number of changes that can be undone. Since undo information
is kept in memory, higher numbers will cause more memory to be used.
Nevertheless, a single change can already use a large amount of memory.
Set to 0 for Vi compatibility: One level of undo and "u" undoes
itself:set ul=0
CTRL-R
to repeat undo.
Also see undo-two-ways.
Set to -1 for no undo at all. You might want to do this only for the
current buffer:setlocal ul=-1
'undoreload'
'ur'
'undoreload' 'ur' number (default 10000)
global
Save the whole buffer for undo when reloading it. This applies to the
":e!" command and reloading for when the buffer changed outside of
Vim. FileChangedShell
The save only happens when this option is negative or when the number
of lines is smaller than the value of this option.
Set this option to zero to disable undo for a reload.'updatecount'
'uc'
'updatecount' 'uc' number (default 200)
global
After typing this many characters the swap file will be written to
disk. When zero, no swap file will be created at all (see chapter on
recovery crash-recovery). 'updatecount' is set to zero by starting
Vim with the "-n" option, see startup. When editing in readonly
mode this option will be initialized to 10000.
The swapfile can be disabled per buffer with 'swapfile'.
When 'updatecount' is set from zero to non-zero, swap files are
created for all buffers that have 'swapfile' set. When 'updatecount'
is set to zero, existing swap files are not deleted.
This option has no meaning in buffers where 'buftype' is "nofile"
or "nowrite".'updatetime'
'ut'
'updatetime' 'ut' number (default 4000)
global
If this many milliseconds nothing is typed the swap file will be
written to disk (see crash-recovery). Also used for the
CursorHold autocommand event.'varsofttabstop'
'vsts'
'varsofttabstop' 'vsts' string (default "")
local to buffer
A list of the number of spaces that a <Tab>
counts for while editing,
such as inserting a <Tab>
or using <BS>
. It "feels" like variable-
width <Tab>
s are being inserted, while in fact a mixture of spaces
and <Tab>
s is used. Tab widths are separated with commas, with the
final value applying to all subsequent tabs.set varsofttabstop=8,32,8
'vartabstop'
'vts'
'vartabstop' 'vts' string (default "")
local to buffer
A list of the number of spaces that a <Tab>
in the file counts for,
separated by commas. Each value corresponds to one tab, with the
final value applying to all subsequent tabs. For example:set vartabstop=4,20,10,8
'verbose'
'vbs'
'verbose' 'vbs' number (default 0)
global
Sets the verbosity level. Also set by -V and :verbose.'verbosefile'
'vfile'
'verbosefile' 'vfile' string (default "")
global
When not empty all messages are written in a file with this name.
When the file exists messages are appended.
Writing to the file ends when Vim exits or when 'verbosefile' is made
empty. Writes are buffered, thus may not show up for some time.
Setting 'verbosefile' to a new value is like making it empty first.
The difference with :redir is that verbose messages are not
displayed when 'verbosefile' is set.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'viewdir'
'vdir'
'viewdir' 'vdir' string (default "$XDG_STATE_HOME/nvim/view//")
global
Name of the directory where to store files for :mkview.
This option cannot be set from a modeline or in the sandbox, for
security reasons.'viewoptions'
'vop'
'viewoptions' 'vop' string (default "folds,cursor,curdir")
global
Changes the effect of the :mkview command. It is a comma-separated
list of words. Each word enables saving and restoring something:
'virtualedit'
've'
'virtualedit' 've' string (default "")
global or local to window global-local
A comma-separated list of these words:
block Allow virtual editing in Visual block mode.
insert Allow virtual editing in Insert mode.
all Allow virtual editing in all modes.
onemore Allow the cursor to move just past the end of the line
none When used as the local value, do not allow virtual
editing even when the global value is set. When used
as the global value, "none" is the same as "".
NONE Alternative spelling of "none".$
command will move to the last character in the line, not
past it. This may actually move the cursor to the left!
The g$
command will move to the end of the screen line.
It doesn't make sense to combine "all" with "onemore", but you will
not get a warning for it.
When combined with other words, "none" is ignored.'visualbell'
'vb'
'novisualbell'
'novb'
'visualbell' 'vb' boolean (default off)
global
Use visual bell instead of beeping. Also see 'errorbells'.'warn'
'nowarn'
'warn' boolean (default on)
global
Give a warning message when a shell command is used while the buffer
has been changed.'whichwrap'
'ww'
'whichwrap' 'ww' string (default "b,s")
global
Allow specified keys that move the cursor left/right to move to the
previous/next line when the cursor is on the first/last character in
the line. Concatenate characters to allow this for these keys:
<BS>
Normal and Visual
s <Space>
Normal and Visual
h "h" Normal and Visual (not recommended)
l "l" Normal and Visual (not recommended)
< <Left>
Normal and Visual
> <Right>
Normal and Visual
~ "~" Normal
[ <Left>
Insert and Replace
] <Right>
Insert and Replace
For example:set ww=<,>,[,]
<EOL>
also counts for a character. This makes "3h"
different from "3dh" when the cursor crosses the end of a line. This
is also true for "x" and "X", because they do the same as "dl" and
"dh". If you use this, you may also want to use the mapping
":map <BS>
X" to make backspace delete the character in front of the
cursor.
When 'l' is included and it is used after an operator at the end of a
line (not an empty line) then it will not move to the next line. This
makes "dl", "cl", "yl" etc. work normally.'wildchar'
'wc'
'wildchar' 'wc' number (default <Tab>
)
global
Character you have to type to start wildcard expansion in the
command-line, as specified with 'wildmode'.
More info here: cmdline-completion.
The character is not recognized when used inside a macro. See
'wildcharm' for that.
Some keys will not work, such as CTRL-C
, <CR>
and Enter.
<Esc>
can be used, but hitting it twice in a row will still exit
command-line as a failsafe measure.
Although 'wc' is a number option, you can set it to a special key:set wc=<Tab>
'wildcharm'
'wcm'
'wildcharm' 'wcm' number (default 0)
global
'wildcharm' works exactly like 'wildchar', except that it is
recognized when used inside a macro. You can find "spare" command-line
keys suitable for this option by looking at ex-edit-index. Normally
you'll never actually type 'wildcharm', just use it in mappings that
automatically invoke completion mode, e.g.:set wcm=<C-Z>
cnoremap ss so $vim/sessions/*.vim<C-Z>
CTRL-P
& CTRL-N
.'wildignore'
'wig'
'wildignore' 'wig' string (default "")
global
A list of file patterns. A file that matches with one of these
patterns is ignored when expanding wildcards, completing file or
directory names, and influences the result of expand(), glob() and
globpath() unless a flag is passed to disable this.
The pattern is used like with :autocmd, see autocmd-pattern.
Also see 'suffixes'.
Example:set wildignore=*.o,*.obj
'wildignorecase'
'wic'
'nowildignorecase'
'nowic'
'wildignorecase' 'wic' boolean (default off)
global
When set case is ignored when completing file names and directories.
Has no effect when 'fileignorecase' is set.
Does not apply when the shell is used to expand wildcards, which
happens when there are special characters.'wildmenu'
'wmnu'
'nowildmenu'
'nowmnu'
'wildmenu' 'wmnu' boolean (default on)
global
When 'wildmenu' is on, command-line completion operates in an enhanced
mode. On pressing 'wildchar' (usually <Tab>
) to invoke completion,
the possible matches are shown.
When 'wildoptions' contains "pum", then the completion matches are
shown in a popup menu. Otherwise they are displayed just above the
command line, with the first match highlighted (overwriting the status
line, if there is one).
Keys that show the previous/next match, such as <Tab>
or
CTRL-P
/CTRL-N, cause the highlight to move to the appropriate match.
'wildmode' must specify "full": "longest" and "list" do not start
'wildmenu' mode. You can check the current mode with wildmenumode().
The menu is cancelled when a key is hit that is not used for selecting
a completion.CTRL-P
- go to the previous entry
CTRL-N
- go to the next entry
<Left>
<Right>
- select previous/next match (like CTRL-P
/CTRL-N)
<PageUp>
- select a match several entries back
<PageDown>
- select a match several entries further
<Up>
- in filename/menu name completion: move up into
parent directory or parent menu.
<Down>
- in filename/menu name completion: move into a
subdirectory or submenu.
<CR>
- in menu completion, when the cursor is just after a
dot: move into a submenu.
CTRL-E
- end completion, go back to what was there before
selecting a match.
CTRL-Y
- accept the currently selected match and stop
completion.<Left>
and <Right>
to move the cursor instead of selecting
a different match, use this:cnoremap <Left> <Space><BS><Left>
cnoremap <Right> <Space><BS><Right>
'wildmode'
'wim'
'wildmode' 'wim' string (default "full")
global
Completion mode that is used for the character specified with
'wildchar'. It is a comma-separated list of up to four parts. Each
part specifies what to do for each consecutive use of 'wildchar'. The
first part specifies the behavior for the first use of 'wildchar',
The second part for the second use, etc.set wildmode=full
set wildmode=longest,full
set wildmode=list:full
set wildmode=list,full
set wildmode=longest,list
'wildoptions'
'wop'
'wildoptions' 'wop' string (default "pum,tagfile")
global
A list of words that change how cmdline-completion is done.
The following values are supported:
fuzzy Use fuzzy-matching to find completion matches. When
this value is specified, wildcard expansion will not
be used for completion. The matches will be sorted by
the "best match" rather than alphabetically sorted.
This will find more matches than the wildcard
expansion. Currently fuzzy matching based completion
is not supported for file and directory names and
instead wildcard expansion is used.
pum Display the completion matches using the popup menu
in the same style as the ins-completion-menu.
tagfile When using CTRL-D
to list matching tags, the kind of
tag and the file of the tag is listed. Only one match
is displayed per line. Often used tag kinds are:
d #define
f function'winaltkeys'
'wak'
'winaltkeys' 'wak' string (default "menu")
global
only used in Win32
Some GUI versions allow the access to menu entries by using the ALT
key in combination with a character that appears underlined in the
menu. This conflicts with the use of the ALT key for mappings and
entering special characters. This option tells what to do:
no Don't use ALT keys for menus. ALT key combinations can be
mapped, but there is no automatic handling.
yes ALT key handling is done by the windowing system. ALT key
combinations cannot be mapped.
menu Using ALT in combination with a character that is a menu
shortcut key, will be handled by the windowing system. Other
keys can be mapped.
If the menu is disabled by excluding 'm' from 'guioptions', the ALT
key is never used for the menu.
This option is not used for <F10>
; on Win32.'winbar'
'wbr'
'winbar' 'wbr' string (default "")
global or local to window global-local
When non-empty, this option enables the window bar and determines its
contents. The window bar is a bar that's shown at the top of every
window with it enabled. The value of 'winbar' is evaluated like with
'statusline'.'winblend'
'winbl'
'winblend' 'winbl' number (default 0)
local to window
Enables pseudo-transparency for a floating window. Valid values are in
the range of 0 for fully opaque window (disabled) to 100 for fully
transparent background. Values between 0-30 are typically most useful.'window'
'wi'
'window' 'wi' number (default screen height - 1)
global
Window height used for CTRL-F and CTRL-B when there is only one
window and the value is smaller than 'lines' minus one. The screen
will scroll 'window' minus two lines, with a minimum of one.
When 'window' is equal to 'lines' minus one CTRL-F
and CTRL-B
scroll
in a much smarter way, taking care of wrapping lines.
When resizing the Vim window, and the value is smaller than 1 or more
than or equal to 'lines' it will be set to 'lines' minus 1.
Note: Do not confuse this with the height of the Vim window, use
'lines' for that.'winfixbuf'
'wfb'
'nowinfixbuf'
'nowfb'
'winfixbuf' 'wfb' boolean (default off)
local to window
If enabled, the window and the buffer it is displaying are paired.
For example, attempting to change the buffer with :edit will fail.
Other commands which change a window's buffer such as :cnext will
also skip any window with 'winfixbuf' enabled. However if an Ex
command has a "!" modifier, it can force switching buffers.'winfixheight'
'wfh'
'nowinfixheight'
'nowfh'
'winfixheight' 'wfh' boolean (default off)
local to window local-noglobal
Keep the window height when windows are opened or closed and
'equalalways' is set. Also for CTRL-W_=. Set by default for the
preview-window and quickfix-window.
The height may be changed anyway when running out of room.'winfixwidth'
'wfw'
'nowinfixwidth'
'nowfw'
'winfixwidth' 'wfw' boolean (default off)
local to window local-noglobal
Keep the window width when windows are opened or closed and
'equalalways' is set. Also for CTRL-W_=.
The width may be changed anyway when running out of room.'winheight'
'wh'
E591
'winheight' 'wh' number (default 1)
global
Minimal number of lines for the current window. This is not a hard
minimum, Vim will use fewer lines if there is not enough room. If the
focus goes to a window that is smaller, its size is increased, at the
cost of the height of other windows.
Set 'winheight' to a small number for normal editing.
Set it to 999 to make the current window fill most of the screen.
Other windows will be only 'winminheight' high. This has the drawback
that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
to create only two windows, set the option after startup is done,
using the VimEnter event:au VimEnter * set winheight=999
'winhighlight'
'winhl'
'winhighlight' 'winhl' string (default "")
local to window
Window-local highlights. Comma-delimited list of highlight
group-name pairs "{hl-from}:{hl-to},..." where each {hl-from}
is
a highlight-groups item to be overridden by {hl-to}
group in
the window.set winhighlight=Normal:MyNormal,NormalNC:MyNormalNC
'winminheight'
'wmh'
'winminheight' 'wmh' number (default 1)
global
The minimal height of a window, when it's not the current window.
This is a hard minimum, windows will never become smaller.
When set to zero, windows may be "squashed" to zero lines (i.e. just a
status bar) if necessary. They will return to at least one line when
they become active (since the cursor has to have somewhere to go.)
Use 'winheight' to set the minimal height of the current window.
This option is only checked when making a window smaller. Don't use a
large number, it will cause errors when opening more than a few
windows. A value of 0 to 3 is reasonable.'winminwidth'
'wmw'
'winminwidth' 'wmw' number (default 1)
global
The minimal width of a window, when it's not the current window.
This is a hard minimum, windows will never become smaller.
When set to zero, windows may be "squashed" to zero columns (i.e. just
a vertical separator) if necessary. They will return to at least one
line when they become active (since the cursor has to have somewhere
to go.)
Use 'winwidth' to set the minimal width of the current window.
This option is only checked when making a window smaller. Don't use a
large number, it will cause errors when opening more than a few
windows. A value of 0 to 12 is reasonable.'winwidth'
'wiw'
E592
'winwidth' 'wiw' number (default 20)
global
Minimal number of columns for the current window. This is not a hard
minimum, Vim will use fewer columns if there is not enough room. If
the current window is smaller, its size is increased, at the cost of
the width of other windows. Set it to 999 to make the current window
always fill the screen. Set it to a small number for normal editing.
The width is not adjusted after one of the commands to change the
width of the current window.
'winwidth' applies to the current window. Use 'winminwidth' to set
the minimal width for other windows.'wrap'
'nowrap'
'wrap' boolean (default on)
local to window
This option changes how text is displayed. It doesn't change the text
in the buffer, see 'textwidth' for that.
When on, lines longer than the width of the window will wrap and
displaying continues on the next line. When off lines will not wrap
and only part of long lines will be displayed. When the cursor is
moved to a part that is not shown, the screen will scroll
horizontally.
The line will be broken in the middle of a word if necessary. See
'linebreak' to get the break at a word boundary.
To make scrolling horizontally a bit more useful, try this:set sidescroll=5
set listchars+=precedes:<,extends:>
'wrapmargin'
'wm'
'wrapmargin' 'wm' number (default 0)
local to buffer
Number of characters from the right window border where wrapping
starts. When typing text beyond this limit, an <EOL>
will be inserted
and inserting continues on the next line.
Options that add a margin, such as 'number' and 'foldcolumn', cause
the text width to be further reduced.
When 'textwidth' is non-zero, this option is not used.
See also 'formatoptions' and ins-textwidth.'wrapscan'
'ws'
'nowrapscan'
'nows'
E384
E385
'wrapscan' 'ws' boolean (default on)
global
Searches wrap around the end of the file. Also applies to ]s and
[s, searching for spelling mistakes.'write'
'nowrite'
'write' boolean (default on)
global
Allows writing files. When not set, writing a file is not allowed.
Can be used for a view-only mode, where modifications to the text are
still allowed. Can be reset with the -m or -M command line
argument. Filtering text is still possible, even though this requires
writing a temporary file.'writeany'
'wa'
'nowriteany'
'nowa'
'writeany' 'wa' boolean (default off)
global
Allows writing to any file with no need for "!" override.'writebackup'
'wb'
'nowritebackup'
'nowb'
'writebackup' 'wb' boolean (default on)
global
Make a backup before overwriting a file. The backup is removed after
the file was successfully written, unless the 'backup' option is
also on.
WARNING: Switching this option off means that when Vim fails to write
your buffer correctly and then, for whatever reason, Vim exits, you
lose both the original file and what you were writing. Only reset
this option if your file system is almost full and it makes the write
fail (and make sure not to exit Vim until the write was successful).
See backup-table for another explanation.
When the 'backupskip' pattern matches, a backup is not made anyway.
Depending on 'backupcopy' the backup is a new file or the original
file renamed (and a new file is written).'writedelay'
'wd'
'writedelay' 'wd' number (default 0)
global
Only takes effect together with 'redrawdebug'.
The number of milliseconds to wait after each line or each flush