mirror of
https://github.com/neovim/neovim.git
synced 2024-12-19 02:34:59 -07:00
docs: move vim-variables to separate file
This commit is contained in:
Lewis Russell
Lewis Russell
parent
d431a4d410
commit
a8935d97ac
@ -1765,624 +1765,9 @@ variables for each buffer. Use local buffer variables instead |b:var|.
|
||||
|
||||
PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:*
|
||||
*E963*
|
||||
Some variables can be set by the user, but the type cannot be changed.
|
||||
|
||||
*v:argv* *argv-variable*
|
||||
v:argv The command line arguments Vim was invoked with. This is a
|
||||
list of strings. The first item is the Vim command.
|
||||
See |v:progpath| for the command with full path.
|
||||
|
||||
*v:char* *char-variable*
|
||||
v:char Argument for evaluating 'formatexpr' and used for the typed
|
||||
character when using <expr> in an abbreviation |:map-<expr>|.
|
||||
It is also used by the |InsertCharPre| and |InsertEnter| events.
|
||||
|
||||
*v:charconvert_from* *charconvert_from-variable*
|
||||
v:charconvert_from
|
||||
The name of the character encoding of a file to be converted.
|
||||
Only valid while evaluating the 'charconvert' option.
|
||||
|
||||
*v:charconvert_to* *charconvert_to-variable*
|
||||
v:charconvert_to
|
||||
The name of the character encoding of a file after conversion.
|
||||
Only valid while evaluating the 'charconvert' option.
|
||||
|
||||
*v:cmdarg* *cmdarg-variable*
|
||||
v:cmdarg
|
||||
The extra arguments ("++p", "++enc=", "++ff=") given to a file
|
||||
read/write command. This is set before an autocommand event
|
||||
for a file read/write command is triggered. There is a
|
||||
leading space to make it possible to append this variable
|
||||
directly after the read/write command. Note: "+cmd" isn't
|
||||
included here, because it will be executed anyway.
|
||||
|
||||
*v:collate* *collate-variable*
|
||||
v:collate The current locale setting for collation order of the runtime
|
||||
environment. This allows Vim scripts to be aware of the
|
||||
current locale encoding. Technical: it's the value of
|
||||
LC_COLLATE. When not using a locale the value is "C".
|
||||
This variable can not be set directly, use the |:language|
|
||||
command.
|
||||
See |multi-lang|.
|
||||
|
||||
*v:cmdbang* *cmdbang-variable*
|
||||
v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
|
||||
was used the value is 1, otherwise it is 0. Note that this
|
||||
can only be used in autocommands. For user commands |<bang>|
|
||||
can be used.
|
||||
|
||||
*v:completed_item* *completed_item-variable*
|
||||
v:completed_item
|
||||
Dictionary containing the most recent |complete-items| after
|
||||
|CompleteDone|. Empty if the completion failed, or after
|
||||
leaving and re-entering insert mode.
|
||||
Note: Plugins can modify the value to emulate the builtin
|
||||
|CompleteDone| event behavior.
|
||||
|
||||
*v:count* *count-variable*
|
||||
v:count The count given for the last Normal mode command. Can be used
|
||||
to get the count before a mapping. Read-only. Example: >
|
||||
:map _x :<C-U>echo "the count is " .. v:count<CR>
|
||||
< Note: The <C-U> is required to remove the line range that you
|
||||
get when typing ':' after a count.
|
||||
When there are two counts, as in "3d2w", they are multiplied,
|
||||
just like what happens in the command, "d6w" for the example.
|
||||
Also used for evaluating the 'formatexpr' option.
|
||||
|
||||
*v:count1* *count1-variable*
|
||||
v:count1 Just like "v:count", but defaults to one when no count is
|
||||
used.
|
||||
|
||||
*v:ctype* *ctype-variable*
|
||||
v:ctype The current locale setting for characters of the runtime
|
||||
environment. This allows Vim scripts to be aware of the
|
||||
current locale encoding. Technical: it's the value of
|
||||
LC_CTYPE. When not using a locale the value is "C".
|
||||
This variable can not be set directly, use the |:language|
|
||||
command.
|
||||
See |multi-lang|.
|
||||
|
||||
*v:dying* *dying-variable*
|
||||
v:dying Normally zero. When a deadly signal is caught it's set to
|
||||
one. When multiple signals are caught the number increases.
|
||||
Can be used in an autocommand to check if Vim didn't
|
||||
terminate normally.
|
||||
Example: >
|
||||
:au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
|
||||
< Note: if another deadly signal is caught when v:dying is one,
|
||||
VimLeave autocommands will not be executed.
|
||||
|
||||
*v:exiting* *exiting-variable*
|
||||
v:exiting Exit code, or |v:null| before invoking the |VimLeavePre|
|
||||
and |VimLeave| autocmds. See |:q|, |:x| and |:cquit|.
|
||||
Example: >
|
||||
:au VimLeave * echo "Exit value is " .. v:exiting
|
||||
<
|
||||
*v:echospace* *echospace-variable*
|
||||
v:echospace Number of screen cells that can be used for an `:echo` message
|
||||
in the last screen line before causing the |hit-enter-prompt|.
|
||||
Depends on 'showcmd', 'ruler' and 'columns'. You need to
|
||||
check 'cmdheight' for whether there are full-width lines
|
||||
available above the last line.
|
||||
|
||||
*v:errmsg* *errmsg-variable*
|
||||
v:errmsg Last given error message.
|
||||
Modifiable (can be set).
|
||||
Example: >
|
||||
:let v:errmsg = ""
|
||||
:silent! next
|
||||
:if v:errmsg != ""
|
||||
: ... handle error
|
||||
<
|
||||
*v:errors* *errors-variable* *assert-return*
|
||||
v:errors Errors found by assert functions, such as |assert_true()|.
|
||||
This is a list of strings.
|
||||
The assert functions append an item when an assert fails.
|
||||
The return value indicates this: a one is returned if an item
|
||||
was added to v:errors, otherwise zero is returned.
|
||||
To remove old results make it empty: >
|
||||
:let v:errors = []
|
||||
< If v:errors is set to anything but a list it is made an empty
|
||||
list by the assert function.
|
||||
|
||||
*v:event* *event-variable*
|
||||
v:event Dictionary of event data for the current |autocommand|. Valid
|
||||
only during the event lifetime; storing or passing v:event is
|
||||
invalid! Copy it instead: >
|
||||
au TextYankPost * let g:foo = deepcopy(v:event)
|
||||
< Keys vary by event; see the documentation for the specific
|
||||
event, e.g. |DirChanged| or |TextYankPost|.
|
||||
KEY DESCRIPTION ~
|
||||
abort Whether the event triggered during
|
||||
an aborting condition (e.g. |c_Esc| or
|
||||
|c_CTRL-C| for |CmdlineLeave|).
|
||||
chan |channel-id|
|
||||
cmdlevel Level of cmdline.
|
||||
cmdtype Type of cmdline, |cmdline-char|.
|
||||
cwd Current working directory.
|
||||
inclusive Motion is |inclusive|, else exclusive.
|
||||
scope Event-specific scope name.
|
||||
operator Current |operator|. Also set for Ex
|
||||
commands (unlike |v:operator|). For
|
||||
example if |TextYankPost| is triggered
|
||||
by the |:yank| Ex command then
|
||||
`v:event.operator` is "y".
|
||||
regcontents Text stored in the register as a
|
||||
|readfile()|-style list of lines.
|
||||
regname Requested register (e.g "x" for "xyy)
|
||||
or the empty string for an unnamed
|
||||
operation.
|
||||
regtype Type of register as returned by
|
||||
|getregtype()|.
|
||||
visual Selection is visual (as opposed to,
|
||||
e.g., via motion).
|
||||
completed_item Current selected complete item on
|
||||
|CompleteChanged|, Is `{}` when no complete
|
||||
item selected.
|
||||
height Height of popup menu on |CompleteChanged|
|
||||
width width of popup menu on |CompleteChanged|
|
||||
row Row count of popup menu on |CompleteChanged|,
|
||||
relative to screen.
|
||||
col Col count of popup menu on |CompleteChanged|,
|
||||
relative to screen.
|
||||
size Total number of completion items on
|
||||
|CompleteChanged|.
|
||||
scrollbar Is |v:true| if popup menu have scrollbar, or
|
||||
|v:false| if not.
|
||||
changed_window Is |v:true| if the event fired while
|
||||
changing window (or tab) on |DirChanged|.
|
||||
status Job status or exit code, -1 means "unknown". |TermClose|
|
||||
|
||||
*v:exception* *exception-variable*
|
||||
v:exception The value of the exception most recently caught and not
|
||||
finished. See also |v:throwpoint| and |throw-variables|.
|
||||
Example: >
|
||||
:try
|
||||
: throw "oops"
|
||||
:catch /.*/
|
||||
: echo "caught " .. v:exception
|
||||
:endtry
|
||||
< Output: "caught oops".
|
||||
|
||||
*v:false* *false-variable*
|
||||
v:false Special value used to put "false" in JSON and msgpack. See
|
||||
|json_encode()|. This value is converted to "v:false" when used
|
||||
as a String (e.g. in |expr5| with string concatenation
|
||||
operator) and to zero when used as a Number (e.g. in |expr5|
|
||||
or |expr7| when used with numeric operators). Read-only.
|
||||
|
||||
*v:fcs_reason* *fcs_reason-variable*
|
||||
v:fcs_reason The reason why the |FileChangedShell| event was triggered.
|
||||
Can be used in an autocommand to decide what to do and/or what
|
||||
to set v:fcs_choice to. Possible values:
|
||||
deleted file no longer exists
|
||||
conflict file contents, mode or timestamp was
|
||||
changed and buffer is modified
|
||||
changed file contents has changed
|
||||
mode mode of file changed
|
||||
time only file timestamp changed
|
||||
|
||||
*v:fcs_choice* *fcs_choice-variable*
|
||||
v:fcs_choice What should happen after a |FileChangedShell| event was
|
||||
triggered. Can be used in an autocommand to tell Vim what to
|
||||
do with the affected buffer:
|
||||
reload Reload the buffer (does not work if
|
||||
the file was deleted).
|
||||
edit Reload the buffer and detect the
|
||||
values for options such as
|
||||
'fileformat', 'fileencoding', 'binary'
|
||||
(does not work if the file was
|
||||
deleted).
|
||||
ask Ask the user what to do, as if there
|
||||
was no autocommand. Except that when
|
||||
only the timestamp changed nothing
|
||||
will happen.
|
||||
<empty> Nothing, the autocommand should do
|
||||
everything that needs to be done.
|
||||
The default is empty. If another (invalid) value is used then
|
||||
Vim behaves like it is empty, there is no warning message.
|
||||
|
||||
*v:fname* *fname-variable*
|
||||
v:fname When evaluating 'includeexpr': the file name that was
|
||||
detected. Empty otherwise.
|
||||
|
||||
*v:fname_in* *fname_in-variable*
|
||||
v:fname_in The name of the input file. Valid while evaluating:
|
||||
option used for ~
|
||||
'charconvert' file to be converted
|
||||
'diffexpr' original file
|
||||
'patchexpr' original file
|
||||
And set to the swap file name for |SwapExists|.
|
||||
|
||||
*v:fname_out* *fname_out-variable*
|
||||
v:fname_out The name of the output file. Only valid while
|
||||
evaluating:
|
||||
option used for ~
|
||||
'charconvert' resulting converted file [1]
|
||||
'diffexpr' output of diff
|
||||
'patchexpr' resulting patched file
|
||||
[1] When doing conversion for a write command (e.g., ":w
|
||||
file") it will be equal to v:fname_in. When doing conversion
|
||||
for a read command (e.g., ":e file") it will be a temporary
|
||||
file and different from v:fname_in.
|
||||
|
||||
*v:fname_new* *fname_new-variable*
|
||||
v:fname_new The name of the new version of the file. Only valid while
|
||||
evaluating 'diffexpr'.
|
||||
|
||||
*v:fname_diff* *fname_diff-variable*
|
||||
v:fname_diff The name of the diff (patch) file. Only valid while
|
||||
evaluating 'patchexpr'.
|
||||
|
||||
*v:folddashes* *folddashes-variable*
|
||||
v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
|
||||
fold.
|
||||
Read-only in the |sandbox|. |fold-foldtext|
|
||||
|
||||
*v:foldlevel* *foldlevel-variable*
|
||||
v:foldlevel Used for 'foldtext': foldlevel of closed fold.
|
||||
Read-only in the |sandbox|. |fold-foldtext|
|
||||
|
||||
*v:foldend* *foldend-variable*
|
||||
v:foldend Used for 'foldtext': last line of closed fold.
|
||||
Read-only in the |sandbox|. |fold-foldtext|
|
||||
|
||||
*v:foldstart* *foldstart-variable*
|
||||
v:foldstart Used for 'foldtext': first line of closed fold.
|
||||
Read-only in the |sandbox|. |fold-foldtext|
|
||||
|
||||
*v:hlsearch* *hlsearch-variable*
|
||||
v:hlsearch Variable that indicates whether search highlighting is on.
|
||||
Setting it makes sense only if 'hlsearch' is enabled. Setting
|
||||
this variable to zero acts like the |:nohlsearch| command,
|
||||
setting it to one acts like >
|
||||
let &hlsearch = &hlsearch
|
||||
< Note that the value is restored when returning from a
|
||||
function. |function-search-undo|.
|
||||
|
||||
*v:insertmode* *insertmode-variable*
|
||||
v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
|
||||
events. Values:
|
||||
i Insert mode
|
||||
r Replace mode
|
||||
v Virtual Replace mode
|
||||
|
||||
*v:key* *key-variable*
|
||||
v:key Key of the current item of a |Dictionary|. Only valid while
|
||||
evaluating the expression used with |map()| and |filter()|.
|
||||
Read-only.
|
||||
|
||||
*v:lang* *lang-variable*
|
||||
v:lang The current locale setting for messages of the runtime
|
||||
environment. This allows Vim scripts to be aware of the
|
||||
current language. Technical: it's the value of LC_MESSAGES.
|
||||
The value is system dependent.
|
||||
This variable can not be set directly, use the |:language|
|
||||
command.
|
||||
It can be different from |v:ctype| when messages are desired
|
||||
in a different language than what is used for character
|
||||
encoding. See |multi-lang|.
|
||||
|
||||
*v:lc_time* *lc_time-variable*
|
||||
v:lc_time The current locale setting for time messages of the runtime
|
||||
environment. This allows Vim scripts to be aware of the
|
||||
current language. Technical: it's the value of LC_TIME.
|
||||
This variable can not be set directly, use the |:language|
|
||||
command. See |multi-lang|.
|
||||
|
||||
*v:lnum* *lnum-variable*
|
||||
v:lnum Line number for the 'foldexpr' |fold-expr|, 'formatexpr',
|
||||
'indentexpr' and 'statuscolumn' expressions, tab page number
|
||||
for 'guitablabel' and 'guitabtooltip'. Only valid while one of
|
||||
these expressions is being evaluated. Read-only when in the
|
||||
|sandbox|.
|
||||
|
||||
*v:lua* *lua-variable*
|
||||
v:lua Prefix for calling Lua functions from expressions.
|
||||
See |v:lua-call| for more information.
|
||||
|
||||
*v:maxcol* *maxcol-variable*
|
||||
v:maxcol Maximum line length. Depending on where it is used it can be
|
||||
screen columns, characters or bytes. The value currently is
|
||||
2147483647 on all systems.
|
||||
|
||||
*v:mouse_win* *mouse_win-variable*
|
||||
v:mouse_win Window number for a mouse click obtained with |getchar()|.
|
||||
First window has number 1, like with |winnr()|. The value is
|
||||
zero when there was no mouse button click.
|
||||
|
||||
*v:mouse_winid* *mouse_winid-variable*
|
||||
v:mouse_winid |window-ID| for a mouse click obtained with |getchar()|.
|
||||
The value is zero when there was no mouse button click.
|
||||
|
||||
*v:mouse_lnum* *mouse_lnum-variable*
|
||||
v:mouse_lnum Line number for a mouse click obtained with |getchar()|.
|
||||
This is the text line number, not the screen line number. The
|
||||
value is zero when there was no mouse button click.
|
||||
|
||||
*v:mouse_col* *mouse_col-variable*
|
||||
v:mouse_col Column number for a mouse click obtained with |getchar()|.
|
||||
This is the screen column number, like with |virtcol()|. The
|
||||
value is zero when there was no mouse button click.
|
||||
|
||||
*v:msgpack_types* *msgpack_types-variable*
|
||||
v:msgpack_types Dictionary containing msgpack types used by |msgpackparse()|
|
||||
and |msgpackdump()|. All types inside dictionary are fixed
|
||||
(not editable) empty lists. To check whether some list is one
|
||||
of msgpack types, use |is| operator.
|
||||
|
||||
*v:null* *null-variable*
|
||||
v:null Special value used to put "null" in JSON and NIL in msgpack.
|
||||
See |json_encode()|. This value is converted to "v:null" when
|
||||
used as a String (e.g. in |expr5| with string concatenation
|
||||
operator) and to zero when used as a Number (e.g. in |expr5|
|
||||
or |expr7| when used with numeric operators). Read-only.
|
||||
In some places `v:null` can be used for a List, Dict, etc.
|
||||
that is not set. That is slightly different than an empty
|
||||
List, Dict, etc.
|
||||
|
||||
*v:numbermax* *numbermax-variable*
|
||||
v:numbermax Maximum value of a number.
|
||||
|
||||
*v:numbermin* *numbermin-variable*
|
||||
v:numbermin Minimum value of a number (negative).
|
||||
|
||||
*v:numbersize* *numbersize-variable*
|
||||
v:numbersize Number of bits in a Number. This is normally 64, but on some
|
||||
systems it may be 32.
|
||||
|
||||
*v:oldfiles* *oldfiles-variable*
|
||||
v:oldfiles List of file names that is loaded from the |shada| file on
|
||||
startup. These are the files that Vim remembers marks for.
|
||||
The length of the List is limited by the ' argument of the
|
||||
'shada' option (default is 100).
|
||||
When the |shada| file is not used the List is empty.
|
||||
Also see |:oldfiles| and |c_#<|.
|
||||
The List can be modified, but this has no effect on what is
|
||||
stored in the |shada| file later. If you use values other
|
||||
than String this will cause trouble.
|
||||
|
||||
*v:option_new*
|
||||
v:option_new New value of the option. Valid while executing an |OptionSet|
|
||||
autocommand.
|
||||
*v:option_old*
|
||||
v:option_old Old value of the option. Valid while executing an |OptionSet|
|
||||
autocommand. Depending on the command used for setting and the
|
||||
kind of option this is either the local old value or the
|
||||
global old value.
|
||||
*v:option_oldlocal*
|
||||
v:option_oldlocal
|
||||
Old local value of the option. Valid while executing an
|
||||
|OptionSet| autocommand.
|
||||
*v:option_oldglobal*
|
||||
v:option_oldglobal
|
||||
Old global value of the option. Valid while executing an
|
||||
|OptionSet| autocommand.
|
||||
*v:option_type*
|
||||
v:option_type Scope of the set command. Valid while executing an
|
||||
|OptionSet| autocommand. Can be either "global" or "local"
|
||||
*v:option_command*
|
||||
v:option_command
|
||||
Command used to set the option. Valid while executing an
|
||||
|OptionSet| autocommand.
|
||||
value option was set via ~
|
||||
"setlocal" |:setlocal| or ":let l:xxx"
|
||||
"setglobal" |:setglobal| or ":let g:xxx"
|
||||
"set" |:set| or |:let|
|
||||
"modeline" |modeline|
|
||||
*v:operator* *operator-variable*
|
||||
v:operator The last operator given in Normal mode. This is a single
|
||||
character except for commands starting with <g> or <z>,
|
||||
in which case it is two characters. Best used alongside
|
||||
|v:prevcount| and |v:register|. Useful if you want to cancel
|
||||
Operator-pending mode and then use the operator, e.g.: >
|
||||
:omap O <Esc>:call MyMotion(v:operator)<CR>
|
||||
< The value remains set until another operator is entered, thus
|
||||
don't expect it to be empty.
|
||||
v:operator is not set for |:delete|, |:yank| or other Ex
|
||||
commands.
|
||||
Read-only.
|
||||
|
||||
*v:prevcount* *prevcount-variable*
|
||||
v:prevcount The count given for the last but one Normal mode command.
|
||||
This is the v:count value of the previous command. Useful if
|
||||
you want to cancel Visual or Operator-pending mode and then
|
||||
use the count, e.g.: >
|
||||
:vmap % <Esc>:call MyFilter(v:prevcount)<CR>
|
||||
< Read-only.
|
||||
|
||||
*v:profiling* *profiling-variable*
|
||||
v:profiling Normally zero. Set to one after using ":profile start".
|
||||
See |profiling|.
|
||||
|
||||
*v:progname* *progname-variable*
|
||||
v:progname The name by which Nvim was invoked (with path removed).
|
||||
Read-only.
|
||||
|
||||
*v:progpath* *progpath-variable*
|
||||
v:progpath Absolute path to the current running Nvim.
|
||||
Read-only.
|
||||
|
||||
*v:register* *register-variable*
|
||||
v:register The name of the register in effect for the current normal mode
|
||||
command (regardless of whether that command actually used a
|
||||
register). Or for the currently executing normal mode mapping
|
||||
(use this in custom commands that take a register).
|
||||
If none is supplied it is the default register '"', unless
|
||||
'clipboard' contains "unnamed" or "unnamedplus", then it is
|
||||
"*" or '+'.
|
||||
Also see |getreg()| and |setreg()|
|
||||
|
||||
*v:relnum* *relnum-variable*
|
||||
v:relnum Relative line number for the 'statuscolumn' expression.
|
||||
Read-only.
|
||||
|
||||
*v:scrollstart* *scrollstart-variable*
|
||||
v:scrollstart String describing the script or function that caused the
|
||||
screen to scroll up. It's only set when it is empty, thus the
|
||||
first reason is remembered. It is set to "Unknown" for a
|
||||
typed command.
|
||||
This can be used to find out why your script causes the
|
||||
hit-enter prompt.
|
||||
|
||||
*v:servername* *servername-variable*
|
||||
v:servername Primary listen-address of Nvim, the first item returned by
|
||||
|serverlist()|. Usually this is the named pipe created by Nvim
|
||||
at |startup| or given by |--listen| (or the deprecated
|
||||
|$NVIM_LISTEN_ADDRESS| env var).
|
||||
|
||||
See also |serverstart()| |serverstop()|.
|
||||
Read-only.
|
||||
|
||||
*$NVIM*
|
||||
$NVIM is set by |terminal| and |jobstart()|, and is thus
|
||||
a hint that the current environment is a subprocess of Nvim.
|
||||
Example: >
|
||||
if $NVIM
|
||||
echo nvim_get_chan_info(v:parent)
|
||||
endif
|
||||
|
||||
< Note the contents of $NVIM may change in the future.
|
||||
|
||||
v:searchforward *v:searchforward* *searchforward-variable*
|
||||
Search direction: 1 after a forward search, 0 after a
|
||||
backward search. It is reset to forward when directly setting
|
||||
the last search pattern, see |quote/|.
|
||||
Note that the value is restored when returning from a
|
||||
function. |function-search-undo|.
|
||||
Read-write.
|
||||
|
||||
*v:shell_error* *shell_error-variable*
|
||||
v:shell_error Result of the last shell command. When non-zero, the last
|
||||
shell command had an error. When zero, there was no problem.
|
||||
This only works when the shell returns the error code to Vim.
|
||||
The value -1 is often used when the command could not be
|
||||
executed. Read-only.
|
||||
Example: >
|
||||
:!mv foo bar
|
||||
:if v:shell_error
|
||||
: echo 'could not rename "foo" to "bar"!'
|
||||
:endif
|
||||
<
|
||||
*v:statusmsg* *statusmsg-variable*
|
||||
v:statusmsg Last given status message.
|
||||
Modifiable (can be set).
|
||||
|
||||
*v:stderr* *stderr-variable*
|
||||
v:stderr |channel-id| corresponding to stderr. The value is always 2;
|
||||
use this variable to make your code more descriptive.
|
||||
Unlike stdin and stdout (see |stdioopen()|), stderr is always
|
||||
open for writing. Example: >
|
||||
:call chansend(v:stderr, "error: toaster empty\n")
|
||||
<
|
||||
*v:swapname* *swapname-variable*
|
||||
v:swapname Name of the swapfile found.
|
||||
Only valid during |SwapExists| event.
|
||||
Read-only.
|
||||
|
||||
*v:swapchoice* *swapchoice-variable*
|
||||
v:swapchoice |SwapExists| autocommands can set this to the selected choice
|
||||
for handling an existing swapfile:
|
||||
'o' Open read-only
|
||||
'e' Edit anyway
|
||||
'r' Recover
|
||||
'd' Delete swapfile
|
||||
'q' Quit
|
||||
'a' Abort
|
||||
The value should be a single-character string. An empty value
|
||||
results in the user being asked, as would happen when there is
|
||||
no SwapExists autocommand. The default is empty.
|
||||
|
||||
*v:swapcommand* *swapcommand-variable*
|
||||
v:swapcommand Normal mode command to be executed after a file has been
|
||||
opened. Can be used for a |SwapExists| autocommand to have
|
||||
another Vim open the file and jump to the right place. For
|
||||
example, when jumping to a tag the value is ":tag tagname\r".
|
||||
For ":edit +cmd file" the value is ":cmd\r".
|
||||
|
||||
*v:t_TYPE* *v:t_bool* *t_bool-variable*
|
||||
v:t_bool Value of |Boolean| type. Read-only. See: |type()|
|
||||
*v:t_dict* *t_dict-variable*
|
||||
v:t_dict Value of |Dictionary| type. Read-only. See: |type()|
|
||||
*v:t_float* *t_float-variable*
|
||||
v:t_float Value of |Float| type. Read-only. See: |type()|
|
||||
*v:t_func* *t_func-variable*
|
||||
v:t_func Value of |Funcref| type. Read-only. See: |type()|
|
||||
*v:t_list* *t_list-variable*
|
||||
v:t_list Value of |List| type. Read-only. See: |type()|
|
||||
*v:t_number* *t_number-variable*
|
||||
v:t_number Value of |Number| type. Read-only. See: |type()|
|
||||
*v:t_string* *t_string-variable*
|
||||
v:t_string Value of |String| type. Read-only. See: |type()|
|
||||
*v:t_blob* *t_blob-variable*
|
||||
v:t_blob Value of |Blob| type. Read-only. See: |type()|
|
||||
|
||||
*v:termresponse* *termresponse-variable*
|
||||
v:termresponse The value of the most recent OSC or DCS escape sequence
|
||||
received by Nvim from the terminal. This can be read in a
|
||||
|TermResponse| event handler after querying the terminal using
|
||||
another escape sequence.
|
||||
|
||||
*v:testing* *testing-variable*
|
||||
v:testing Must be set before using `test_garbagecollect_now()`.
|
||||
|
||||
*v:this_session* *this_session-variable*
|
||||
v:this_session Full filename of the last loaded or saved session file.
|
||||
Empty when no session file has been saved. See |:mksession|.
|
||||
Modifiable (can be set).
|
||||
|
||||
*v:throwpoint* *throwpoint-variable*
|
||||
v:throwpoint The point where the exception most recently caught and not
|
||||
finished was thrown. Not set when commands are typed. See
|
||||
also |v:exception| and |throw-variables|.
|
||||
Example: >
|
||||
:try
|
||||
: throw "oops"
|
||||
:catch /.*/
|
||||
: echo "Exception from" v:throwpoint
|
||||
:endtry
|
||||
< Output: "Exception from test.vim, line 2"
|
||||
|
||||
*v:true* *true-variable*
|
||||
v:true Special value used to put "true" in JSON and msgpack. See
|
||||
|json_encode()|. This value is converted to "v:true" when used
|
||||
as a String (e.g. in |expr5| with string concatenation
|
||||
operator) and to one when used as a Number (e.g. in |expr5| or
|
||||
|expr7| when used with numeric operators). Read-only.
|
||||
|
||||
*v:val* *val-variable*
|
||||
v:val Value of the current item of a |List| or |Dictionary|. Only
|
||||
valid while evaluating the expression used with |map()| and
|
||||
|filter()|. Read-only.
|
||||
|
||||
*v:version* *version-variable*
|
||||
v:version Vim version number: major version times 100 plus minor
|
||||
version. Vim 5.0 is 500, Vim 5.1 is 501.
|
||||
Read-only.
|
||||
Use |has()| to check the Nvim (not Vim) version: >
|
||||
:if has("nvim-0.2.1")
|
||||
<
|
||||
|
||||
*v:virtnum* *virtnum-variable*
|
||||
v:virtnum Virtual line number for the 'statuscolumn' expression.
|
||||
Negative when drawing the status column for virtual lines, zero
|
||||
when drawing an actual buffer line, and positive when drawing
|
||||
the wrapped part of a buffer line.
|
||||
Read-only.
|
||||
|
||||
*v:vim_did_enter* *vim_did_enter-variable*
|
||||
v:vim_did_enter 0 during startup, 1 just before |VimEnter|.
|
||||
Read-only.
|
||||
|
||||
*v:warningmsg* *warningmsg-variable*
|
||||
v:warningmsg Last given warning message.
|
||||
Modifiable (can be set).
|
||||
|
||||
*v:windowid* *windowid-variable*
|
||||
v:windowid Application-specific window "handle" which may be set by any
|
||||
attached UI. Defaults to zero.
|
||||
Note: For Nvim |windows| use |winnr()| or |win_getid()|, see
|
||||
|window-ID|.
|
||||
The alphabetic list of all builtin variables and details are in a separate
|
||||
help file: |vvars|.
|
||||
|
||||
==============================================================================
|
||||
4. Builtin Functions *vim-function* *functions*
|
||||
|
||||
630
runtime/doc/vvars.txt
Normal file
630
runtime/doc/vvars.txt
Normal file
@ -0,0 +1,630 @@
|
||||
*vvars.txt* Nvim
|
||||
|
||||
|
||||
NVIM REFERENCE MANUAL
|
||||
|
||||
|
||||
Predefined variables *vvars*
|
||||
|
||||
Some variables can be set by the user, but the type cannot be changed.
|
||||
|
||||
Type |gO| to see the table of contents.
|
||||
|
||||
*v:argv* *argv-variable*
|
||||
v:argv The command line arguments Vim was invoked with. This is a
|
||||
list of strings. The first item is the Vim command.
|
||||
See |v:progpath| for the command with full path.
|
||||
|
||||
*v:char* *char-variable*
|
||||
v:char Argument for evaluating 'formatexpr' and used for the typed
|
||||
character when using <expr> in an abbreviation |:map-<expr>|.
|
||||
It is also used by the |InsertCharPre| and |InsertEnter| events.
|
||||
|
||||
*v:charconvert_from* *charconvert_from-variable*
|
||||
v:charconvert_from
|
||||
The name of the character encoding of a file to be converted.
|
||||
Only valid while evaluating the 'charconvert' option.
|
||||
|
||||
*v:charconvert_to* *charconvert_to-variable*
|
||||
v:charconvert_to
|
||||
The name of the character encoding of a file after conversion.
|
||||
Only valid while evaluating the 'charconvert' option.
|
||||
|
||||
*v:cmdarg* *cmdarg-variable*
|
||||
v:cmdarg
|
||||
The extra arguments ("++p", "++enc=", "++ff=") given to a file
|
||||
read/write command. This is set before an autocommand event
|
||||
for a file read/write command is triggered. There is a
|
||||
leading space to make it possible to append this variable
|
||||
directly after the read/write command. Note: "+cmd" isn't
|
||||
included here, because it will be executed anyway.
|
||||
|
||||
*v:collate* *collate-variable*
|
||||
v:collate The current locale setting for collation order of the runtime
|
||||
environment. This allows Vim scripts to be aware of the
|
||||
current locale encoding. Technical: it's the value of
|
||||
LC_COLLATE. When not using a locale the value is "C".
|
||||
This variable can not be set directly, use the |:language|
|
||||
command.
|
||||
See |multi-lang|.
|
||||
|
||||
*v:cmdbang* *cmdbang-variable*
|
||||
v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
|
||||
was used the value is 1, otherwise it is 0. Note that this
|
||||
can only be used in autocommands. For user commands |<bang>|
|
||||
can be used.
|
||||
|
||||
*v:completed_item* *completed_item-variable*
|
||||
v:completed_item
|
||||
Dictionary containing the most recent |complete-items| after
|
||||
|CompleteDone|. Empty if the completion failed, or after
|
||||
leaving and re-entering insert mode.
|
||||
Note: Plugins can modify the value to emulate the builtin
|
||||
|CompleteDone| event behavior.
|
||||
|
||||
*v:count* *count-variable*
|
||||
v:count The count given for the last Normal mode command. Can be used
|
||||
to get the count before a mapping. Read-only. Example: >
|
||||
:map _x :<C-U>echo "the count is " .. v:count<CR>
|
||||
< Note: The <C-U> is required to remove the line range that you
|
||||
get when typing ':' after a count.
|
||||
When there are two counts, as in "3d2w", they are multiplied,
|
||||
just like what happens in the command, "d6w" for the example.
|
||||
Also used for evaluating the 'formatexpr' option.
|
||||
|
||||
*v:count1* *count1-variable*
|
||||
v:count1 Just like "v:count", but defaults to one when no count is
|
||||
used.
|
||||
|
||||
*v:ctype* *ctype-variable*
|
||||
v:ctype The current locale setting for characters of the runtime
|
||||
environment. This allows Vim scripts to be aware of the
|
||||
current locale encoding. Technical: it's the value of
|
||||
LC_CTYPE. When not using a locale the value is "C".
|
||||
This variable can not be set directly, use the |:language|
|
||||
command.
|
||||
See |multi-lang|.
|
||||
|
||||
*v:dying* *dying-variable*
|
||||
v:dying Normally zero. When a deadly signal is caught it's set to
|
||||
one. When multiple signals are caught the number increases.
|
||||
Can be used in an autocommand to check if Vim didn't
|
||||
terminate normally.
|
||||
Example: >
|
||||
:au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
|
||||
< Note: if another deadly signal is caught when v:dying is one,
|
||||
VimLeave autocommands will not be executed.
|
||||
|
||||
*v:exiting* *exiting-variable*
|
||||
v:exiting Exit code, or |v:null| before invoking the |VimLeavePre|
|
||||
and |VimLeave| autocmds. See |:q|, |:x| and |:cquit|.
|
||||
Example: >
|
||||
:au VimLeave * echo "Exit value is " .. v:exiting
|
||||
<
|
||||
*v:echospace* *echospace-variable*
|
||||
v:echospace Number of screen cells that can be used for an `:echo` message
|
||||
in the last screen line before causing the |hit-enter-prompt|.
|
||||
Depends on 'showcmd', 'ruler' and 'columns'. You need to
|
||||
check 'cmdheight' for whether there are full-width lines
|
||||
available above the last line.
|
||||
|
||||
*v:errmsg* *errmsg-variable*
|
||||
v:errmsg Last given error message.
|
||||
Modifiable (can be set).
|
||||
Example: >
|
||||
:let v:errmsg = ""
|
||||
:silent! next
|
||||
:if v:errmsg != ""
|
||||
: ... handle error
|
||||
<
|
||||
*v:errors* *errors-variable* *assert-return*
|
||||
v:errors Errors found by assert functions, such as |assert_true()|.
|
||||
This is a list of strings.
|
||||
The assert functions append an item when an assert fails.
|
||||
The return value indicates this: a one is returned if an item
|
||||
was added to v:errors, otherwise zero is returned.
|
||||
To remove old results make it empty: >
|
||||
:let v:errors = []
|
||||
< If v:errors is set to anything but a list it is made an empty
|
||||
list by the assert function.
|
||||
|
||||
*v:event* *event-variable*
|
||||
v:event Dictionary of event data for the current |autocommand|. Valid
|
||||
only during the event lifetime; storing or passing v:event is
|
||||
invalid! Copy it instead: >
|
||||
au TextYankPost * let g:foo = deepcopy(v:event)
|
||||
< Keys vary by event; see the documentation for the specific
|
||||
event, e.g. |DirChanged| or |TextYankPost|.
|
||||
KEY DESCRIPTION ~
|
||||
abort Whether the event triggered during
|
||||
an aborting condition (e.g. |c_Esc| or
|
||||
|c_CTRL-C| for |CmdlineLeave|).
|
||||
chan |channel-id|
|
||||
cmdlevel Level of cmdline.
|
||||
cmdtype Type of cmdline, |cmdline-char|.
|
||||
cwd Current working directory.
|
||||
inclusive Motion is |inclusive|, else exclusive.
|
||||
scope Event-specific scope name.
|
||||
operator Current |operator|. Also set for Ex
|
||||
commands (unlike |v:operator|). For
|
||||
example if |TextYankPost| is triggered
|
||||
by the |:yank| Ex command then
|
||||
`v:event.operator` is "y".
|
||||
regcontents Text stored in the register as a
|
||||
|readfile()|-style list of lines.
|
||||
regname Requested register (e.g "x" for "xyy)
|
||||
or the empty string for an unnamed
|
||||
operation.
|
||||
regtype Type of register as returned by
|
||||
|getregtype()|.
|
||||
visual Selection is visual (as opposed to,
|
||||
e.g., via motion).
|
||||
completed_item Current selected complete item on
|
||||
|CompleteChanged|, Is `{}` when no complete
|
||||
item selected.
|
||||
height Height of popup menu on |CompleteChanged|
|
||||
width width of popup menu on |CompleteChanged|
|
||||
row Row count of popup menu on |CompleteChanged|,
|
||||
relative to screen.
|
||||
col Col count of popup menu on |CompleteChanged|,
|
||||
relative to screen.
|
||||
size Total number of completion items on
|
||||
|CompleteChanged|.
|
||||
scrollbar Is |v:true| if popup menu have scrollbar, or
|
||||
|v:false| if not.
|
||||
changed_window Is |v:true| if the event fired while
|
||||
changing window (or tab) on |DirChanged|.
|
||||
status Job status or exit code, -1 means "unknown". |TermClose|
|
||||
|
||||
*v:exception* *exception-variable*
|
||||
v:exception The value of the exception most recently caught and not
|
||||
finished. See also |v:throwpoint| and |throw-variables|.
|
||||
Example: >
|
||||
:try
|
||||
: throw "oops"
|
||||
:catch /.*/
|
||||
: echo "caught " .. v:exception
|
||||
:endtry
|
||||
< Output: "caught oops".
|
||||
|
||||
*v:false* *false-variable*
|
||||
v:false Special value used to put "false" in JSON and msgpack. See
|
||||
|json_encode()|. This value is converted to "v:false" when used
|
||||
as a String (e.g. in |expr5| with string concatenation
|
||||
operator) and to zero when used as a Number (e.g. in |expr5|
|
||||
or |expr7| when used with numeric operators). Read-only.
|
||||
|
||||
*v:fcs_reason* *fcs_reason-variable*
|
||||
v:fcs_reason The reason why the |FileChangedShell| event was triggered.
|
||||
Can be used in an autocommand to decide what to do and/or what
|
||||
to set v:fcs_choice to. Possible values:
|
||||
deleted file no longer exists
|
||||
conflict file contents, mode or timestamp was
|
||||
changed and buffer is modified
|
||||
changed file contents has changed
|
||||
mode mode of file changed
|
||||
time only file timestamp changed
|
||||
|
||||
*v:fcs_choice* *fcs_choice-variable*
|
||||
v:fcs_choice What should happen after a |FileChangedShell| event was
|
||||
triggered. Can be used in an autocommand to tell Vim what to
|
||||
do with the affected buffer:
|
||||
reload Reload the buffer (does not work if
|
||||
the file was deleted).
|
||||
edit Reload the buffer and detect the
|
||||
values for options such as
|
||||
'fileformat', 'fileencoding', 'binary'
|
||||
(does not work if the file was
|
||||
deleted).
|
||||
ask Ask the user what to do, as if there
|
||||
was no autocommand. Except that when
|
||||
only the timestamp changed nothing
|
||||
will happen.
|
||||
<empty> Nothing, the autocommand should do
|
||||
everything that needs to be done.
|
||||
The default is empty. If another (invalid) value is used then
|
||||
Vim behaves like it is empty, there is no warning message.
|
||||
|
||||
*v:fname* *fname-variable*
|
||||
v:fname When evaluating 'includeexpr': the file name that was
|
||||
detected. Empty otherwise.
|
||||
|
||||
*v:fname_in* *fname_in-variable*
|
||||
v:fname_in The name of the input file. Valid while evaluating:
|
||||
option used for ~
|
||||
'charconvert' file to be converted
|
||||
'diffexpr' original file
|
||||
'patchexpr' original file
|
||||
And set to the swap file name for |SwapExists|.
|
||||
|
||||
*v:fname_out* *fname_out-variable*
|
||||
v:fname_out The name of the output file. Only valid while
|
||||
evaluating:
|
||||
option used for ~
|
||||
'charconvert' resulting converted file [1]
|
||||
'diffexpr' output of diff
|
||||
'patchexpr' resulting patched file
|
||||
[1] When doing conversion for a write command (e.g., ":w
|
||||
file") it will be equal to v:fname_in. When doing conversion
|
||||
for a read command (e.g., ":e file") it will be a temporary
|
||||
file and different from v:fname_in.
|
||||
|
||||
*v:fname_new* *fname_new-variable*
|
||||
v:fname_new The name of the new version of the file. Only valid while
|
||||
evaluating 'diffexpr'.
|
||||
|
||||
*v:fname_diff* *fname_diff-variable*
|
||||
v:fname_diff The name of the diff (patch) file. Only valid while
|
||||
evaluating 'patchexpr'.
|
||||
|
||||
*v:folddashes* *folddashes-variable*
|
||||
v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
|
||||
fold.
|
||||
Read-only in the |sandbox|. |fold-foldtext|
|
||||
|
||||
*v:foldlevel* *foldlevel-variable*
|
||||
v:foldlevel Used for 'foldtext': foldlevel of closed fold.
|
||||
Read-only in the |sandbox|. |fold-foldtext|
|
||||
|
||||
*v:foldend* *foldend-variable*
|
||||
v:foldend Used for 'foldtext': last line of closed fold.
|
||||
Read-only in the |sandbox|. |fold-foldtext|
|
||||
|
||||
*v:foldstart* *foldstart-variable*
|
||||
v:foldstart Used for 'foldtext': first line of closed fold.
|
||||
Read-only in the |sandbox|. |fold-foldtext|
|
||||
|
||||
*v:hlsearch* *hlsearch-variable*
|
||||
v:hlsearch Variable that indicates whether search highlighting is on.
|
||||
Setting it makes sense only if 'hlsearch' is enabled. Setting
|
||||
this variable to zero acts like the |:nohlsearch| command,
|
||||
setting it to one acts like >
|
||||
let &hlsearch = &hlsearch
|
||||
< Note that the value is restored when returning from a
|
||||
function. |function-search-undo|.
|
||||
|
||||
*v:insertmode* *insertmode-variable*
|
||||
v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
|
||||
events. Values:
|
||||
i Insert mode
|
||||
r Replace mode
|
||||
v Virtual Replace mode
|
||||
|
||||
*v:key* *key-variable*
|
||||
v:key Key of the current item of a |Dictionary|. Only valid while
|
||||
evaluating the expression used with |map()| and |filter()|.
|
||||
Read-only.
|
||||
|
||||
*v:lang* *lang-variable*
|
||||
v:lang The current locale setting for messages of the runtime
|
||||
environment. This allows Vim scripts to be aware of the
|
||||
current language. Technical: it's the value of LC_MESSAGES.
|
||||
The value is system dependent.
|
||||
This variable can not be set directly, use the |:language|
|
||||
command.
|
||||
It can be different from |v:ctype| when messages are desired
|
||||
in a different language than what is used for character
|
||||
encoding. See |multi-lang|.
|
||||
|
||||
*v:lc_time* *lc_time-variable*
|
||||
v:lc_time The current locale setting for time messages of the runtime
|
||||
environment. This allows Vim scripts to be aware of the
|
||||
current language. Technical: it's the value of LC_TIME.
|
||||
This variable can not be set directly, use the |:language|
|
||||
command. See |multi-lang|.
|
||||
|
||||
*v:lnum* *lnum-variable*
|
||||
v:lnum Line number for the 'foldexpr' |fold-expr|, 'formatexpr',
|
||||
'indentexpr' and 'statuscolumn' expressions, tab page number
|
||||
for 'guitablabel' and 'guitabtooltip'. Only valid while one of
|
||||
these expressions is being evaluated. Read-only when in the
|
||||
|sandbox|.
|
||||
|
||||
*v:lua* *lua-variable*
|
||||
v:lua Prefix for calling Lua functions from expressions.
|
||||
See |v:lua-call| for more information.
|
||||
|
||||
*v:maxcol* *maxcol-variable*
|
||||
v:maxcol Maximum line length. Depending on where it is used it can be
|
||||
screen columns, characters or bytes. The value currently is
|
||||
2147483647 on all systems.
|
||||
|
||||
*v:mouse_win* *mouse_win-variable*
|
||||
v:mouse_win Window number for a mouse click obtained with |getchar()|.
|
||||
First window has number 1, like with |winnr()|. The value is
|
||||
zero when there was no mouse button click.
|
||||
|
||||
*v:mouse_winid* *mouse_winid-variable*
|
||||
v:mouse_winid |window-ID| for a mouse click obtained with |getchar()|.
|
||||
The value is zero when there was no mouse button click.
|
||||
|
||||
*v:mouse_lnum* *mouse_lnum-variable*
|
||||
v:mouse_lnum Line number for a mouse click obtained with |getchar()|.
|
||||
This is the text line number, not the screen line number. The
|
||||
value is zero when there was no mouse button click.
|
||||
|
||||
*v:mouse_col* *mouse_col-variable*
|
||||
v:mouse_col Column number for a mouse click obtained with |getchar()|.
|
||||
This is the screen column number, like with |virtcol()|. The
|
||||
value is zero when there was no mouse button click.
|
||||
|
||||
*v:msgpack_types* *msgpack_types-variable*
|
||||
v:msgpack_types Dictionary containing msgpack types used by |msgpackparse()|
|
||||
and |msgpackdump()|. All types inside dictionary are fixed
|
||||
(not editable) empty lists. To check whether some list is one
|
||||
of msgpack types, use |is| operator.
|
||||
|
||||
*v:null* *null-variable*
|
||||
v:null Special value used to put "null" in JSON and NIL in msgpack.
|
||||
See |json_encode()|. This value is converted to "v:null" when
|
||||
used as a String (e.g. in |expr5| with string concatenation
|
||||
operator) and to zero when used as a Number (e.g. in |expr5|
|
||||
or |expr7| when used with numeric operators). Read-only.
|
||||
In some places `v:null` can be used for a List, Dict, etc.
|
||||
that is not set. That is slightly different than an empty
|
||||
List, Dict, etc.
|
||||
|
||||
*v:numbermax* *numbermax-variable*
|
||||
v:numbermax Maximum value of a number.
|
||||
|
||||
*v:numbermin* *numbermin-variable*
|
||||
v:numbermin Minimum value of a number (negative).
|
||||
|
||||
*v:numbersize* *numbersize-variable*
|
||||
v:numbersize Number of bits in a Number. This is normally 64, but on some
|
||||
systems it may be 32.
|
||||
|
||||
*v:oldfiles* *oldfiles-variable*
|
||||
v:oldfiles List of file names that is loaded from the |shada| file on
|
||||
startup. These are the files that Vim remembers marks for.
|
||||
The length of the List is limited by the ' argument of the
|
||||
'shada' option (default is 100).
|
||||
When the |shada| file is not used the List is empty.
|
||||
Also see |:oldfiles| and |c_#<|.
|
||||
The List can be modified, but this has no effect on what is
|
||||
stored in the |shada| file later. If you use values other
|
||||
than String this will cause trouble.
|
||||
|
||||
*v:option_new*
|
||||
v:option_new New value of the option. Valid while executing an |OptionSet|
|
||||
autocommand.
|
||||
*v:option_old*
|
||||
v:option_old Old value of the option. Valid while executing an |OptionSet|
|
||||
autocommand. Depending on the command used for setting and the
|
||||
kind of option this is either the local old value or the
|
||||
global old value.
|
||||
*v:option_oldlocal*
|
||||
v:option_oldlocal
|
||||
Old local value of the option. Valid while executing an
|
||||
|OptionSet| autocommand.
|
||||
*v:option_oldglobal*
|
||||
v:option_oldglobal
|
||||
Old global value of the option. Valid while executing an
|
||||
|OptionSet| autocommand.
|
||||
*v:option_type*
|
||||
v:option_type Scope of the set command. Valid while executing an
|
||||
|OptionSet| autocommand. Can be either "global" or "local"
|
||||
*v:option_command*
|
||||
v:option_command
|
||||
Command used to set the option. Valid while executing an
|
||||
|OptionSet| autocommand.
|
||||
value option was set via ~
|
||||
"setlocal" |:setlocal| or ":let l:xxx"
|
||||
"setglobal" |:setglobal| or ":let g:xxx"
|
||||
"set" |:set| or |:let|
|
||||
"modeline" |modeline|
|
||||
*v:operator* *operator-variable*
|
||||
v:operator The last operator given in Normal mode. This is a single
|
||||
character except for commands starting with <g> or <z>,
|
||||
in which case it is two characters. Best used alongside
|
||||
|v:prevcount| and |v:register|. Useful if you want to cancel
|
||||
Operator-pending mode and then use the operator, e.g.: >
|
||||
:omap O <Esc>:call MyMotion(v:operator)<CR>
|
||||
< The value remains set until another operator is entered, thus
|
||||
don't expect it to be empty.
|
||||
v:operator is not set for |:delete|, |:yank| or other Ex
|
||||
commands.
|
||||
Read-only.
|
||||
|
||||
*v:prevcount* *prevcount-variable*
|
||||
v:prevcount The count given for the last but one Normal mode command.
|
||||
This is the v:count value of the previous command. Useful if
|
||||
you want to cancel Visual or Operator-pending mode and then
|
||||
use the count, e.g.: >
|
||||
:vmap % <Esc>:call MyFilter(v:prevcount)<CR>
|
||||
< Read-only.
|
||||
|
||||
*v:profiling* *profiling-variable*
|
||||
v:profiling Normally zero. Set to one after using ":profile start".
|
||||
See |profiling|.
|
||||
|
||||
*v:progname* *progname-variable*
|
||||
v:progname The name by which Nvim was invoked (with path removed).
|
||||
Read-only.
|
||||
|
||||
*v:progpath* *progpath-variable*
|
||||
v:progpath Absolute path to the current running Nvim.
|
||||
Read-only.
|
||||
|
||||
*v:register* *register-variable*
|
||||
v:register The name of the register in effect for the current normal mode
|
||||
command (regardless of whether that command actually used a
|
||||
register). Or for the currently executing normal mode mapping
|
||||
(use this in custom commands that take a register).
|
||||
If none is supplied it is the default register '"', unless
|
||||
'clipboard' contains "unnamed" or "unnamedplus", then it is
|
||||
"*" or '+'.
|
||||
Also see |getreg()| and |setreg()|
|
||||
|
||||
*v:relnum* *relnum-variable*
|
||||
v:relnum Relative line number for the 'statuscolumn' expression.
|
||||
Read-only.
|
||||
|
||||
*v:scrollstart* *scrollstart-variable*
|
||||
v:scrollstart String describing the script or function that caused the
|
||||
screen to scroll up. It's only set when it is empty, thus the
|
||||
first reason is remembered. It is set to "Unknown" for a
|
||||
typed command.
|
||||
This can be used to find out why your script causes the
|
||||
hit-enter prompt.
|
||||
|
||||
*v:servername* *servername-variable*
|
||||
v:servername Primary listen-address of Nvim, the first item returned by
|
||||
|serverlist()|. Usually this is the named pipe created by Nvim
|
||||
at |startup| or given by |--listen| (or the deprecated
|
||||
|$NVIM_LISTEN_ADDRESS| env var).
|
||||
|
||||
See also |serverstart()| |serverstop()|.
|
||||
Read-only.
|
||||
|
||||
*$NVIM*
|
||||
$NVIM is set by |terminal| and |jobstart()|, and is thus
|
||||
a hint that the current environment is a subprocess of Nvim.
|
||||
Example: >
|
||||
if $NVIM
|
||||
echo nvim_get_chan_info(v:parent)
|
||||
endif
|
||||
|
||||
< Note the contents of $NVIM may change in the future.
|
||||
|
||||
v:searchforward *v:searchforward* *searchforward-variable*
|
||||
Search direction: 1 after a forward search, 0 after a
|
||||
backward search. It is reset to forward when directly setting
|
||||
the last search pattern, see |quote/|.
|
||||
Note that the value is restored when returning from a
|
||||
function. |function-search-undo|.
|
||||
Read-write.
|
||||
|
||||
*v:shell_error* *shell_error-variable*
|
||||
v:shell_error Result of the last shell command. When non-zero, the last
|
||||
shell command had an error. When zero, there was no problem.
|
||||
This only works when the shell returns the error code to Vim.
|
||||
The value -1 is often used when the command could not be
|
||||
executed. Read-only.
|
||||
Example: >
|
||||
:!mv foo bar
|
||||
:if v:shell_error
|
||||
: echo 'could not rename "foo" to "bar"!'
|
||||
:endif
|
||||
<
|
||||
*v:statusmsg* *statusmsg-variable*
|
||||
v:statusmsg Last given status message.
|
||||
Modifiable (can be set).
|
||||
|
||||
*v:stderr* *stderr-variable*
|
||||
v:stderr |channel-id| corresponding to stderr. The value is always 2;
|
||||
use this variable to make your code more descriptive.
|
||||
Unlike stdin and stdout (see |stdioopen()|), stderr is always
|
||||
open for writing. Example: >
|
||||
:call chansend(v:stderr, "error: toaster empty\n")
|
||||
<
|
||||
*v:swapname* *swapname-variable*
|
||||
v:swapname Name of the swapfile found.
|
||||
Only valid during |SwapExists| event.
|
||||
Read-only.
|
||||
|
||||
*v:swapchoice* *swapchoice-variable*
|
||||
v:swapchoice |SwapExists| autocommands can set this to the selected choice
|
||||
for handling an existing swapfile:
|
||||
'o' Open read-only
|
||||
'e' Edit anyway
|
||||
'r' Recover
|
||||
'd' Delete swapfile
|
||||
'q' Quit
|
||||
'a' Abort
|
||||
The value should be a single-character string. An empty value
|
||||
results in the user being asked, as would happen when there is
|
||||
no SwapExists autocommand. The default is empty.
|
||||
|
||||
*v:swapcommand* *swapcommand-variable*
|
||||
v:swapcommand Normal mode command to be executed after a file has been
|
||||
opened. Can be used for a |SwapExists| autocommand to have
|
||||
another Vim open the file and jump to the right place. For
|
||||
example, when jumping to a tag the value is ":tag tagname\r".
|
||||
For ":edit +cmd file" the value is ":cmd\r".
|
||||
|
||||
*v:t_TYPE* *v:t_bool* *t_bool-variable*
|
||||
v:t_bool Value of |Boolean| type. Read-only. See: |type()|
|
||||
*v:t_dict* *t_dict-variable*
|
||||
v:t_dict Value of |Dictionary| type. Read-only. See: |type()|
|
||||
*v:t_float* *t_float-variable*
|
||||
v:t_float Value of |Float| type. Read-only. See: |type()|
|
||||
*v:t_func* *t_func-variable*
|
||||
v:t_func Value of |Funcref| type. Read-only. See: |type()|
|
||||
*v:t_list* *t_list-variable*
|
||||
v:t_list Value of |List| type. Read-only. See: |type()|
|
||||
*v:t_number* *t_number-variable*
|
||||
v:t_number Value of |Number| type. Read-only. See: |type()|
|
||||
*v:t_string* *t_string-variable*
|
||||
v:t_string Value of |String| type. Read-only. See: |type()|
|
||||
*v:t_blob* *t_blob-variable*
|
||||
v:t_blob Value of |Blob| type. Read-only. See: |type()|
|
||||
|
||||
*v:termresponse* *termresponse-variable*
|
||||
v:termresponse The value of the most recent OSC or DCS escape sequence
|
||||
received by Nvim from the terminal. This can be read in a
|
||||
|TermResponse| event handler after querying the terminal using
|
||||
another escape sequence.
|
||||
|
||||
*v:testing* *testing-variable*
|
||||
v:testing Must be set before using `test_garbagecollect_now()`.
|
||||
|
||||
*v:this_session* *this_session-variable*
|
||||
v:this_session Full filename of the last loaded or saved session file.
|
||||
Empty when no session file has been saved. See |:mksession|.
|
||||
Modifiable (can be set).
|
||||
|
||||
*v:throwpoint* *throwpoint-variable*
|
||||
v:throwpoint The point where the exception most recently caught and not
|
||||
finished was thrown. Not set when commands are typed. See
|
||||
also |v:exception| and |throw-variables|.
|
||||
Example: >
|
||||
:try
|
||||
: throw "oops"
|
||||
:catch /.*/
|
||||
: echo "Exception from" v:throwpoint
|
||||
:endtry
|
||||
< Output: "Exception from test.vim, line 2"
|
||||
|
||||
*v:true* *true-variable*
|
||||
v:true Special value used to put "true" in JSON and msgpack. See
|
||||
|json_encode()|. This value is converted to "v:true" when used
|
||||
as a String (e.g. in |expr5| with string concatenation
|
||||
operator) and to one when used as a Number (e.g. in |expr5| or
|
||||
|expr7| when used with numeric operators). Read-only.
|
||||
|
||||
*v:val* *val-variable*
|
||||
v:val Value of the current item of a |List| or |Dictionary|. Only
|
||||
valid while evaluating the expression used with |map()| and
|
||||
|filter()|. Read-only.
|
||||
|
||||
*v:version* *version-variable*
|
||||
v:version Vim version number: major version times 100 plus minor
|
||||
version. Vim 5.0 is 500, Vim 5.1 is 501.
|
||||
Read-only.
|
||||
Use |has()| to check the Nvim (not Vim) version: >
|
||||
:if has("nvim-0.2.1")
|
||||
<
|
||||
|
||||
*v:virtnum* *virtnum-variable*
|
||||
v:virtnum Virtual line number for the 'statuscolumn' expression.
|
||||
Negative when drawing the status column for virtual lines, zero
|
||||
when drawing an actual buffer line, and positive when drawing
|
||||
the wrapped part of a buffer line.
|
||||
Read-only.
|
||||
|
||||
*v:vim_did_enter* *vim_did_enter-variable*
|
||||
v:vim_did_enter 0 during startup, 1 just before |VimEnter|.
|
||||
Read-only.
|
||||
|
||||
*v:warningmsg* *warningmsg-variable*
|
||||
v:warningmsg Last given warning message.
|
||||
Modifiable (can be set).
|
||||
|
||||
*v:windowid* *windowid-variable*
|
||||
v:windowid Application-specific window "handle" which may be set by any
|
||||
attached UI. Defaults to zero.
|
||||
Note: For Nvim |windows| use |winnr()| or |win_getid()|, see
|
||||
|window-ID|.
|
||||
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
Loading…
Reference in New Issue
Block a user