Lines Matching refs:be
11 Note: Expression evaluation can be disabled at compile time. If this has been
72 It can be bound to a dictionary and arguments, it then works
138 An expression can be used as a condition, ignoring the type and only using
160 non-empty String, then the value is considered to be TRUE.
161 Note that " " and "0" are also non-empty strings, thus considered to be TRUE.
175 When expecting a Float a Number can also be used, but nothing else.
184 function or created with the lambda expression |expr-lambda|. It can be used
204 A Funcref can also be used with the |:call| command: >
208 The name of the referenced function can be obtained with |string()|. >
219 arguments will be passed to the function. Example: >
238 otherDict and calling it, it will be bound to otherDict: >
243 Now "self" will be "otherDict". But when the dictionary was bound explicitly
250 Here "self" will be "myDict", because it was bound explicitly.
255 A List is an ordered sequence of items. An item can be of any type. Items
256 can be accessed by their index number. Items can be added and removed at any
267 An item can be any expression. Using a List for an item creates a
276 An item in the List can be accessed by putting the index in square brackets
281 When the resulting item is a list this can be repeated: >
296 Two lists can be concatenated with the "+" operator: >
306 A part of the List can be obtained by specifying the first and last index,
359 The operator "is" can be used to check if two variables refer to the same
406 Except that there is no error if there are only two items. "rest" will be an
416 To change part of a list you can specify the first and last item to be
456 function will be a simpler method than a for loop.
459 requires the argument to be a List of Lists. >
509 entry can be located with the key. The entries are stored without a specific
521 A key is always a String. You can use a Number, it will be converted to a
524 Number will be converted to the String '4'. The empty string can also be used
527 To avoid having to put quotes around every key the #{} form can be used. This
533 A value can be any expression. Using a Dictionary for a value creates a
549 form can be used |expr-entry|: >
553 Since an entry can be any type, also a List and a Dictionary, the indexing and
554 key lookup can be repeated: >
614 in adict to be overwritten. An optional third argument can change this.
619 Weeding out entries from a Dictionary can be done with |filter()|: >
622 This can also be used to remove all entries: >
628 When a function is defined with the "dict" attribute it can be used in a
644 To avoid the extra name for the function it can be defined and directly
653 that references this function. The function can only be used through a
654 |Funcref|. It will automatically be deleted when there is no |Funcref|
666 Functions that can be used with a Dictionary: >
679 A Blob is a binary object. It can be used to read an image from a file and
688 A Blob can be created with a |blob-literal|: >
690 Dots can be inserted between bytes (pair of hex characters) for readability,
694 A blob can be read from a file with |readfile()| passing the {type} argument
698 A blob can be read from a channel with the |ch_readblob()| function.
703 A byte in the Blob can be accessed by putting the index in square brackets
731 Two blobs can be concatenated with the "+" operator: >
740 A part of the Blob can be obtained by specifying the first and last index,
769 To change a sequence of bytes the [:] notation can be used: >
771 The length of the replaced bytes must be exactly the same as the value
774 To change part of a blob you can specify the first and last byte to be
783 Blobs can be compared for equality: >
822 variable name can be stored where ~
904 "..." indicates that the operations in this level can be concatenated.
937 You should always put a space before the ':', otherwise it can be mistaken for
974 The operators can be concatenated, for example: >
989 so the result must be |TRUE|. Similarly below: >
994 only be evaluated if "b" has been defined.
1031 A |List| can only be compared with a |List| and only "equal", "not equal",
1032 "is" and "isnot" can be used. This compares the values of the list,
1036 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not
1037 equal", "is" and "isnot" can be used. This compares the key/values of the
1042 A |Funcref| can only be compared with a |Funcref| and only "equal", "not
1043 equal", "is" and "isnot" can be used. Case is never ignored. Whether
1045 Dictionaries must also be equal (or the same, in case of "is") and the
1046 arguments must be equal (or the same).
1065 "is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case.
1092 portable. To avoid backslashes in the regexp pattern to be doubled, use a
1094 Since a string is considered to be a single line, a multi-line pattern
1096 can be matched like an ordinary character. Examples:
1108 For |Lists| only "+" is possible and then both expr6 must be a list. The
1131 190, which can be added to the Float 90.0. However: >
1133 Should be read as: >
1166 A String will be converted to a Number first.
1168 These three can be repeated and mixed. Examples:
1238 A negative number can be used to measure from the end of the string. -1 is
1277 name will be used as a key in the |Dictionary|. This is just like:
1281 but it may start with a number. Curly braces cannot be used.
1283 There must not be white space before or after the dot.
1305 There can also be methods specifically for the type of "expr8".
1314 When using -> the |expr7| operators will be applied first, thus: >
1322 "->name(" must not contain white space. There can be white space before the
1330 When using the lambda form there must be no white space between the } and the
1344 Floating point numbers can be written in two forms:
1349 {N} and {M} are numbers. Both {N} and {M} must be present and can only
1409 \.. two-digit octal number (must be followed by non-digit)
1410 \. one-digit octal number (must be followed by non-digit)
1412 \x. byte specified with one hex number (must be followed by non-hex char)
1428 To use the double quote character it must be escaped: "<M-\">".
1435 Note that "\xff" is stored as the byte 255, which may be invalid in some
1446 The sequence must be an even number of hex characters. Example: >
1460 to be doubled. These two commands are equivalent: >
1475 Any option name can be used here. See |options|. When using the local value
1505 The functions `getenv()` and `setenv()` can also be used and work for
1507 The function `environ()` can be used to get a Dict with all environment
1516 fails, a shell will be used to expand the variable. This can be slow, but it
1546 2. The prefix "a:" should not be used for arguments. E.g.: >
1556 Note that in Vim9 script another kind of lambda can be used: |vim9-lambda|.
1574 Lambda and closure support can be checked with: >
1591 Note that it is possible to cause memory to be used and not freed if the
1612 An internal variable name can be made up of letters, digits and '_'. But it
1623 There are several name spaces for variables. Which one is to be used is
1636 The scope name by itself can be used as a |Dictionary|. For example, to
1656 This can be used to perform an action only when the buffer has
1675 access a variable local to a function. But "g:" can also be used in any other
1686 In a Vim script variables starting with "s:" can be used. They cannot be
1689 They can be used in:
1702 Script variables can be used to avoid conflicts with global variable names.
1713 that script will not be changed, only the "s:counter" in the script where
1743 called, the s:counter variable will be accessible in MyCounter().
1746 They will remain valid as long as Vim is running. This can be used to
1763 Some variables can be set by the user, but the type cannot be changed.
1808 The name of the character encoding of a file to be converted.
1824 included here, because it will be executed anyway.
1826 the argument for the ":hardcopy" command. This can be used
1832 can only be used in autocommands. For user commands |<bang>|
1833 can be used.
1836 environment. This allows Vim scripts to be aware of the
1839 This variable can not be set directly, use the |:language|
1845 color names can be used with the |highlight-guifg|,
1849 colorscheme script) need to be re-evaluated in order to use
1856 This cannot be used to override the |cterm-colors| but it can
1857 be used to override other colors. For example, the X11 colors
1887 v:count The count given for the last Normal mode command. Can be used
1904 environment. This allows Vim scripts to be aware of the
1907 This variable can not be set directly, use the |:language|
1914 Can be used in an autocommand to check if Vim didn't
1919 VimLeave autocommands will not be executed.
1929 v:echospace Number of screen cells that can be used for an `:echo` message
1988 Can be used in an autocommand to decide what to do and/or what
1999 triggered. Can be used in an autocommand to tell Vim what to
2008 everything that needs to be done.
2019 'charconvert' file to be converted
2022 'printexpr' file to be printed
2033 file") it will be equal to v:fname_in. When doing conversion
2034 for a read command (e.g., ":e file") it will be a temporary
2085 environment. This allows Vim scripts to be aware of the
2088 This variable can not be set directly, use the |:language|
2090 It can be different from |v:ctype| when messages are desired
2096 environment. This allows Vim scripts to be aware of the
2098 This variable can not be set directly, use the |:language|
2130 This can also be used as a function argument to use the
2157 systems it may be 32.
2166 The List can be modified, but this has no effect on what is
2189 |OptionSet| autocommand. Can be either "global" or "local"
2207 don't expect it to be empty.
2238 < If the command has a relative path it will be expanded to the
2241 On Linux and other systems it will always be the full path.
2242 On Mac it may just be "vim" and using exepath() as mentioned
2243 above should be used to get the full path.
2244 On MS-Windows the executable may be called "vim.exe", but the
2263 This can be used to find out why your script causes the
2283 The value -1 is often used when the command could not be
2324 The value should be a single-character string. An empty value
2329 v:swapcommand Normal mode command to be executed after a file has been
2330 opened. Can be used for a |SwapExists| autocommand to have
2399 v:testing Must be set before using `test_garbagecollect_now()`.
2400 Also, when set certain error messages won't be shown for 2
2449 This can be used like this: >
2466 terminal and Vim connects to the X server (|-X|) this will be
2468 When an MS-Windows GUI is running this will be set to the
3090 term_wait({buf} [, {time}]) Number wait for screen to be updated
3175 a |Float| abs() returns a |Float|. When {expr} can be
3186 Can also be used as a |method|: >
3203 Can also be used as a |method|: >
3216 When {object} is a |Blob| then {expr} must be a number.
3219 Can also be used as a |method|: >
3228 < Can also be used as a |method|: >
3238 {lnum} can be zero to insert a line before the first one.
3245 < Can also be used as a |method| after a List, the base is
3268 Can also be used as a |method| after a List, the base is
3298 {winnr} can be the window number or the |window-ID|.
3327 Can also be used as a |method|: >
3347 Can also be used as a |method|: >
3363 Can also be used as a |method|: >
3374 a string. For a terminal {expr} can be a list, which contains
3375 the lines of the balloon. If {expr} is not a list it will be
3389 < Can also be used as a |method|: >
3404 Split String {msg} into lines to be displayed in a balloon.
3408 Can also be used as a |method|: >
3422 Can also be used as a |method|: >
3443 to be used.
3456 The buffer will not have 'buflisted' set and not be loaded
3461 < Can also be used as a |method|: >
3471 exactly. The name can be:
3476 Unlisted buffers will be found.
3479 long name to be able to find them.
3486 Can also be used as a |method|: >
3496 Can also be used as a |method|: >
3502 the buffer will be empty. If the buffer was already loaded
3505 there will be no dialog, the buffer will be loaded anyway.
3508 Can also be used as a |method|: >
3516 Can also be used as a |method|: >
3530 "" or "%" can be used for the current buffer, "#" for the
3540 number, force it to be a Number by adding zero to it: >
3542 < Can also be used as a |method|: >
3574 Can also be used as a |method|: >
3591 Can also be used as a |method|: >
3602 < The number can be used with |CTRL-W_w| and ":wincmd w"
3605 Can also be used as a |method|: >
3616 Can also be used as a |method|: >
3644 Can also be used as a |method|: >
3660 Can also be used as a |method|: >
3666 {func} can either be a |Funcref| or the name of a function.
3669 {dict} is for functions with the "dict" attribute. It will be
3672 Can also be used as a |method|: >
3687 Can also be used as a |method|: >
3698 number as what is displayed with |:undolist| and can be used
3721 Can also be used as a |method|: >
3745 < Can also be used as a |method|: >
3771 Can also be used as a |method|: >
3784 {dir} must be a String.
3796 < Can also be used as a |method|: >
3808 Can also be used as a |method|: >
3817 Can also be used as a |method|: >
3832 Additionally {expr} can be [lnum, col]: a |List| with the line
3840 Note that only marks in the current file can be used.
3847 For an uppercase mark the column may actually be in another
3851 line. This can be used to obtain the column in Insert mode: >
3857 < Can also be used as a |method|: >
3863 Can only be used in Insert mode. You need to use a mapping
3868 that will be replaced by the matches. Use col('.') for an
3871 {matches} must be a |List|. Each |List| item is one match.
3876 The match can be selected with CTRL-N and CTRL-P as usual with
3891 Can also be used as a |method|, the base is passed as the
3896 Add {expr} to the list of matches. Only to be used by the
3904 Can also be used as a |method|: >
3909 This is to be used when looking for matches takes some time.
3910 Returns |TRUE| when searching for matches is to be aborted,
3912 Only to be used by the function specified with the
3972 < Can also be used as a |method|: >
3977 confirm() offers the user a dialog, from which a choice can be
3994 not need to be the first letter: >
4006 Win32 GUI. It can be one of these values: "Error",
4030 Can also be used as a |method|in: >
4037 that the original |List| can be changed without changing the
4042 Can also be used as a |method|: >
4054 Can also be used as a |method|: >
4070 Can also be used as a |method|: >
4081 {start} can only be used with a |List|.
4089 Can also be used as a |method|: >
4152 the cursor will be positioned at the last line in the buffer.
4155 the cursor will be positioned at the last character in the
4164 Returns 0 when the position could be set, -1 otherwise.
4166 Can also be used as a |method|: >
4175 Can also be used as a |method|: >
4182 that the original |List| can be changed without changing the
4200 Can also be used as a |method|: >
4225 Can also be used as a |method|: >
4242 Can also be used as a |method|: >
4247 FileType event has been triggered at least once. Can be used
4266 Can also be used as a |method|: >
4277 The highlight ID can be used with |synIDattr()| to obtain
4280 Can also be used as a |method|: >
4285 Return the digraph of {chars}. This should be a string with
4290 The character will be converted from Unicode to 'encoding'
4291 when needed. This does require the conversion to be
4304 Can also be used as a |method|: >
4317 The characters will be converted from Unicode to 'encoding'
4318 when needed. This does require the conservation to be
4330 Can also be used as a |method|: >
4339 Add digraph {chars} to the list. {chars} must be a string
4354 Can be used as a |method|: >
4375 following digraphs will not be added.
4377 Can be used as a |method|: >
4387 This can be used to output a terminal code. For example, to
4409 Can also be used as a |method|: >
4416 < Note that the variable name may be CamelCase; to ignore case
4428 Can also be used as a |method|: >
4438 Can also be used as a |method|: >
4445 commands cannot be used. Otherwise zero is returned.
4449 exists. {expr} must be the name of the program without any
4453 On MS-Windows the ".exe", ".bat", etc. can optionally be
4455 "foo.exe" does not exist, "foo.exe.bat" can be found. If
4457 by itself can be used in $PATHEXT to try using the name
4469 |exepath()| can be used to get the full path of an executable.
4471 Can also be used as a |method|: >
4477 {command} can be a string or a List. In case of a List the
4490 command the screen may be messed up, use `system()` instead.
4503 Can also be used as a |method|: >
4510 with "./", which may be a problem for Vim: >
4512 < If {expr} cannot be found in $PATH or is not executable then
4515 Can also be used as a |method|: >
4533 $ENVNAME environment variable (could also be
4541 ?funcname built-in function that could be
4542 implemented; to be used to check if
4566 always check the return value to be 2.
4597 < There must be no space between the symbol (&/$/*/#) and the
4599 There must be no extra characters after the name, although in
4607 < Note that the argument must be a string, not the name of the
4613 Can also be used as a |method|: >
4624 < If `exists()` were used then a compilation error would be
4627 {expr} must be a literal string. *E1232*
4628 Can only be used in a |:def| function. *E1233*
4642 Can also be used as a |method|: >
4652 If {list} is given and it is |TRUE|, a List will be returned.
4706 There cannot be white space between the variables and the
4707 following modifier. The |fnamemodify()| function can be used
4720 be used to search in a directory tree. For example, to find
4724 expand() can also be used to expand variables and environment
4725 variables that are only known in a shell. But this can be
4726 slow, because a shell may be used to do the expansion. See
4729 names. When an environment variable cannot be expanded, it is
4736 Can also be used as a |method|: >
4748 < Can also be used as a |method|: >
4752 {expr1} and {expr2} must be both |Lists| or both
4787 Can also be used as a |method|: >
4794 unchanged. Items can still be changed by {expr2}, if you
4805 other characters, they will be executed next, before any
4815 A special code that might be useful is <Ignore>, it exits the
4837 stuck, waiting for a character to be typed before the
4841 all typeahead will be consumed by the last call.
4842 '!' When used with 'x' will not end Insert mode. Can be
4848 Can also be used as a |method|: >
4853 name {file} exists, and can be read. If {file} doesn't exist,
4864 < Can also be used as a |method|: >
4872 name {file} exists, and can be written. If {file} doesn't
4876 Can also be used as a |method|: >
4881 {expr1} must be a |List|, |Blob| or |Dictionary|.
4886 {expr2} must be a |string| or |Funcref|.
4908 The function must return |TRUE| if the item should be kept.
4929 Can also be used as a |method|: >
4950 Can also be used as a |method|: >
4961 Can also be used as a |method|: >
4970 In Vim9 script flatten() cannot be used, you must always use
4975 {maxdepth} must be positive number.
4985 Can also be used as a |method|: >
5013 Can also be used as a |method|: >
5031 Can also be used as a |method|: >
5051 Can also be used as a |method|: >
5072 Can also be used as a |method|: >
5087 Can also be used as a |method|: >
5097 Can also be used as a |method|: >
5107 Can also be used as a |method|: >
5116 returned for lines where folds are still to be updated and the
5122 Can also be used as a |method|: >
5126 foldtext() Returns a String, to be displayed for a closed fold. This is
5128 only be called from evaluating 'foldtext'. It uses the
5138 will be filled with the fold char from the 'fillchars'
5153 Can also be used as a |method|: >
5177 Can also be used as a |method|: >
5186 Unlike |function()|, {name} must be an existing user function.
5187 Also for autoloaded functions. {name} cannot be a builtin
5190 Can also be used as a |method|: >
5196 {name} can be the name of a user defined function or an
5199 {name} can also be a Funcref or a partial. When it is a
5200 partial the dict stored in it will be used and the {dict}
5205 When using the Funcref the function will be found by {name},
5211 the Funcref and will be used when the Funcref is called.
5232 < The function() call can be nested to add more arguments to the
5259 < The argument list and the Dictionary can be combined: >
5269 Can also be used as a |method|: >
5286 collection will also be done when exiting Vim, if it wasn't
5335 be specified in {dict}:
5395 Can also be used as a |method|: >
5407 For {lnum} and {end} "$" can be used for the last line of the
5408 buffer. Otherwise a number must be used.
5424 < Can also be used as a |method|: >
5430 must be used.
5448 < Can also be used as a |method|: >
5467 Can also be used as a |method|: >
5489 When [expr] is 0 and Esc is typed, there will be a short delay
5499 When the user clicks a mouse button, the mouse event will be
5500 returned. The position can then be found in |v:mouse_col|,
5502 |getmousepos()| can also be used. Mouse move events will be
5517 user that a character has to be typed. The screen is not
5580 Can also be used as a |method|: >
5596 This can be useful to always have |;| and |,| search
5713 Can also be used as a |method|: >
5729 be the window number or the |window-ID|. The last known
5730 cursor position is returned, this may be invalid for the
5734 This can be used to save and restore the cursor position: >
5741 Can also be used as a |method|: >
5754 Can also be used as a |method|: >
5763 in the current tab page. {winnr} can be the window number or
5791 < Can also be used as a |method|: >
5804 Can also be used as a |method|: >
5824 If {fname} does not exist or its directory cannot be read, an
5836 Can also be used as a |method|: >
5845 If the file {fname} can't be found, -1 is returned.
5849 Can also be used as a |method|: >
5855 since 1st Jan 1970, and may be passed to strftime(). See also
5857 If the file {fname} can't be found -1 is returned.
5859 Can also be used as a |method|: >
5878 < Note that a type such as "link" will only be returned on
5883 Can also be used as a |method|: >
5896 {winnr} can also be a |window-ID|.
5910 Can also be used as a |method|: >
5936 < Can also be used as a |method|: >
5943 window {nr}. {nr} can be the window number or the |window-ID|.
5991 Can also be used as a |method|: >
6020 mouse. This can be used in a mapping for a mouse click or in
6071 The column number can be very large, e.g. 2147483647, in which
6073 This can be used to save and restore the position of a mark: >
6079 Can also be used as a |method|: >
6192 be restored with |setreg()|. For other registers the extra
6204 In |Vim9-script| {regname} must be one character.
6206 Can also be used as a |method|: >
6224 with `dd`, this field will be "1",
6229 or not set, an empty Dictionary will be returned.
6232 The returned Dictionary can be passed to |setreg()|.
6233 In |Vim9-script| {regname} must be one character.
6235 Can also be used as a |method|: >
6240 The value will be one of:
6249 In |Vim9-script| {regname} must be one character.
6251 Can also be used as a |method|: >
6267 Can also be used as a |method|: >
6276 Note that the name without "t:" must be used.
6280 Can also be used as a |method|: >
6292 Note that {varname} must be the name without "w:".
6295 {winnr} can be the window number or the |window-ID|.
6309 < Can also be used as a |method|: >
6314 {winnr} can be the window number or the |window-ID|.
6340 Can also be used as a |method|: >
6393 Can also be used as a |method|: >
6400 {timeout} can be used to specify how long to wait in msec for
6405 if available. This can be used to poll for the position and
6416 Can also be used as a |method|: >
6423 The result will be -1 if the information is not available.
6424 The value can be used with `:winpos`.
6430 The result will be -1 if the information is not available.
6431 The value can be used with `:winpos`.
6439 < Can also be used as a |method|: >
6448 one of the patterns in 'wildignore' will be skipped and
6468 For most systems backticks can be used to get files names from
6472 < The result of the program inside the backticks should be one
6478 Can also be used as a |method|: >
6483 pattern. The result can be used to match with a string that
6493 Can also be used as a |method|: >
6512 one of the patterns in 'wildignore' will be skipped and
6524 The "**" item can be used to search in a directory tree.
6531 Can also be used as a |method|, the base is passed as the
6543 which is 1 if the feature {feature} could ever be supported,
6547 features that have been abandoned will not be known by the
6559 < If the `endif` would be moved to the second line as "| endif" it
6560 would not be found.
6568 Can also be used as a |method|: >
6581 {winnr} can be the window number or the |window-ID|.
6605 Can also be used as a |method|: >
6639 Can also be used as a |method|: >
6643 Add the String {item} to the history {history} which can be
6651 The {history} string does not need to be the whole name, one
6653 If {item} does already exist in the history, it will be
6663 Can also be used as a |method|, the base is passed as the
6673 be removed from the history (if there are any).
6675 If {item} evaluates to a Number, it will be interpreted as
6677 be removed if it exists.
6699 Can also be used as a |method|: >
6717 Can also be used as a |method|: >
6728 < Can also be used as a |method|: >
6740 Can also be used as a |method|: >
6791 Can also be used as a |method|: >
6818 The 'linksto' item can be used to link a highlight group to
6842 Can also be used as a |method|: >
6849 This can be used to retrieve information about the highlight
6856 Can also be used as a |method|: >
6868 returned. When some characters could not be converted they
6872 Most conversions require Vim to be compiled with the |+iconv|
6874 can be done.
6875 This can be used to display messages with special characters,
6883 Can also be used as a |method|: >
6893 Can also be used as a |method|: >
6907 {start} (may be negative for an item relative to the end).
6915 < Can also be used as a |method|: >
6921 string, or a blank string (for no prompt). A '\n' can be used
6940 that can be supplied to a user-defined command using the
6945 NOTE: This function must not be used in a startup file, for
6963 < Can also be used as a |method|: >
6980 Can also be used as a |method|: >
6984 {textlist} must be a |List| of strings. This |List| is
6985 displayed, one string per line. The user will be prompted to
7000 < Can also be used as a |method|: >
7005 Should be called the same number of times inputsave() is
7011 a following prompt gets input from the user. Should be
7013 be used several times, in which case there must be just as
7020 a) the user's response will be displayed as a sequence of
7022 b) the user's response will not be recorded on the input
7028 Can also be used as a |method|: >
7044 < The last example can be done simpler with |add()|.
7048 Can also be used as a |method|: >
7068 < Can also be used as a |method|: >
7077 Can also be used as a |method|: >
7088 Can also be used as a |method|: >
7096 The string argument {expr} must be the name of a variable,
7108 Can also be used as a |method|: >
7116 Can also be used as a |method|: >
7131 < Can also be used as a |method|: >
7148 Can also be used as a |method|: >
7153 - Object key names do not have to be in quotes.
7154 - Strings can be in single quotes.
7158 Can also be used as a |method|: >
7168 Will be encoded as:
7175 Can also be used as a |method|: >
7202 - A correct surrogate pair in JSON strings should normally be
7208 accepted by json_decode() as the result must be a valid Vim
7211 Can also be used as a |method|: >
7239 Can also be used as a |method|: >
7246 Can also be used as a |method|: >
7260 Can also be used as a |method|: >
7268 especially made to be used with Vim. Since only one argument
7285 For Win32, the functions you write must be placed in a DLL
7299 For Win32 systems, {libname} should be the filename of the DLL
7303 object code must be compiled as position-independent ('PIC').
7309 < Can also be used as a |method|, the base is passed as the
7324 Can also be used as a |method|, the base is passed as the
7345 Note that a mark in another file can be used. The line number
7360 Can also be used as a |method|: >
7368 This can also be used to get the byte count for the line just
7377 Can also be used as a |method|: >
7388 Can also be used as a |method|: >
7401 Can also be used as a |method|: >
7409 < The same can be done (slowly) with: >
7418 Can also be used as a |method|: >
7422 Add a callback function that will be invoked when changes have
7427 Returns a unique ID that can be passed to |listener_remove()|.
7443 < The List cannot be changed. Each item in a:changes is a
7490 Can also be used as a |method|, the base is passed as the
7502 Can also be used as a |method|: >
7507 Returns FALSE when {id} could not be found, TRUE when {id} was
7510 Can also be used as a |method|: >
7528 Can also be used as a |method|: >
7543 Can also be used as a |method|: >
7563 Can also be used as a |method|: >
7569 {expr1} must be a |List|, |Blob| or |Dictionary|.
7576 {expr2} must be a |string| or |Funcref|.
7618 Can also be used as a |method|: >
7635 {mode} can be one of these strings:
7654 "lhs" The {lhs} of the mapping as it would be typed
7666 characters will be used:
7676 The dictionary can be used to restore a mapping with
7681 This function can be used to map a key even when it's already
7685 < Can also be used as a |method|: >
7709 {name}, the RHS of one of them is returned. This will be
7713 This function can be used to check if a mapping can be added
7721 Can also be used as a |method|: >
7728 unchanged. Items can still be changed by {expr2}, if you
7734 {mode} and {abbr} should be the same as for the call to
7788 For a String, if {start} < 0, it will be set to 0. For a list
7810 Can also be used as a |method|: >
7816 Defines a pattern to be highlighted in the current window (a
7817 "match"). It will be highlighted with {group}. Returns an
7818 identification number (ID), which can be used to delete the
7823 The "Conceal" value is special, it causes the match to be
7839 message will appear and the match will not be added. An ID
7847 conceal character that will be shown for |hl-Conceal|
7866 available from |getmatches()|. All matches can be deleted in
7869 Can also be used as a |method|: >
7878 to be used when fast match additions and deletions are
7881 {pos} is a list of positions. Each position can be one of
7883 - A number. This whole line will be highlighted. The first
7886 number will be highlighted.
7891 be highlighted.
7906 Can also be used as a |method|: >
7921 Can also be used as a |method|: >
7928 be deleted in one operation by |clearmatches()|.
7932 Can also be used as a |method|: >
7954 Can also be used as a |method|: >
7973 {str}. The value of this item should be a
7975 text_cb |Funcref| that will be called for every item
8050 Can also be used as a |method|: >
8066 Can also be used as a |method|: >
8087 Can also be used as a |method|: >
8095 < {expr} can be a |List| or a |Dictionary|. For a Dictionary,
8098 items in {expr} cannot be used as a Number this results in
8101 Can also be used as a |method|: >
8107 mode {mode}. The menu name should be specified without the
8111 {mode} can be one of these strings:
8134 characters will be used:
8175 Can also be used as a |method|: >
8183 < {expr} can be a |List| or a |Dictionary|. For a Dictionary,
8186 items in {expr} cannot be used as a Number this results in
8189 Can also be used as a |method|: >
8197 necessary. Otherwise it must be "".
8203 {name}. Thus if you create /tmp/foo/bar then /tmp/foo will be
8221 < Can also be used as a |method|: >
8272 be added. It's better not to compare the whole string but only
8276 Can also be used as a |method|: >
8297 Can also be used as a |method|: >
8311 Can also be used as a |method|: >
8332 Can also be used as a |method|: >
8340 < Can also be used as a |method|: >
8357 Can also be used as a |method|: >
8362 its result converted to Vim data structures. If value can't be
8373 Can also be used as a |method|: >
8393 Can also be used as a |method|: >
8407 Can also be used as a |method|: >
8454 # The value should be converted to an "alternate
8475 is to be left adjusted on the field boundary.
8480 ' ' (space) A blank should be left before a positive
8483 + A sign must always be placed before a number
8490 than the field width, it will be padded with spaces on
8500 bytes to be printed from a string for s conversions.
8506 be applied, see below.
8508 A field width or precision, or both, may be indicated by an
8605 arguments an error is given. Up to 18 arguments can be used.
8610 be a buffer name or number. See |prompt-buffer|.
8615 Can also be used as a |method|: >
8627 buffer will always be the prompt buffer. A new line for a
8629 for which the callback was invoked will be in the last but one
8633 prompt is. This can also be done asynchronously.
8635 that was entered at the prompt. This can be an empty string
8645 " Reset 'modified' to allow the buffer to be closed.
8650 < Can also be used as a |method|: >
8660 This callback will be invoked when pressing CTRL-C in Insert
8664 Can also be used as a |method|: >
8676 Can also be used as a |method|: >
8700 This can be used to avoid some things that would remove the
8715 Can also be used as a |method|: >
8732 Can also be used as a |method|: >
8743 Can also be used as a |method|: >
8753 {expr} can be initialized by |srand()| and will be updated by
8783 Can also be used as a |method|: >
8789 When the file can't be opened an error message is given and
8798 The list will be sorted (case sensitive), see the {dict}
8804 be handled.
8805 If {expr} results in 0 then this entry will not be
8807 If {expr} results in 1 then this entry will be added
8819 should be performed. The dict can have the following members:
8845 Can also be used as a |method|: >
8857 The list will by default be sorted by name (case sensitive),
8858 the sorting can be changed by using the optional {dict}
8888 be handled.
8889 If {expr} results in 0 then this entry will not be
8891 If {expr} results in 1 then this entry will be added
8905 Can also be used as a |method|: >
8926 to be read. Useful if you only want to check the first ten
8940 When the file can't be opened an error message is given and
8944 Can also be used as a |method|: >
8948 {func} is called for every item in {object}, which can be a
8956 result can be computed, an E998 error is given.
8963 Can also be used as a |method|: >
8979 list<any> can be used.
8980 The item can be passed to |reltimestr()| to convert it to a
8989 The {start} and {end} arguments must be values returned by
8993 Can also be used as a |method|: >
9009 Can also be used as a |method|: >
9021 < Note that overhead for the commands will be added to the time.
9030 Can also be used as a |method|: >
9039 The result must be a String or a |List|. A |List| is turned
9050 Note: Any errors will cause a local error message to be issued
9051 and the result will be the empty string.
9053 Variables will be evaluated in the global namespace,
9056 arguments can be evaluated.
9062 Can also be used as a |method|: >
9077 Can also be used as a |method|: >
9087 {retvar} if specified. {retvar} must be a string with the
9098 < Can also be used as a |method|: >
9111 < Can also be used as a |method|: >
9126 Note: Any errors will be reported in the server and may mess
9137 Can also be used as a |method|: >
9145 Can also be used as a |method|: >
9164 Can also be used as a |method|: >
9192 Can also be used as a |method|: >
9205 Can also be used as a |method|: >
9224 Can also be used as a |method|: >
9229 {object} can be a |List| or a |Blob|.
9233 < Can also be used as a |method|: >
9249 Can also be used as a |method|: >
9266 Can also be used as a |method|: >
9273 arbitrary number that can only be used to compare to the
9276 Can also be used as a |method|: >
9285 encodings it may only be the first byte.
9286 This is mainly to be used for testing.
9289 Can also be used as a |method|: >
9296 This is mainly to be used for testing.
9299 Can also be used as a |method|: >
9328 be 1 and "endcol" can be 8.
9329 The "curscol" value is where the cursor would be placed. For
9330 a Tab it would be the same as "endcol", while for a double
9331 width character it would be the same as "col".
9337 Can also be used as a |method|: >
9353 This is mainly to be used for testing.
9356 Can also be used as a |method|: >
9381 cursor is moved. The 's' flag cannot be combined with the 'n'
9394 line will be found (unless wrapping around the end of the
9409 The value must not be negative. A zero value is like not
9415 non-zero this match is skipped. This can be used, for
9417 {skip} can be a string, which is evaluated as an expression, a
9428 The cursor will be positioned at the match, unless the 'n'
9460 Can also be used as a |method|: >
9487 If it exceeded 99 the result must be max count + 1 (100). If
9525 You can also update the search count, which can be useful in a
9539 This can also be used to count matched texts with specified
9550 {options} must be a |Dictionary|. It can contain:
9585 Can also be used as a |method|: >
9606 Can also be used as a |method|: >
9612 Search for the match of a nested start-end pair. This can be
9635 the match; will be > 1 when 'r' is used.
9642 match is to be skipped. E.g., because it is inside a comment
9647 {skip} can be a string, a lambda, a funcref or a partial.
9666 the character just before the "if 2", the "endif 1" will be
9667 found. That's because the "if 2" will be found first, and
9668 then this is considered to be a nested if/endif from "if 2" to
9671 it may be useful to put "\zs" at the end of the pattern, so
9680 < The cursor must be at or after the "if" for which a match is
9681 to be found. Note that single-quote strings are used to avoid
9691 match is to be found. To reject matches that syntax
9726 Can also be used as a |method|: >
9731 that sent a string can be retrieved with expand("<client>").
9735 This id has to be stored before the next command can be
9742 < Can also be used as a |method|: >
9763 {text} can be a string to set one line, or a list of strings
9770 When {lnum} is just below the last line the {text} will be
9777 Can also be used as a |method|, the base is passed as the
9789 Note that the variable name without "b:" must be used.
9795 Can also be used as a |method|, the base is passed as the
9810 and "high" can be the same, in which case this refers to one
9816 Only characters with value 0x100 and higher can be used.
9837 Can also be used as a |method|: >
9844 char character which will be used for a subsequent
9853 This can be useful to save/restore a user's character search
9860 Can also be used as a |method|: >
9878 Can also be used as a |method|: >
9893 Can also be used as a |method|: >
9904 Can also be used as a |method|, the base is passed as the
9910 {mode} must be a string with 9 characters. It is of the form
9923 Can also be used as a |method|: >
9935 When {lnum} is just below the last line the {text} will be
9937 {text} can be any type or a List of any type, each item is
9947 will be set to the items in the list. Example: >
9956 Can also be used as a |method|, the base is passed as the
9962 {nr} can be the window number or the |window-ID|.
9976 Can also be used as a |method|, the base is passed as the
9988 Can also be used as a |method|: >
9997 {list} must be a |List| with four or five numbers:
10001 "bufnum" is the buffer number. Zero can be used for the
10027 the marks to be effectively be swapped, so that '< is always
10030 Returns 0 when the position could be set, -1 otherwise.
10041 Can also be used as a |method|: >
10053 item must be a dictionary. Non-dictionary items in {list} are
10057 bufnr buffer number; must be the number of a valid
10061 module name of a module; if given it will be used in
10074 optional. Either "lnum" or "pattern" entry can be used to
10078 item will not be handled as an error line.
10080 be used.
10083 If you supply an empty {list}, the quickfix list will be
10094 with the items from {list}. This can also be used to
10107 The following items can be specified in dictionary {what}:
10129 quickfix window. The value can be the name of
10136 is modified. When creating a new quickfix list, "nr" can be
10139 list is modified, "id" should be used instead of "nr" to
10149 This function can be used to create a quickfix list
10153 Can also be used as a |method|, the base is passed as the
10162 {regname} must be one character.
10164 {value} may be any value returned by |getreg()| or
10213 < Can also be used as a |method|, the base is passed as the
10221 Note that autocommands are blocked, side effects may not be
10223 Note that the variable name without "t:" must be used.
10227 Can also be used as a |method|, the base is passed as the
10236 {winnr} can be the window number or the |window-ID|.
10238 Note that autocommands are blocked, side effects may not be
10243 Note that the variable name without "w:" must be used.
10249 Can also be used as a |method|, the base is passed as the
10255 {nr} can be the window number or the |window-ID|.
10286 Can also be used as a |method|, the base is passed as the
10296 < Can also be used as a |method|, the base is passed as the
10304 Can also be used as a |method|: >
10323 items such as "!", "%", "#" and "<cword>" will be preceded by
10324 a backslash. This backslash will be removed again by the |:!|
10327 The "!" character will be escaped (again with a |non-zero-arg|
10336 The "\" character will be escaped when 'shell' contains "fish"
10347 Can also be used as a |method|: >
10360 no {col} argument is given, column 1 will be assumed.
10362 Can also be used as a |method|: >
10372 {filename} designates the current directory, this will be
10385 Can also be used as a |method|: >
10397 Can also be used as a |method|: >
10413 Can also be used as a |method|: >
10427 Can also be used as a |method|: >
10448 collation locale. |v:collate| can also be used to check the
10462 When {func} is given and it is 'n' then all items will be
10465 Funcrefs will be considered as being 0).
10467 When {func} is given and it is 'N' then all items will be
10469 digits will be used as the number they represent.
10471 When {func} is given and it is 'f' then all items will be
10472 sorted numerical. All values must be a Number or a Float.
10480 {dict} is for functions with the "dict" attribute. It will be
10488 Can also be used as a |method|: >
10518 are used. On Ubuntu they may be found in
10521 < On MS-Windows, {name} can be SystemAsterisk, SystemDefault,
10539 Returns the sound ID, which can be passed to `sound_stop()`.
10540 Returns zero if the sound could not be played.
10542 Can also be used as a |method|: >
10550 must be a full path. On Ubuntu you may find files to play
10554 < Can also be used as a |method|: >
10561 Stop playing sound {id}. {id} must be previously returned by
10570 Can also be used as a |method|: >
10579 soundfolding. 'spell' must be set. When no sound folding is
10581 This can be used for making spelling suggestions. Note that
10582 the method can be quite slow.
10584 Can also be used as a |method|: >
10612 Can also be used as a |method|: >
10622 suggestions with a leading capital will be given. Use this
10625 {word} can be a badly spelled word followed by other text.
10630 {word} may also be a good word. Similar words will then be
10637 Can also be used as a |method|: >
10659 Splitting a table where the first element can be empty: >
10663 Can also be used as a |method|: >
10676 "nan" may be different, it depends on system libraries.
10678 Can also be used as a |method|: >
10689 - If {expr} is given it must be a Number. It is used to
10701 work that may not always be safe. Roughly this works like:
10709 your autocommand, check with `state()` if the work can be
10714 When {what} is given only characters in this string will be
10751 Can also be used as a |method|: >
10769 < Can also be used as a |method|: >
10775 {base} is the conversion base, it can be 2, 8, 10 or 16.
10780 a leading zero doesn't cause octal conversion to be used, as
10785 different base the result will be zero. Similarly, when
10790 Can also be used as a |method|: >
10802 Can also be used as a |method|: >
10819 Can also be used as a |method|: >
10849 Can also be used as a |method|: >
10865 Can also be used as a |method|: >
10876 The language can be changed with the |:language| command.
10887 < Can also be used as a |method|: >
10896 Can also be used as a |method|: >
10903 This can be used to find a second match: >
10918 Can also be used as a |method|: >
10924 can be parsed back with |eval()|.
10938 Can also be used as a |method|: >
10953 Can also be used as a |method|: >
10975 < Note: To get the first character, {start} must be 0. For
10979 Can also be used as a |method|: >
10992 If the {timestring} cannot be parsed with {format} zero is
11006 Can also be used as a |method|: >
11016 ignored. This can be used to find a match before a previous
11030 Can also be used as a |method|: >
11041 Can also be used as a |method|: >
11052 Can also be used as a |method|: >
11073 the current (deepest) call can be obtained.
11081 Can also be used as a |method|: >
11088 replaced. Otherwise {flags} should be "".
11125 < Can also be used as a |method|: >
11147 Can also be used as a |method|: >
11157 Can also be used as a |method|: >
11163 The syntax ID can be used with |synIDattr()| and
11169 that's where the cursor can be in Insert mode, synID() returns
11177 Warning: This function can be very slow. Best speed is
11186 syntax ID {synID}. This can be used to obtain information
11188 {mode} can be "gui", "cterm" or "term", to get the attributes
11221 Can also be used as a |method|: >
11231 Can also be used as a |method|: >
11240 is 1, the second item contains the text which will be
11298 When prepended by |:silent| the terminal will not be set to
11299 cooked mode. This is meant to be used for commands that do
11309 This is not to be used for interactive commands.
11327 The command will be executed in "cooked" mode, so that a
11330 The resulting error code can be found in |v:shell_error|.
11339 Can also be used as a |method|: >
11357 Can also be used as a |method|: >
11364 {arg} specifies the number of the tab page to be used. When
11374 Can also be used as a |method|: >
11387 The number can be used with the |:tab| command.
11392 {tabarg} specifies the number of tab page to be used.
11395 the window which will be used when going to this tab page.
11403 Can also be used as a |method|: >
11416 {filename} should be the full path of the file.
11433 More entries may be present, depending on the content of the
11440 The ex-command "cmd" can be either an ex search pattern, a
11445 To get an exact tag match, the anchors '^' and '$' should be
11454 Can also be used as a |method|: >
11467 Can also be used as a |method|: >
11483 Can also be used as a |method|: >
11491 doesn't exist. It can be used for a temporary file. The name
11495 < For Unix, the file will be in a private directory |tempfile|.
11508 is empty most values here will be 'u' for unknown.
11519 If "cursor_style" is 'y' then |t_RS| will be sent to request the
11521 If "cursor_blink_mode" is 'y' then |t_RC| will be sent to
11527 When "underline_rgb" is not 'y', then |t_8u| will be made empty.
11559 Can also be used as a |method|: >
11567 the callback to be invoked almost immediately if enough time
11570 Pausing a timer is useful to avoid the callback to be called
11577 Can also be used as a |method|: >
11588 busy or Vim is not waiting for input the time will be longer.
11590 {callback} is the function to call. It can be the name of a
11600 the callback will be called once.
11615 Can also be used as a |method|: >
11622 Stop a timer. The timer callback will no longer be invoked.
11623 {timer} is an ID returned by timer_start(), thus it must be a
11626 Can also be used as a |method|: >
11632 Stop all timers. The timer callbacks will no longer be
11643 Can also be used as a |method|: >
11651 Can also be used as a |method|: >
11668 Can also be used as a |method|: >
11698 Can also be used as a |method|: >
11713 Can also be used as a |method|: >
11733 For backward compatibility, this method can be used: >
11745 < Can also be used as a |method|: >
11757 Return the name of the undo file that would be used for a file
11769 Can also be used as a |method|: >
11800 and where further changes will be added.
11804 be used by a redo command. When nothing was
11823 Can also be used as a |method|: >
11830 Can also be used as a |method|: >
11837 would be of unlimited width. When there is a <Tab> at the
11838 position, the returned Number will be the column at the end of
11843 When 'virtualedit' is used {expr} can be [lnum, col, off], where
11848 beyond the end of the line can be returned. |'virtualedit'|
11860 Note that only marks in the current file can be used.
11870 < Can also be used as a |method|: >
11889 a non-empty String, then the Visual mode will be cleared and
11895 This can be used in mappings to handle the 'wildcharm' option
11905 The window will temporarily be made the current window,
11907 executing {command} autocommands will be triggered, this may
11919 Can also be used as a |method|, the base is passed as the
11927 Can also be used as a |method|: >
11937 Return zero if the window cannot be found.
11939 Can also be used as a |method|: >
11963 Can also be used as a |method|: >
11969 Return TRUE if successful, FALSE if the window cannot be found.
11971 Can also be used as a |method|: >
11977 Return [0, 0] if the window cannot be found.
11979 Can also be used as a |method|: >
11984 Return 0 if the window cannot be found in the current tabpage.
11986 Can also be used as a |method|: >
11993 {nr} can be the window number or the |window-ID|. Use zero
11995 Returns [0, 0] if the window cannot be found in the current
11998 Can also be used as a |method|: >
12007 Both {nr} and {target} can be window numbers or |window-ID|s.
12008 Both must be in the current tab page.
12021 Can also be used as a |method|: >
12027 associated with window {nr}. {nr} can be the window number or
12035 Can also be used as a |method|: >
12052 {nr} can be the window number or the |window-ID|.
12060 < Can also be used as a |method|: >
12093 Can also be used as a |method|: >
12100 If the cursor was moved the view on the file will be updated
12123 The number can be used with |CTRL-W_w| and ":wincmd w"
12131 < Can also be used as a |method|: >
12150 settings won't be restored. So you can use: >
12159 If the window size changed the result won't be the same.
12161 Can also be used as a |method|: >
12190 {nr} can be the window number or the |window-ID|.
12202 Can also be used as a |method|: >
12231 item is separated with a NL. Each list item must be a String
12234 not be a NL after the last list item. An empty item at the
12255 Inserting CR characters needs to be done before passing {list}
12259 error message if the file can't be created or when writing
12266 < Can also be used as a |method|: >
12276 Can also be used as a |method|: >
12294 < Note that it's possible for patch 248 to be omitted even though 249 is
12326 clipboard_working Compiled with 'clipboard' support and it can be used.
12331 compatible Compiled to be very Vi compatible.
12332 conpty Platform where |ConPTY| can be used.
12533 line break for the pattern. It can be matched with a "\n" in the pattern, or
12550 New functions can be defined. These can be called just like builtin
12552 commands can be executed with the |:normal| command.
12567 can only be called from within the script and from functions, user commands
12569 function from a mapping defined in the script, but then |<SID>| must be used
12578 {name} can also be a |Dictionary| entry that is a
12602 The name must be made of alphanumeric characters and
12609 {name} can also be a |Dictionary| entry that is a
12612 < "dict" must be an existing dictionary. The entry
12616 function can only be used with a |Funcref| and will be
12622 that was previously defined in that script will be
12628 an existing function to be replaced unexpectedly,
12630 NOTE: In Vim9 script script-local functions cannot be
12649 be invoked through an entry in a |Dictionary|. The
12650 local variable "self" will then be set to the
12677 will not be changed by the function. This also
12686 [argument] can be:
12696 To be able to define a function inside an `:execute`
12703 {name} can also be a |Dictionary| entry that is a
12728 An argument can be defined by giving its name. In the function this can then
12729 be used as "a:name" ("a:" for argument).
12731 Up to 20 arguments can be given, separated by commas. After the named
12732 arguments an argument "..." can be specified, which means that more arguments
12733 may optionally be following. In the function the extra arguments can be used
12735 can be 0). "a:000" is set to a |List| that contains these arguments. Note
12738 The a: scope and the variables in it cannot be changed, they are fixed.
12782 but not the other way around. They must be prefixed with "a:", as with all
12792 When not using "...", the number of arguments in a function call must be at
12794 number of arguments may be larger than the total of mandatory and optional
12798 Inside a function local variables can be used. These will disappear when the
12799 function returns. Global variables need to be accessed with "g:".
12812 This function can then be called with: >
12824 This function can then be called with: >
12833 are as specified with `:function`. Up to 20 arguments can be
12852 can be used to do something different at the start or end of
12865 When the function returns a composite value it can be further
12866 dereferenced, but the range will not be used then. Example: >
12878 A function can also be called as part of evaluating an expression or when it
12901 function(s) to be defined. Example: >
12914 exactly the right file name. A function that can be autoloaded has a name
12919 These functions are always global, in Vim9 script "g:" needs to be used: >
12932 exactly, and the defined function must have the name exactly as it will be
12933 called. In Vim9 script the "g:" prefix must be used: >
12950 However, when the autoload script was already loaded it won't be loaded again
12954 be used to pass settings to the autoload script before it's loaded: >
12959 Note that when you make a mistake and call a function that is supposed to be
12962 the autoload script it won't be automatically loaded again. Either restart
12983 "noisy", then the reference would be to "my_noisy_variable", whereas if
12984 "adjective" was set to "quiet", then it would be to "my_quiet_variable".
13033 must be a valid index in that list. For nested list
13034 the index can be repeated.
13035 This cannot be used to add an item to a |List|.
13036 This cannot be used to set a byte in a String. You
13039 < When {var-name} is a |Blob| then {idx} can be the
13046 the expression {expr1}, which must be a list with the
13048 {idx1} can be omitted, zero is used instead.
13049 {idx2} can be omitted, meaning the end of the list.
13051 end of the list, items will be added.
13073 causes it to be deleted. Many systems do not make a
13084 {reg-name}. {reg-name} must be a single letter, and
13085 must be the name of a writable register (see
13086 |registers|). "@@" can be used for the unnamed
13089 register will be linewise, otherwise it will be set to
13091 This can be used to clear the last search pattern: >
13112 < When the code does not exist yet it will be created as
13144 Each name can be one of the items of the ":let"
13214 Cannot be followed by another command, but can be
13217 To avoid line continuation to be applied, consider
13239 variable names may be given. Special names recognized
13259 names can be given, they are all removed. The name
13260 may also be a |List| or |Dictionary| item.
13263 One or more items from a |List| can be removed: >
13266 < One item from a |Dictionary| can be removed at a time: >
13302 literal then the items also cannot be changed: >
13316 register values cannot be used here, since they cannot
13317 be locked.
13326 it can no longer be changed (until it is unlocked).
13327 A locked variable can be deleted: >
13354 or |Dictionary| the values cannot be changed.
13368 and you lock one of them, the |List| will also be
13399 < The commands still need to be parsed to find the
13439 each item in {object}. {object} can be a |List| or
13450 Thus the current item can be removed without effect.
13451 Removing any later item means it will not be found.
13466 Like ":for" above, but each item in {listlist} must be
13514 can be caught as if it were thrown by a |:throw|
13548 Another character can be used instead of / around the
13578 (which may be found in a calling function or sourcing
13584 < Note that "catch" may need to be on a separate line
13595 Cannot be followed by a comment.
13612 Cannot be followed by a comment.
13637 otherwise all following echo's will be highlighted.
13658 script or function the line number will be added.
13684 The command can be shortened to `:ev` or `:eva`, but
13685 these are hard to recognize and therefore not to be
13688 The command cannot be followed by "|" and another
13700 Cannot be followed by a comment.
13705 ":execute" can be used to append a command to commands
13716 file names. The |fnameescape()| function can be used
13722 Note: The executed string may be any command-line, but
13727 "continue" should not be inside ":execute".
13743 ":execute", ":echo" and ":echon" cannot be followed by
13753 explains how it can be used in a Vim script.
13755 Exceptions may be raised by Vim on an error or on interrupt, see
13762 Exceptions can be caught or can cause cleanup code to be executed. You can
13764 a finally clause (to be executed for cleanup).
13768 be none or multiple catch clauses, but there is at most one finally clause,
13769 which must not be followed by any catch clauses. The lines before the catch
13791 appropriate actions. Exceptions from the try block may be caught. Exceptions
13809 the ":endtry" are not executed and the exception might be caught elsewhere,
13817 exception might, however, be caught elsewhere, see |try-nesting|.
13823 clause is propagated and can be caught elsewhere, see |try-nesting|.
13846 Try conditionals can be nested arbitrarily. That is, a complete try
13847 conditional can be put into the try block, a catch clause, or the finally
13881 and pass the value to be thrown as argument: >
13890 An exception might be thrown during evaluation of the argument of the ":throw"
13915 Any other command that takes an expression as argument might also be
13929 Exceptions can be caught by a try conditional with one or more |:catch|
13930 commands, see |try-conditionals|. The values to be caught by each ":catch"
13931 command can be specified as a pattern argument. The subsequent catch clause
13968 You may also be interested where an exception was thrown. This is stored in
14018 An exception that is not caught by a try conditional can be caught by
14038 You can catch an exception and throw a new one to be caught elsewhere from the
14075 Note that this method cannot be used to "rethrow" Vim error or interrupt
14121 This method should be used locally whenever a function or part of a script
14122 changes global settings which need to be restored on failure or normal exit of
14195 If you want to catch specific errors, you just have to put the code to be
14197 presence of the try conditional causes all errors to be converted to an
14234 Some error messages may be produced by different commands: >
14286 be executed and cause errors not related to writing, for instance: >
14290 There could even be such errors you are not responsible for as a script
14349 For testing what happens when CTRL-C would be pressed on a specific line in
14399 Exceptions may be used during execution of autocommands. Example: >
14407 :autocmd User x echo "Should not be displayed"
14425 :autocmd BufWritePre * echo "Should not be displayed"
14444 is thrown that can be caught by the caller of the command.
14488 autocommands will be catchable by the caller of the command: >
14491 :autocmd BufWritePost * echo "Should not be displayed"
14500 For some commands, the normal action can be replaced by a sequence of
14501 autocommands. Exceptions from that sequence will be catchable by the caller
14570 parentheses can be cut out from |v:exception| with the ":substitute" command.
14647 or ":endif". On the other hand, errors should be catchable as exceptions
14653 be caught only from an active try conditional. If you want an immediate
14703 The ":try", ":catch", ":finally", and ":endtry" commands can be put on
14811 The |:scriptnames| command can be used to get a list of all script files that
14814 code can be used: >
14841 commands, functions, variable types, etc. Each individual feature can be
14846 explicit the |:scriptversion| command can be used. When a Vim script is not
14853 command. Can be used to go back to old syntax for a range of lines.
14865 < All |vim-variable|s must be prefixed by "v:". E.g. "version" doesn't
14866 work as |v:version| anymore, it can be used as a normal variable.
14887 < The quotes must be surrounded by digits.
14912 To execute a command only when the |+eval| feature is disabled can be done in
14935 'foldtext' options may be evaluated in a sandbox. This means that you are
14959 have to be done in the sandbox to avoid a security risk. But the sandbox is
14968 option will still be marked as it was set in the sandbox.