adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): Whitespace updates

Browse Source 
Use double sentence spacing and wrap lines at 'textwidth'.  Code
examples and tables were not wrapped unless this had already been done
locally.

closes: #18453

Signed-off-by: Doug Kearns <dougkearns@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Doug Kearns
2025-10-12 15:31:11 +00:00
committed by Christian Brabandt
parent 2a33b499a3
commit c58f91c035
64 changed files with 1576 additions and 1497 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
runtime/doc/autocmd.txt
View File

@ -1,4 +1,4 @@
*autocmd.txt* For Vim version 9.1. Last change: 2025 Sep 14 *autocmd.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -236,7 +236,7 @@ autocmds.
*:autocmd-verbose* *:autocmd-verbose*
When 'verbose' is non-zero, listing an autocommand will also display where it When 'verbose' is non-zero, listing an autocommand will also display where it
was last defined. Example: > was last defined. Example: >
:verbose autocmd BufEnter :verbose autocmd BufEnter
FileExplorer BufEnter FileExplorer BufEnter
@ -344,7 +344,8 @@ Name triggered by ~
|GUIEnter| after starting the GUI successfully |GUIEnter| after starting the GUI successfully
|GUIFailed| after starting the GUI failed |GUIFailed| after starting the GUI failed
|TermResponse| after the terminal response to |t_RV| is received |TermResponse| after the terminal response to |t_RV| is received
|TermResponseAll| after the terminal response to |t_RV| and others is received |TermResponseAll| after the terminal response to |t_RV| and others is
received
|QuitPre| when using `:quit`, before deciding whether to exit |QuitPre| when using `:quit`, before deciding whether to exit
|ExitPre| when using a command that may make Vim exit |ExitPre| when using a command that may make Vim exit
@ -381,7 +382,8 @@ Name triggered by ~
|FocusGained| Vim got input focus |FocusGained| Vim got input focus
|FocusLost| Vim lost input focus |FocusLost| Vim lost input focus
|CursorHold| the user doesn't press a key for a while |CursorHold| the user doesn't press a key for a while
|CursorHoldI| the user doesn't press a key for a while in Insert mode |CursorHoldI| the user doesn't press a key for a while in Insert
mode
|CursorMoved| the cursor was moved in Normal mode |CursorMoved| the cursor was moved in Normal mode
|CursorMovedC| the cursor was moved in the |Command-line| |CursorMovedC| the cursor was moved in the |Command-line|
|CursorMovedI| the cursor was moved in Insert mode |CursorMovedI| the cursor was moved in Insert mode
@ -566,7 +568,8 @@ BufWinEnter After a buffer is displayed in a window. This
since it reloads that buffer. since it reloads that buffer.
Does not happen for a terminal window, because Does not happen for a terminal window, because
it starts in Terminal-Job mode and Normal mode it starts in Terminal-Job mode and Normal mode
commands won't work. Use |TerminalOpen| instead. commands won't work. Use |TerminalOpen|
instead.
*BufWinLeave* *BufWinLeave*
BufWinLeave Before a buffer is removed from a window. BufWinLeave Before a buffer is removed from a window.
Not when it's still visible in another window. Not when it's still visible in another window.
@ -679,7 +682,7 @@ ColorScheme After loading a color scheme. |:colorscheme|
Not triggered if the color scheme is not Not triggered if the color scheme is not
found. found.
The pattern is matched against the The pattern is matched against the
colorscheme name. <afile> can be used for the colorscheme name. <afile> can be used for the
name of the actual file where this option was name of the actual file where this option was
set, and <amatch> for the new colorscheme set, and <amatch> for the new colorscheme
name. name.
@ -748,7 +751,7 @@ CursorHold When the user doesn't press a key for the time
triggered. |q| triggered. |q|
*<CursorHold>* *<CursorHold>*
Internally the autocommand is triggered by the Internally the autocommand is triggered by the
<CursorHold> key. In an expression mapping <CursorHold> key. In an expression mapping
|getchar()| may see this character. |getchar()| may see this character.
Note: Interactive commands cannot be used for Note: Interactive commands cannot be used for
@ -1014,7 +1017,7 @@ InsertLeave Just after leaving Insert mode. Also when
using CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|. using CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|.
*KeyInputPre* *KeyInputPre*
KeyInputPre Just before a key is processed after mappings KeyInputPre Just before a key is processed after mappings
have been applied. The pattern is matched have been applied. The pattern is matched
against a string that indicates the current against a string that indicates the current
mode, which is the same as what is returned by mode, which is the same as what is returned by
`mode(1)`. `mode(1)`.
@ -1046,7 +1049,7 @@ MenuPopup Just before showing the popup menu (under the
c Command line c Command line
tl Terminal tl Terminal
*ModeChanged* *ModeChanged*
ModeChanged After changing the mode. The pattern is ModeChanged After changing the mode. The pattern is
matched against `'old_mode:new_mode'`, for matched against `'old_mode:new_mode'`, for
example match against `*:c*` to simulate example match against `*:c*` to simulate
|CmdlineEnter|. |CmdlineEnter|.
@ -1082,7 +1085,7 @@ OptionSet After setting an option. The pattern is
|v:option_oldlocal| is only set when |:set| |v:option_oldlocal| is only set when |:set|
or |:setlocal| or a |modeline| was used to set or |:setlocal| or a |modeline| was used to set
the option. Similarly |v:option_oldglobal| is the option. Similarly |v:option_oldglobal| is
only set when |:set| or |:setglobal| was used. only set when |:set| or |:setglobal| was used.
This does not set |<abuf>|, you could use This does not set |<abuf>|, you could use
@ -1090,10 +1093,10 @@ OptionSet After setting an option. The pattern is
Note that when setting a |global-local| string Note that when setting a |global-local| string
option with |:set|, then |v:option_old| is the option with |:set|, then |v:option_old| is the
old global value. However, for all other kinds old global value. However, for all other
of options (local string options, global-local kinds of options (local string options,
number options, ...) it is the old local global-local number options, ...) it is the
value. old local value.
OptionSet is not triggered on startup and for OptionSet is not triggered on startup and for
the 'key' option for obvious reasons. the 'key' option for obvious reasons.
@ -1105,7 +1108,7 @@ OptionSet After setting an option. The pattern is
Note: It's a bad idea to reset an option Note: It's a bad idea to reset an option
during this autocommand, this may break a during this autocommand, this may break a
plugin. You can always use `:noa` to prevent plugin. You can always use `:noa` to prevent
triggering this autocommand. triggering this autocommand.
When using |:set| in the autocommand the event When using |:set| in the autocommand the event
@ -1130,7 +1133,7 @@ QuickFixCmdPre Before a quickfix command is run (|:make|,
*QuickFixCmdPost* *QuickFixCmdPost*
QuickFixCmdPost Like QuickFixCmdPre, but after a quickfix QuickFixCmdPost Like QuickFixCmdPre, but after a quickfix
command is run, before jumping to the first command is run, before jumping to the first
location. For |:cfile| and |:lfile| commands location. For |:cfile| and |:lfile| commands
it is run after the error file is read and it is run after the error file is read and
before moving to the first error. before moving to the first error.
See |QuickFixCmdPost-example|. See |QuickFixCmdPost-example|.
@ -1174,7 +1177,7 @@ SafeState When nothing is pending, going to wait for the
screen was scrolled for messages. screen was scrolled for messages.
*SafeStateAgain* *SafeStateAgain*
SafeStateAgain Like SafeState but after processing any SafeStateAgain Like SafeState but after processing any
messages and invoking callbacks. This may be messages and invoking callbacks. This may be
triggered often, don't do something that takes triggered often, don't do something that takes
time. time.
@ -1278,12 +1281,12 @@ TermChanged After the value of 'term' has changed. Useful
settings. Executed for all loaded buffers. settings. Executed for all loaded buffers.
*TerminalOpen* *TerminalOpen*
TerminalOpen Just after a terminal buffer was created, with TerminalOpen Just after a terminal buffer was created, with
`:terminal` or |term_start()|. This event is `:terminal` or |term_start()|. This event is
triggered even if the buffer is created triggered even if the buffer is created
without a window, with the ++hidden option. without a window, with the ++hidden option.
*TerminalWinOpen* *TerminalWinOpen*
TerminalWinOpen Just after a terminal buffer was created, with TerminalWinOpen Just after a terminal buffer was created, with
`:terminal` or |term_start()|. This event is `:terminal` or |term_start()|. This event is
triggered only if the buffer is created triggered only if the buffer is created
with a window. Can be used to set window with a window. Can be used to set window
local options for the terminal window. local options for the terminal window.
@ -1480,7 +1483,7 @@ WinLeave Before leaving a window. If the window to be
Not used for ":qa" or ":q" when exiting Vim. Not used for ":qa" or ":q" when exiting Vim.
*WinNewPre* *WinNewPre*
WinNewPre Before creating a new window. Triggered WinNewPre Before creating a new window. Triggered
before commands that modify window layout by before commands that modify window layout by
creating a split. creating a split.
Not done when creating tab pages and for the Not done when creating tab pages and for the
@ -1789,8 +1792,8 @@ option will not cause any commands to be executed.
After applying the autocommands the modelines are After applying the autocommands the modelines are
processed, so that their settings overrule the processed, so that their settings overrule the
settings from autocommands, like what happens when settings from autocommands, like what happens when
editing a file. This is skipped when the <nomodeline> editing a file. This is skipped when the <nomodeline>
argument is present. You probably want to use argument is present. You probably want to use
<nomodeline> for events that are not used when loading <nomodeline> for events that are not used when loading
a buffer, such as |User|. a buffer, such as |User|.
Processing modelines is also skipped when no Processing modelines is also skipped when no
@ -1802,7 +1805,7 @@ option will not cause any commands to be executed.
loaded buffer. The current buffer is done last. loaded buffer. The current buffer is done last.
Note that [fname] is used to select the autocommands, Note that [fname] is used to select the autocommands,
not the buffers to which they are applied. Example: > not the buffers to which they are applied. Example: >
augroup mine augroup mine
autocmd! autocmd!
autocmd FileType * echo expand('<amatch>') autocmd FileType * echo expand('<amatch>')

643
runtime/doc/builtin.txt
View File

File diff suppressed because it is too large Load Diff

64
runtime/doc/change.txt
View File

@ -1,4 +1,4 @@
*change.txt* For Vim version 9.1. Last change: 2025 Aug 06 *change.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -101,7 +101,7 @@ An exception for the d{motion} command: If the motion is not linewise, the
start and end of the motion are not in the same line, and there are only start and end of the motion are not in the same line, and there are only
blanks before the start and there are no non-blanks after the end of the blanks before the start and there are no non-blanks after the end of the
motion, the delete becomes linewise. This means that the delete also removes motion, the delete becomes linewise. This means that the delete also removes
the line of blanks that you might expect to remain. Use the |o_v| operator to the line of blanks that you might expect to remain. Use the |o_v| operator to
force the motion to be characterwise or remove the "z" flag from 'cpoptions' force the motion to be characterwise or remove the "z" flag from 'cpoptions'
(see |cpo-z|) to disable this peculiarity. (see |cpo-z|) to disable this peculiarity.
@ -382,7 +382,7 @@ CTRL-A Add [count] to the number or alphabetic character at
*v_g_CTRL-A* *v_g_CTRL-A*
{Visual}g CTRL-A Add [count] to the number or alphabetic character in {Visual}g CTRL-A Add [count] to the number or alphabetic character in
the highlighted text. If several lines are the highlighted text. If several lines are
highlighted, each one will be incremented by an highlighted, each one will be incremented by an
additional [count] (so effectively creating a additional [count] (so effectively creating a
[count] incrementing sequence). [count] incrementing sequence).
@ -413,7 +413,7 @@ CTRL-X Subtract [count] from the number or alphabetic
< <
*v_g_CTRL-X* *v_g_CTRL-X*
{Visual}g CTRL-X Subtract [count] from the number or alphabetic {Visual}g CTRL-X Subtract [count] from the number or alphabetic
character in the highlighted text. If several lines character in the highlighted text. If several lines
are highlighted, each value will be decremented by an are highlighted, each value will be decremented by an
additional [count] (so effectively creating a [count] additional [count] (so effectively creating a [count]
decrementing sequence). decrementing sequence).
@ -866,7 +866,7 @@ the |substitute()| function with the following exceptions:
- magic is always set without regard to 'magic'. - magic is always set without regard to 'magic'.
- A ~ inserts a tilde literally. - A ~ inserts a tilde literally.
- <CR> and \r inserts a carriage-return (CTRL-M). - <CR> and \r inserts a carriage-return (CTRL-M).
- \<CR> does not have a special meaning. It's just one of \x. - \<CR> does not have a special meaning. It's just one of \x.
Examples: > Examples: >
:s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx" :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx"
@ -878,7 +878,7 @@ Examples: >
Note: "\L\u" can be used to capitalize the first letter of a word. This is Note: "\L\u" can be used to capitalize the first letter of a word. This is
not compatible with Vi and older versions of Vim, where the "\u" would cancel not compatible with Vi and older versions of Vim, where the "\u" would cancel
out the "\L". Same for "\U\l". out the "\L". Same for "\U\l".
Note: In previous versions CTRL-V was handled in a special way. Since this is Note: In previous versions CTRL-V was handled in a special way. Since this is
not Vi compatible, this was removed. Use a backslash instead. not Vi compatible, this was removed. Use a backslash instead.
@ -950,7 +950,7 @@ real <NL> character (which will be a NUL in the file).
The "\=" notation can also be used inside the third argument {sub} of The "\=" notation can also be used inside the third argument {sub} of
|substitute()| function. In this case, the special meaning for characters as |substitute()| function. In this case, the special meaning for characters as
mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and
<NL> are interpreted not as a line break but as a carriage-return and a <NL> are interpreted not as a line break but as a carriage-return and a
new-line respectively. new-line respectively.
@ -1092,7 +1092,7 @@ inside of strings can change! Also see 'softtabstop' option. >
with `zp`. (for {Visual} see |Visual-mode|) with `zp`. (for {Visual} see |Visual-mode|)
*:y* *:yank* *E850* *:y* *:yank* *E850*
:[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the :[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the
"* or "+ registers is possible only when the "* or "+ registers is possible only when the
|+clipboard| feature is included. |+clipboard| feature is included.
@ -1173,9 +1173,9 @@ inside of strings can change! Also see 'softtabstop' option. >
or 'a'. or 'a'.
["x]zp or *zp* *zP* ["x]zp or *zp* *zP*
["x]zP Like "p" and "P", except without adding trailing spaces ["x]zP Like "p" and "P", except without adding trailing
when pasting a block. Thus the inserted text will not spaces when pasting a block. Thus the inserted text
always be a rectangle. Especially useful in will not always be a rectangle. Especially useful in
combination with |v_zy|. combination with |v_zy|.
You can use these commands to copy text from one place to another. Do this You can use these commands to copy text from one place to another. Do this
@ -1210,7 +1210,7 @@ With |p| the previously selected text is put in the unnamed register (and
possibly the selection and/or clipboard). This is useful if you want to put possibly the selection and/or clipboard). This is useful if you want to put
that text somewhere else. But you cannot repeat the same change. that text somewhere else. But you cannot repeat the same change.
With |P| the unnamed register is not changed (and neither the selection or With |P| the unnamed register is not changed (and neither the selection or
clipboard), you can repeat the same change. But the deleted text cannot be clipboard), you can repeat the same change. But the deleted text cannot be
used. If you do need it you can use |p| with another register. E.g., yank used. If you do need it you can use |p| with another register. E.g., yank
the text to copy, Visually select the text to replace and use "0p . You can the text to copy, Visually select the text to replace and use "0p . You can
repeat this as many times as you like, and the unnamed register will be repeat this as many times as you like, and the unnamed register will be
@ -1291,8 +1291,8 @@ text is less than one line (the small delete register is used then). An
exception is made for the delete operator with these movement commands: |%|, exception is made for the delete operator with these movement commands: |%|,
|(|, |)|, |`|, |/|, |?|, |n|, |N|, |{| and |}|. |(|, |)|, |`|, |/|, |?|, |n|, |N|, |{| and |}|.
Register "1 is always used then (this is Vi compatible). The "- register is Register "1 is always used then (this is Vi compatible). The "- register is
used as well if the delete is within a line. Note that these characters may be used as well if the delete is within a line. Note that these characters may
mapped. E.g. |%| is mapped by the matchit plugin. be mapped. E.g. |%| is mapped by the matchit plugin.
With each successive deletion or change, Vim shifts the previous contents With each successive deletion or change, Vim shifts the previous contents
of register 1 into register 2, 2 into 3, and so forth, losing the previous of register 1 into register 2, 2 into 3, and so forth, losing the previous
contents of register 9. contents of register 9.
@ -1608,11 +1608,11 @@ type of comment string. A part consists of:
e End of a three-piece comment e End of a three-piece comment
l Left align. Used together with 's' or 'e', the leftmost character of l Left align. Used together with 's' or 'e', the leftmost character of
start or end will line up with the leftmost character from the middle. start or end will line up with the leftmost character from the middle.
This is the default and can be omitted. See below for more details. This is the default and can be omitted. See below for more details.
r Right align. Same as above but rightmost instead of leftmost. See r Right align. Same as above but rightmost instead of leftmost. See
below for more details. below for more details.
O Don't consider this comment for the "O" command. O Don't consider this comment for the "O" command.
@ -1624,8 +1624,8 @@ type of comment string. A part consists of:
{digits} {digits}
When together with 's' or 'e': add {digit} amount of offset to an When together with 's' or 'e': add {digit} amount of offset to an
automatically inserted middle or end comment leader. The offset begins automatically inserted middle or end comment leader. The offset
from a left alignment. See below for more details. begins from a left alignment. See below for more details.
-{digits} -{digits}
Like {digits} but reduce the indent. This only works when there is Like {digits} but reduce the indent. This only works when there is
@ -1664,7 +1664,7 @@ part which is longer, the end part is used. This makes a C style comment work
without requiring the middle part to end with a space. without requiring the middle part to end with a space.
Here is an example of alignment flags at work to make a comment stand out Here is an example of alignment flags at work to make a comment stand out
(kind of looks like a 1 too). Consider comment string: > (kind of looks like a 1 too). Consider comment string: >
:set comments=sr:/***,m:**,ex-2:******/ :set comments=sr:/***,m:**,ex-2:******/
< <
/*** ~ /*** ~
@ -1675,7 +1675,7 @@ offset 2 spaces for the "-2" flag--->** ~
In this case, the first comment was typed, then return was pressed 4 times, In this case, the first comment was typed, then return was pressed 4 times,
then "/" was pressed to end the comment. then "/" was pressed to end the comment.
Here are some finer points of three part comments. There are three times when Here are some finer points of three part comments. There are three times when
alignment and offset flags are taken into consideration: opening a new line alignment and offset flags are taken into consideration: opening a new line
after a start-comment, opening a new line before an end-comment, and after a start-comment, opening a new line before an end-comment, and
automatically ending a three-piece comment. The end alignment flag has a automatically ending a three-piece comment. The end alignment flag has a
@ -1686,11 +1686,11 @@ will override the "r" and "l" flag.
Enabling 'cindent' will override the alignment flags in many cases. Enabling 'cindent' will override the alignment flags in many cases.
Reindenting using a different method like |gq| or |=| will not consult Reindenting using a different method like |gq| or |=| will not consult
alignment flags either. The same behaviour can be defined in those other alignment flags either. The same behaviour can be defined in those other
formatting options. One consideration is that 'cindent' has additional options formatting options. One consideration is that 'cindent' has additional
for context based indenting of comments but cannot replicate many three piece options for context based indenting of comments but cannot replicate many
indent alignments. However, 'indentexpr' has the ability to work better with three piece indent alignments. However, 'indentexpr' has the ability to work
three piece comments. better with three piece comments.
Other examples: > Other examples: >
"b:*" Includes lines starting with "*", but not if the "*" is "b:*" Includes lines starting with "*", but not if the "*" is
@ -1787,7 +1787,7 @@ B When joining lines, don't insert a space between two multibyte
1 Don't break a line after a one-letter word. It's broken before it 1 Don't break a line after a one-letter word. It's broken before it
instead (if possible). instead (if possible).
*fo-]* *fo-]*
] Respect 'textwidth' rigorously. With this flag set, no line can be ] Respect 'textwidth' rigorously. With this flag set, no line can be
longer than 'textwidth', unless line-break-prohibition rules make this longer than 'textwidth', unless line-break-prohibition rules make this
impossible. Mainly for CJK scripts and works only if 'encoding' is impossible. Mainly for CJK scripts and works only if 'encoding' is
"utf-8". "utf-8".
@ -1825,8 +1825,8 @@ is when the 'a' flag is present. |auto-format|
Note that when 'paste' is on, Vim does no formatting at all. Note that when 'paste' is on, Vim does no formatting at all.
Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping; Note that 'textwidth' can be non-zero even if Vim never performs
'textwidth' is still useful for formatting with "gq". auto-wrapping; 'textwidth' is still useful for formatting with "gq".
If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some
built in stuff to treat these types of comments a bit more cleverly. built in stuff to treat these types of comments a bit more cleverly.
@ -1913,8 +1913,8 @@ Also see |:uniq|.
*:sort-l* *:sort-l*
With [l] sort uses the current collation locale. With [l] sort uses the current collation locale.
Implementation details: strcoll() is used to compare Implementation details: strcoll() is used to compare
strings. See |:language| to check or set the collation strings. See |:language| to check or set the collation
locale. Example: > locale. Example: >
:language collate en_US.UTF-8 :language collate en_US.UTF-8
:%sort l :%sort l
< |v:collate| can also used to check the current locale. < |v:collate| can also used to check the current locale.
@ -1930,7 +1930,7 @@ Also see |:uniq|.
With [f] sorting is done on the Float in the line. With [f] sorting is done on the Float in the line.
The value of Float is determined similar to passing The value of Float is determined similar to passing
the text (after or inside a {pattern} match) to the text (after or inside a {pattern} match) to
str2float() function. This option is available only str2float() function. This option is available only
if Vim was compiled with Floating point support. if Vim was compiled with Floating point support.
With [x] sorting is done on the first hexadecimal With [x] sorting is done on the first hexadecimal

64
runtime/doc/channel.txt
View File

@ -1,4 +1,4 @@
*channel.txt* For Vim version 9.1. Last change: 2024 Jul 17 *channel.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -89,7 +89,8 @@ The number will increase every time you send a message.
The server can send a command to Vim. Type this on T1 (literally, including The server can send a command to Vim. Type this on T1 (literally, including
the quotes): the quotes):
["ex","echo 'hi there'"] ~ ["ex","echo 'hi there'"] ~
And you should see the message in Vim. You can move the cursor a word forward: And you should see the message in Vim. You can move the cursor a word
forward:
["normal","w"] ~ ["normal","w"] ~
To handle asynchronous communication a callback needs to be used: > To handle asynchronous communication a callback needs to be used: >
@ -234,7 +235,7 @@ what you want! Stopping the job with job_stop() might be better.
All readahead is discarded, callbacks will no longer be invoked. All readahead is discarded, callbacks will no longer be invoked.
Note that a channel is closed in three stages: Note that a channel is closed in three stages:
- The I/O ends, log message: "Closing channel". There can still be queued - The I/O ends, log message: "Closing channel". There can still be queued
messages to read or callbacks to invoke. messages to read or callbacks to invoke.
- The readahead is cleared, log message: "Clearing channel". Some variables - The readahead is cleared, log message: "Clearing channel". Some variables
may still reference the channel. may still reference the channel.
@ -478,7 +479,7 @@ To read from the error output use the "part" option:
{"part": "err"} ~ {"part": "err"} ~
To read a message with a specific ID, on a JS or JSON channel: To read a message with a specific ID, on a JS or JSON channel:
{"id": 99} ~ {"id": 99} ~
When no ID is specified or the ID is -1, the first message is returned. This When no ID is specified or the ID is -1, the first message is returned. This
overrules any callback waiting for this message. overrules any callback waiting for this message.
For a RAW channel this returns whatever is available, since Vim does not know For a RAW channel this returns whatever is available, since Vim does not know
@ -571,7 +572,8 @@ ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()*
Return type: dict<any> or |String| Return type: dict<any> or |String|
ch_getbufnr({handle}, {what}) *ch_getbufnr()* ch_getbufnr({handle}, {what}) *ch_getbufnr()*
Get the buffer number that {handle} is using for String {what}. Get the buffer number that {handle} is using for String
{what}.
{handle} can be a Channel or a Job that has a Channel. {handle} can be a Channel or a Job that has a Channel.
{what} can be "err" for stderr, "out" for stdout or empty for {what} can be "err" for stderr, "out" for stdout or empty for
socket output. socket output.
@ -728,7 +730,7 @@ ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()*
{handle} can be a Channel or a Job that has a Channel. {handle} can be a Channel or a Job that has a Channel.
When using the "lsp" channel mode, {expr} must be a |Dict|. When using the "lsp" channel mode, {expr} must be a |Dict|.
If the channel mode is "lsp", then returns a Dict. Otherwise If the channel mode is "lsp", then returns a Dict. Otherwise
returns an empty String. If the "callback" item is present in returns an empty String. If the "callback" item is present in
{options}, then the returned Dict contains the ID of the {options}, then the returned Dict contains the ID of the
request message. The ID can be used to send a cancellation request message. The ID can be used to send a cancellation
@ -813,12 +815,12 @@ been received and not parsed correctly.
If the command produces a line of output that you want to deal with, specify If the command produces a line of output that you want to deal with, specify
a handler for stdout: > a handler for stdout: >
let job = job_start(command, {"out_cb": "MyHandler"}) let job = job_start(command, {"out_cb": "MyHandler"})
The function will be called with the channel and a message. You would define The function will be called with the channel and a message. You would define
it like this: > it like this: >
func MyHandler(channel, msg) func MyHandler(channel, msg)
Without the handler you need to read the output with |ch_read()| or Without the handler you need to read the output with |ch_read()| or
|ch_readraw()|. You can do this in the close callback, see |read-in-close-cb|. |ch_readraw()|. You can do this in the close callback, see |read-in-close-cb|.
Note that if the job exits before you read the output, the output may be lost. Note that if the job exits before you read the output, the output may be lost.
This depends on the system (on Unix this happens because closing the write end This depends on the system (on Unix this happens because closing the write end
@ -856,7 +858,7 @@ To run a job that reads from a buffer: >
\ {'in_io': 'buffer', 'in_name': 'mybuffer'}) \ {'in_io': 'buffer', 'in_name': 'mybuffer'})
< <
*E915* *E918* *E915* *E918*
The buffer is found by name, similar to |bufnr()|. The buffer must exist and The buffer is found by name, similar to |bufnr()|. The buffer must exist and
be loaded when job_start() is called. be loaded when job_start() is called.
By default this reads the whole buffer. This can be changed with the "in_top" By default this reads the whole buffer. This can be changed with the "in_top"
@ -933,7 +935,8 @@ job_info([{job}]) *job_info()*
Returns a Dictionary with information about {job}: Returns a Dictionary with information about {job}:
"status" what |job_status()| returns "status" what |job_status()| returns
"channel" what |job_getchannel()| returns "channel" what |job_getchannel()| returns
"cmd" List of command arguments used to start the job "cmd" List of command arguments used to start the
job
"process" process ID "process" process ID
"tty_in" terminal input name, empty when none "tty_in" terminal input name, empty when none
"tty_out" terminal output name, empty when none "tty_out" terminal output name, empty when none
@ -985,11 +988,11 @@ job_start({command} [, {options}]) *job_start()*
passed to execvp(). Arguments in double quotes can contain passed to execvp(). Arguments in double quotes can contain
white space. white space.
{command} can be a List, where the first item is the executable {command} can be a List, where the first item is the
and further items are the arguments. All items are converted executable and further items are the arguments. All items are
to String. This works best on Unix. converted to String. This works best on Unix.
On MS-Windows, job_start() makes a GUI application hidden. If On MS-Windows, job_start() makes a GUI application hidden. If
you want to show it, use |:!start| instead. you want to show it, use |:!start| instead.
The command is executed directly, not through a shell, the The command is executed directly, not through a shell, the
@ -1311,7 +1314,7 @@ To get the status of a job: >
To make a job stop running: > To make a job stop running: >
job_stop(job) job_stop(job)
This is the normal way to end a job. On Unix it sends a SIGTERM to the job. This is the normal way to end a job. On Unix it sends a SIGTERM to the job.
It is possible to use other ways to stop the job, or even send arbitrary It is possible to use other ways to stop the job, or even send arbitrary
signals. E.g. to force a job to stop, "kill it": > signals. E.g. to force a job to stop, "kill it": >
job_stop(job, "kill") job_stop(job, "kill")
@ -1327,10 +1330,10 @@ If you want to type input for the job in a Vim window you have a few options:
- Use a terminal window. This works well if what you type goes directly to - Use a terminal window. This works well if what you type goes directly to
the job and the job output is directly displayed in the window. the job and the job output is directly displayed in the window.
See |terminal-window|. See |terminal-window|.
- Use a window with a prompt buffer. This works well when entering a line for - Use a window with a prompt buffer. This works well when entering a line for
the job in Vim while displaying (possibly filtered) output from the job. the job in Vim while displaying (possibly filtered) output from the job.
A prompt buffer is created by setting 'buftype' to "prompt". You would A prompt buffer is created by setting 'buftype' to "prompt". You would
normally only do that in a newly created buffer. normally only do that in a newly created buffer.
The user can edit and enter one line of text at the very last line of the The user can edit and enter one line of text at the very last line of the
@ -1339,8 +1342,8 @@ buffer. When pressing Enter in the prompt line the callback set with
Another callback would receive the output from the job and display it in the Another callback would receive the output from the job and display it in the
buffer, below the prompt (and above the next prompt). buffer, below the prompt (and above the next prompt).
Only the text in the last line, after the prompt, is editable. The rest of the Only the text in the last line, after the prompt, is editable. The rest of
buffer is not modifiable with Normal mode commands. It can be modified by the buffer is not modifiable with Normal mode commands. It can be modified by
calling functions, such as |append()|. Using other commands may mess up the calling functions, such as |append()|. Using other commands may mess up the
buffer. buffer.
@ -1348,8 +1351,8 @@ After setting 'buftype' to "prompt" Vim does not automatically start Insert
mode, use `:startinsert` if you want to enter Insert mode, so that the user mode, use `:startinsert` if you want to enter Insert mode, so that the user
can start typing a line. can start typing a line.
The text of the prompt can be set with the |prompt_setprompt()| function. If The text of the prompt can be set with the |prompt_setprompt()| function. If
no prompt is set with |prompt_setprompt()|, "% " is used. You can get the no prompt is set with |prompt_setprompt()|, "% " is used. You can get the
effective prompt text for a buffer, with |prompt_getprompt()|. effective prompt text for a buffer, with |prompt_getprompt()|.
The user can go to Normal mode and navigate through the buffer. This can be The user can go to Normal mode and navigate through the buffer. This can be
@ -1357,7 +1360,7 @@ useful to see older output or copy text.
The CTRL-W key can be used to start a window command, such as CTRL-W w to The CTRL-W key can be used to start a window command, such as CTRL-W w to
switch to the next window. This also works in Insert mode (use Shift-CTRL-W switch to the next window. This also works in Insert mode (use Shift-CTRL-W
to delete a word). When leaving the window Insert mode will be stopped. When to delete a word). When leaving the window Insert mode will be stopped. When
coming back to the prompt window Insert mode will be restored. coming back to the prompt window Insert mode will be restored.
Any command that starts Insert mode, such as "a", "i", "A" and "I", will move Any command that starts Insert mode, such as "a", "i", "A" and "I", will move
@ -1476,7 +1479,7 @@ To open a channel using the 'lsp' mode, set the 'mode' item in the |ch_open()|
let ch = ch_open(..., #{mode: 'lsp'}) let ch = ch_open(..., #{mode: 'lsp'})
To open a channel using the 'lsp' mode with a job, set the 'in_mode' and To open a channel using the 'lsp' mode with a job, set the 'in_mode' and
'out_mode' items in the |job_start()| {options} argument to 'lsp'. Example: > 'out_mode' items in the |job_start()| {options} argument to 'lsp'. Example: >
let cmd = ['clangd', '--background-index', '--clang-tidy'] let cmd = ['clangd', '--background-index', '--clang-tidy']
let opts = {} let opts = {}
@ -1494,8 +1497,8 @@ formats appropriately or you should use a separate callback function for
"out_cb" and "err_cb" to handle them as shown above. "out_cb" and "err_cb" to handle them as shown above.
To synchronously send a JSON-RPC request to the server, use the To synchronously send a JSON-RPC request to the server, use the
|ch_evalexpr()| function. This function will wait and return the decoded |ch_evalexpr()| function. This function will wait and return the decoded
response message from the server. You can use either the |channel-timeout| or response message from the server. You can use either the |channel-timeout| or
the 'timeout' field in the {options} argument to control the response wait the 'timeout' field in the {options} argument to control the response wait
time. If the request times out, then an empty |Dict| is returned. Example: > time. If the request times out, then an empty |Dict| is returned. Example: >
@ -1509,9 +1512,10 @@ time. If the request times out, then an empty |Dict| is returned. Example: >
... <handle failure> ... <handle failure>
endif endif
Note that in the request message the 'id' field should not be specified. If it Note that in the request message the 'id' field should not be specified. If
is specified, then Vim will overwrite the value with an internally generated it is specified, then Vim will overwrite the value with an internally
identifier. Vim currently supports only a number type for the 'id' field. generated identifier. Vim currently supports only a number type for the 'id'
field.
The callback function will be invoked for both a successful and a failed RPC The callback function will be invoked for both a successful and a failed RPC
request. request.
@ -1549,14 +1553,14 @@ for the request. Example: >
call ch_sendexpr(ch, notif) call ch_sendexpr(ch, notif)
To send a JSON-RPC notification message to the server, use the |ch_sendexpr()| To send a JSON-RPC notification message to the server, use the |ch_sendexpr()|
function. As the server will not send a response message to the notification, function. As the server will not send a response message to the notification,
don't specify the "callback" item. Example: > don't specify the "callback" item. Example: >
call ch_sendexpr(ch, #{method: 'initialized'}) call ch_sendexpr(ch, #{method: 'initialized'})
To respond to a JSON-RPC request message from the server, use the To respond to a JSON-RPC request message from the server, use the
|ch_sendexpr()| function. In the response message, copy the 'id' field value |ch_sendexpr()| function. In the response message, copy the 'id' field value
from the server request message. Example: > from the server request message. Example: >
let resp = {} let resp = {}
let resp.id = req.id let resp.id = req.id

27
runtime/doc/cmdline.txt
View File

@ -1,4 +1,4 @@
*cmdline.txt* For Vim version 9.1. Last change: 2025 Sep 24 *cmdline.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -162,7 +162,8 @@ CTRL-R {register} *c_CTRL-R* *c_<C-R>*
the last delete or yank the last delete or yank
'%' the current file name '%' the current file name
'#' the alternate file name '#' the alternate file name
'*' the clipboard contents (X11: primary selection) '*' the clipboard contents (X11: primary
selection)
'+' the clipboard contents '+' the clipboard contents
'/' the last search pattern '/' the last search pattern
':' the last command-line ':' the last command-line
@ -440,7 +441,8 @@ CTRL-D List names that match the pattern in front of the cursor.
<S-Tab> does not work everywhere. <S-Tab> does not work everywhere.
*c_CTRL-N* *c_CTRL-N*
CTRL-N After using 'wildchar' which got multiple matches, go to next CTRL-N After using 'wildchar' which got multiple matches, go to next
match. Otherwise recall more recent command-line from history. match. Otherwise recall more recent command-line from
history.
*c_CTRL-P* *c_CTRL-P*
CTRL-P After using 'wildchar' which got multiple matches, go to CTRL-P After using 'wildchar' which got multiple matches, go to
previous match. Otherwise recall older command-line from previous match. Otherwise recall older command-line from
@ -728,9 +730,9 @@ See also |`=|.
*:_!* *:_!*
The '!' (bang) character after an Ex command makes the command behave in a The '!' (bang) character after an Ex command makes the command behave in a
different way. The '!' should be placed immediately after the command, without different way. The '!' should be placed immediately after the command,
any blanks in between. If you insert blanks the '!' will be seen as an without any blanks in between. If you insert blanks the '!' will be seen as
argument for the command, which has a different meaning. For example: an argument for the command, which has a different meaning. For example:
:w! name write the current buffer to file "name", overwriting :w! name write the current buffer to file "name", overwriting
any existing file any existing file
:w !name send the current buffer as standard input to command :w !name send the current buffer as standard input to command
@ -1105,8 +1107,9 @@ Note: these are typed literally, they are not special keys!
*filename-modifiers* *filename-modifiers*
*:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs* *::S* *:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs* *::S*
*%:8* *%:p* *%:.* *%:~* *%:h* *%:t* *%:r* *%:e* *%:s* *%:gs* *%:S* *%:8* *%:p* *%:.* *%:~* *%:h* *%:t* *%:r* *%:e* *%:s* *%:gs* *%:S*
The file name modifiers can be used after "%", "#", "#n", "<cfile>", "<sfile>", The file name modifiers can be used after "%", "#", "#n", "<cfile>",
"<afile>" or "<abuf>". They are also used with the |fnamemodify()| function. "<sfile>", "<afile>" or "<abuf>". They are also used with the |fnamemodify()|
function.
These modifiers can be given, in this order: These modifiers can be given, in this order:
:p Make file name a full path. Must be the first modifier. Also :p Make file name a full path. Must be the first modifier. Also
@ -1159,7 +1162,7 @@ These modifiers can be given, in this order:
Substitute all occurrences of "pat" with "sub". Otherwise Substitute all occurrences of "pat" with "sub". Otherwise
this works like ":s". this works like ":s".
:S Escape special characters for use with a shell command (see :S Escape special characters for use with a shell command (see
|shellescape()|). Must be the last one. Examples: > |shellescape()|). Must be the last one. Examples: >
:!dir <cfile>:S :!dir <cfile>:S
:call system('chmod +w -- ' .. expand('%:S')) :call system('chmod +w -- ' .. expand('%:S'))
@ -1240,9 +1243,9 @@ Therefore "\file\foo" is a valid file name, you don't have to type the
backslash twice. backslash twice.
An exception is the '$' sign. It is a valid character in a file name. But An exception is the '$' sign. It is a valid character in a file name. But
to avoid a file name like "$home" to be interpreted as an environment variable, to avoid a file name like "$home" to be interpreted as an environment
it needs to be preceded by a backslash. Therefore you need to use "/\$home" variable, it needs to be preceded by a backslash. Therefore you need to use
for the file "$home" in the root directory. A few examples: "/\$home" for the file "$home" in the root directory. A few examples:
FILE NAME INTERPRETED AS ~ FILE NAME INTERPRETED AS ~
$home expanded to value of environment var $home $home expanded to value of environment var $home

34
runtime/doc/debug.txt
View File

@ -1,4 +1,4 @@
*debug.txt* For Vim version 9.1. Last change: 2025 Aug 10 *debug.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -71,8 +71,8 @@ some steps to provide a useful bug report.
3.1 GENERIC ~ 3.1 GENERIC ~
You must obtain the debugger symbols (PDB) file for your executable: gvim.pdb You must obtain the debugger symbols (PDB) file for your executable: gvim.pdb
for gvim.exe, or vim.pdb for vim.exe. The PDB should be available from the for gvim.exe, or vim.pdb for vim.exe. The PDB should be available from the
same place that you obtained the executable. Be sure to use the PDB that same place that you obtained the executable. Be sure to use the PDB that
matches the EXE (same date). matches the EXE (same date).
If you built the executable yourself with the Microsoft Visual C++ compiler, If you built the executable yourself with the Microsoft Visual C++ compiler,
@ -115,7 +115,7 @@ If you have a non-free version of Visual Studio, you can save a minidump via
the Debug menu and send it with the bug report. A minidump is a small file the Debug menu and send it with the bug report. A minidump is a small file
(<100KB), which contains information about the state of your process. (<100KB), which contains information about the state of your process.
Visual C++ 2005 Express Edition cannot save minidumps and it cannot be Visual C++ 2005 Express Edition cannot save minidumps and it cannot be
installed as a just-in-time debugger. Use WinDbg, |debug-windbg|, if you installed as a just-in-time debugger. Use WinDbg, |debug-windbg|, if you
need to save minidumps or you want a just-in-time (postmortem) debugger. need to save minidumps or you want a just-in-time (postmortem) debugger.
*debug-windbg* *debug-windbg*
@ -125,21 +125,21 @@ See |get-ms-debuggers| to obtain a copy of WinDbg.
As with the Visual Studio IDE, you can attach WinDbg to a running Vim process. As with the Visual Studio IDE, you can attach WinDbg to a running Vim process.
You can also have your system automatically invoke WinDbg as a postmortem You can also have your system automatically invoke WinDbg as a postmortem
debugger. To set WinDbg as your postmortem debugger, run "windbg -I". debugger. To set WinDbg as your postmortem debugger, run "windbg -I".
To attach WinDbg to a running Vim process, launch WinDbg. On the File menu, To attach WinDbg to a running Vim process, launch WinDbg. On the File menu,
choose Attach to a Process. Select the Vim process and click OK. choose Attach to a Process. Select the Vim process and click OK.
At this point, choose Symbol File Path on the File menu, and add the folder At this point, choose Symbol File Path on the File menu, and add the folder
containing your Vim PDB to the sympath. If you have Vim source available, containing your Vim PDB to the sympath. If you have Vim source available,
use Source File Path on the File menu. You can now open source files in WinDbg use Source File Path on the File menu. You can now open source files in
and set breakpoints, if you like. Reproduce your crash. WinDbg should open the WinDbg and set breakpoints, if you like. Reproduce your crash. WinDbg should
source file at the point of the crash. Using the View menu, you can examine open the source file at the point of the crash. Using the View menu, you can
the call stack, local variables, watch windows, and so on. examine the call stack, local variables, watch windows, and so on.
If WinDbg is your postmortem debugger, you do not need to attach WinDbg to If WinDbg is your postmortem debugger, you do not need to attach WinDbg to
your Vim process. Simply reproduce the crash and WinDbg will launch your Vim process. Simply reproduce the crash and WinDbg will launch
automatically. As above, set the Symbol File Path and the Source File Path. automatically. As above, set the Symbol File Path and the Source File Path.
To save a minidump, type the following at the WinDbg command line: > To save a minidump, type the following at the WinDbg command line: >
.dump vim.dmp .dump vim.dmp
@ -150,11 +150,11 @@ To save a minidump, type the following at the WinDbg command line: >
If you have a minidump file, you can open it in Visual Studio or in WinDbg. If you have a minidump file, you can open it in Visual Studio or in WinDbg.
In Visual Studio 2005: on the File menu, choose Open, then Project/Solution. In Visual Studio 2005: on the File menu, choose Open, then Project/Solution.
Navigate to the .dmp file and open it. Now press F5 to invoke the debugger. Navigate to the .dmp file and open it. Now press F5 to invoke the debugger.
Follow the instructions in |debug-vs2005| to set the Symbol File Path. Follow the instructions in |debug-vs2005| to set the Symbol File Path.
In WinDbg: choose Open Crash Dump on the File menu. Follow the instructions in In WinDbg: choose Open Crash Dump on the File menu. Follow the instructions
|debug-windbg| to set the Symbol File Path. in |debug-windbg| to set the Symbol File Path.
*get-ms-debuggers* *get-ms-debuggers*
3.5 Obtaining Microsoft Debugging Tools ~ 3.5 Obtaining Microsoft Debugging Tools ~

8
runtime/doc/debugger.txt
View File

@ -1,4 +1,4 @@
*debugger.txt* For Vim version 9.1. Last change: 2019 Dec 21 *debugger.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Gordon Prieur VIM REFERENCE MANUAL by Gordon Prieur
@ -51,9 +51,9 @@ Many debuggers mark specific lines by placing a small sign or color highlight
on the line. The |:sign| command lets the debugger set this graphic mark. Some on the line. The |:sign| command lets the debugger set this graphic mark. Some
examples where this feature would be used would be a debugger showing an arrow examples where this feature would be used would be a debugger showing an arrow
representing the Program Counter (PC) of the program being debugged. Another representing the Program Counter (PC) of the program being debugged. Another
example would be a small stop sign for a line with a breakpoint. These visible example would be a small stop sign for a line with a breakpoint. These
highlights let the user keep track of certain parts of the state of the visible highlights let the user keep track of certain parts of the state of
debugger. the debugger.
This feature can be used with more than debuggers, too. An IPE can use a sign This feature can be used with more than debuggers, too. An IPE can use a sign
to highlight build errors, searched text, or other things. The sign feature to highlight build errors, searched text, or other things. The sign feature

13
runtime/doc/diff.txt
View File

@ -1,4 +1,4 @@
*diff.txt* For Vim version 9.1. Last change: 2025 Sep 15 *diff.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -74,7 +74,8 @@ See `:diffoff` for an easy way to revert the options.
The differences shown are actually the differences in the buffer. Thus if you The differences shown are actually the differences in the buffer. Thus if you
make changes after loading a file, these will be included in the displayed make changes after loading a file, these will be included in the displayed
diffs. You might have to do ":diffupdate" now and then, not all changes are diffs. You might have to do ":diffupdate" now and then, not all changes are
immediately taken into account, especially when using an external diff command. immediately taken into account, especially when using an external diff
command.
In your .vimrc file you could do something special when Vim was started in In your .vimrc file you could do something special when Vim was started in
diff mode. You could use a construct like this: > diff mode. You could use a construct like this: >
@ -292,7 +293,7 @@ that the buffers will be equal within the specified range.
*do* *do*
[count]do Same as ":diffget" without range. The "o" stands for "obtain" [count]do Same as ":diffget" without range. The "o" stands for "obtain"
("dg" can't be used, it could be the start of "dgg"!). Note: ("dg" can't be used, it could be the start of "dgg"!). Note:
this doesn't work in Visual mode. this doesn't work in Visual mode.
If you give a [count], it is used as the [bufspec] argument If you give a [count], it is used as the [bufspec] argument
for ":diffget". for ":diffget".
@ -465,7 +466,7 @@ Also see 'diffopt' and the "diff" item of 'fillchars'.
*diff-slow* *diff_translations* *diff-slow* *diff_translations*
For very long lines, the diff syntax highlighting might be slow, especially For very long lines, the diff syntax highlighting might be slow, especially
since it tries to match all different kind of localisations. To disable since it tries to match all different kind of localisations. To disable
localisations and speed up the syntax highlighting, set the global variable localisations and speed up the syntax highlighting, set the global variable
g:diff_translations to zero: > g:diff_translations to zero: >
@ -547,7 +548,7 @@ The `redraw!` command may not be needed, depending on whether executing a
shell command shows something on the display or not. shell command shows something on the display or not.
If the 'diffexpr' expression starts with s: or |<SID>|, then it is replaced If the 'diffexpr' expression starts with s: or |<SID>|, then it is replaced
with the script ID (|local-function|). Example: > with the script ID (|local-function|). Example: >
set diffexpr=s:MyDiffExpr() set diffexpr=s:MyDiffExpr()
set diffexpr=<SID>SomeDiffExpr() set diffexpr=<SID>SomeDiffExpr()
Otherwise, the expression is evaluated in the context of the script where the Otherwise, the expression is evaluated in the context of the script where the
@ -608,7 +609,7 @@ directory are accidentally patched. Vim will also delete files starting with
v:fname_in and ending in ".rej" and ".orig". v:fname_in and ending in ".rej" and ".orig".
If the 'patchexpr' expression starts with s: or |<SID>|, then it is replaced If the 'patchexpr' expression starts with s: or |<SID>|, then it is replaced
with the script ID (|local-function|). Example: > with the script ID (|local-function|). Example: >
set patchexpr=s:MyPatchExpr() set patchexpr=s:MyPatchExpr()
set patchexpr=<SID>SomePatchExpr() set patchexpr=<SID>SomePatchExpr()
Otherwise, the expression is evaluated in the context of the script where the Otherwise, the expression is evaluated in the context of the script where the

4
runtime/doc/digraph.txt
View File

@ -1,4 +1,4 @@
*digraph.txt* For Vim version 9.1. Last change: 2025 Aug 16 *digraph.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -112,7 +112,7 @@ mode. After leaving the Insert mode everything is fine. On some Unix systems
this means you have to define the environment-variable LC_CTYPE. If you are this means you have to define the environment-variable LC_CTYPE. If you are
using csh, then put the following line in your .cshrc: > using csh, then put the following line in your .cshrc: >
setenv LC_CTYPE en_US.utf8 setenv LC_CTYPE en_US.utf8
(or similar for a different language or country). The value must be a valid (or similar for a different language or country). The value must be a valid
locale on your system, i.e. on Unix-like systems it must be present in the locale on your system, i.e. on Unix-like systems it must be present in the
output of > output of >
locale -a locale -a

54
runtime/doc/editing.txt
View File

@ -1,4 +1,4 @@
*editing.txt* For Vim version 9.1. Last change: 2025 Oct 11 *editing.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -134,11 +134,11 @@ set, Vim renames or copies the original file before it will be overwritten.
You can use this file if you discover that you need the original file. See You can use this file if you discover that you need the original file. See
also the 'patchmode' option. The name of the backup file is normally the same also the 'patchmode' option. The name of the backup file is normally the same
as the original file with 'backupext' appended. The default "~" is a bit as the original file with 'backupext' appended. The default "~" is a bit
strange to avoid accidentally overwriting existing files. If you prefer ".bak" strange to avoid accidentally overwriting existing files. If you prefer
change the 'backupext' option. Extra dots are replaced with '_' on MS-Windows ".bak" change the 'backupext' option. Extra dots are replaced with '_' on
machines, when Vim has detected that an MS-DOS-like filesystem is being used MS-Windows machines, when Vim has detected that an MS-DOS-like filesystem is
(e.g., messydos or crossdos) or when the 'shortname' option is on. The being used (e.g., messydos or crossdos) or when the 'shortname' option is on.
backup file can be placed in another directory by setting 'backupdir'. The backup file can be placed in another directory by setting 'backupdir'.
*auto-shortname* *auto-shortname*
Technical: On the Amiga you can use 30 characters for a file name. But on an Technical: On the Amiga you can use 30 characters for a file name. But on an
@ -297,7 +297,7 @@ CTRL-^ Edit the alternate file. Mostly the alternate file is
Mnemonic: "goto file". Mnemonic: "goto file".
Uses the 'isfname' option to find out which characters Uses the 'isfname' option to find out which characters
are supposed to be in a file name. Trailing are supposed to be in a file name. Trailing
punctuation characters ".,:;!" are ignored. Escaped punctuation characters ".,:;!" are ignored. Escaped
spaces "\ " are reduced to a single space. spaces "\ " are reduced to a single space.
Uses the 'path' option as a list of directory names to Uses the 'path' option as a list of directory names to
look for the file. See the 'path' option for details look for the file. See the 'path' option for details
@ -335,7 +335,7 @@ CTRL-^ Edit the alternate file. Mostly the alternate file is
the file. the file.
The file name and the number must be separated by a The file name and the number must be separated by a
non-filename (see 'isfname') and non-numeric non-filename (see 'isfname') and non-numeric
character. " line " is also recognized, like it is character. " line " is also recognized, like it is
used in the output of `:verbose command UserCmd` used in the output of `:verbose command UserCmd`
White space between the filename, the separator and White space between the filename, the separator and
the number are ignored. the number are ignored.
@ -387,7 +387,7 @@ is to use "path\[[]abc]", this matches the file "path\[abc]".
*starstar-wildcard* *starstar-wildcard*
Expanding "**" is possible on Unix, Win32, macOS and a few other systems (but Expanding "**" is possible on Unix, Win32, macOS and a few other systems (but
it may depend on your 'shell' setting on Unix and macOS. It's known to work it may depend on your 'shell' setting on Unix and macOS. It's known to work
correctly for zsh; for bash this requires at least bash version >= 4.X). correctly for zsh; for bash this requires at least bash version >= 4.X).
This allows searching a directory tree. This goes up to 100 directories deep. This allows searching a directory tree. This goes up to 100 directories deep.
Note there are some commands where this works slightly differently, see Note there are some commands where this works slightly differently, see
@ -400,7 +400,7 @@ Finds files:
a/b/c/d/ccc.txt ~ a/b/c/d/ccc.txt ~
When non-wildcard characters are used right before or after "**" these are When non-wildcard characters are used right before or after "**" these are
only matched in the top directory. They are not used for directories further only matched in the top directory. They are not used for directories further
down in the tree. For example: > down in the tree. For example: >
:n /usr/inc**/types.h :n /usr/inc**/types.h
Finds files: Finds files:
/usr/include/types.h ~ /usr/include/types.h ~
@ -418,9 +418,9 @@ argument, for example: >
Vim will run the command in backticks using the 'shell' and use the standard Vim will run the command in backticks using the 'shell' and use the standard
output as argument for the given Vim command (error messages from the shell output as argument for the given Vim command (error messages from the shell
command will be discarded). command will be discarded).
To see what shell command Vim is running, set the 'verbose' option to 4. When To see what shell command Vim is running, set the 'verbose' option to 4. When
the shell command returns a non-zero exit code, an error message will be the shell command returns a non-zero exit code, an error message will be
displayed and the Vim command will be aborted. To avoid this make the shell displayed and the Vim command will be aborted. To avoid this make the shell
always return zero like so: > always return zero like so: >
:next `find . -name ver\\*.c -print \|\| true` :next `find . -name ver\\*.c -print \|\| true`
@ -669,7 +669,7 @@ list of the current window.
[count] is used like with |:argadd|. [count] is used like with |:argadd|.
If the current file cannot be |abandon|ed {name}s will If the current file cannot be |abandon|ed {name}s will
still be added to the argument list, but won't be still be added to the argument list, but won't be
edited. No check for duplicates is done. edited. No check for duplicates is done.
Also see |++opt| and |+cmd|. Also see |++opt| and |+cmd|.
:[count]arga[dd] {name} ... *:arga* *:argadd* *E479* :[count]arga[dd] {name} ... *:arga* *:argadd* *E479*
@ -1429,7 +1429,7 @@ present in 'cpoptions' and "!" is not used in the command.
Also see |getcwd()|. Also see |getcwd()|.
*:pwd-verbose* *:pwd-verbose*
When 'verbose' is non-zero, |:pwd| will also display When 'verbose' is non-zero, |:pwd| will also display
what scope the current directory was set. Example: > what scope the current directory was set. Example: >
" Set by :cd " Set by :cd
:verbose pwd :verbose pwd
@ -1459,8 +1459,8 @@ When a |:tcd| command has been used for a tab page, the specified directory
becomes the current directory for the current tab page and the current window. becomes the current directory for the current tab page and the current window.
The current directory of other tab pages is not affected. When jumping to The current directory of other tab pages is not affected. When jumping to
another tab page, the current directory is changed to the last specified local another tab page, the current directory is changed to the last specified local
directory for that tab page. If the current tab has no local current directory directory for that tab page. If the current tab has no local current
the global current directory is used. directory the global current directory is used.
When a |:cd| command is used, the current window and tab page will lose the When a |:cd| command is used, the current window and tab page will lose the
local current directory and will use the global current directory from now on. local current directory and will use the global current directory from now on.
@ -1588,7 +1588,7 @@ To test for blowfish support you can use these conditions: >
has('crypt-blowfish') has('crypt-blowfish')
has('crypt-blowfish2') has('crypt-blowfish2')
This works since Vim 7.4.1099 while blowfish support was added earlier. This works since Vim 7.4.1099 while blowfish support was added earlier.
Thus the condition failing doesn't mean blowfish is not supported. You can Thus the condition failing doesn't mean blowfish is not supported. You can
test for blowfish with: > test for blowfish with: >
v:version >= 703 v:version >= 703
And for blowfish2 with: > And for blowfish2 with: >
@ -1652,7 +1652,7 @@ Notes:
algorithm in detail. algorithm in detail.
- The implementation of 'cryptmethod' "blowfish" has a flaw. It is possible - The implementation of 'cryptmethod' "blowfish" has a flaw. It is possible
to crack the first 64 bytes of a file and in some circumstances more of the to crack the first 64 bytes of a file and in some circumstances more of the
file. Use of it is not recommended, but it's still the strongest method file. Use of it is not recommended, but it's still the strongest method
supported by Vim 7.3 and 7.4. The "zip" method is even weaker. supported by Vim 7.3 and 7.4. The "zip" method is even weaker.
- Vim originates from the Netherlands. That is where the sources come from. - Vim originates from the Netherlands. That is where the sources come from.
Thus the encryption code is not exported from the USA. Thus the encryption code is not exported from the USA.
@ -1744,24 +1744,24 @@ ask if you really want to overwrite the file:
WARNING: The file has been changed since reading it!!! WARNING: The file has been changed since reading it!!!
Do you really want to write to it (y/n)? Do you really want to write to it (y/n)?
If you hit 'y' Vim will continue writing the file. If you hit 'n' the write is If you hit 'y' Vim will continue writing the file. If you hit 'n' the write
aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another is aborted. If you used ":wq" or "ZZ" Vim will not exit, you will get another
chance to write the file. chance to write the file.
The message would normally mean that somebody has written to the file after The message would normally mean that somebody has written to the file after
the edit session started. This could be another person, in which case you the edit session started. This could be another person, in which case you
probably want to check if your changes to the file and the changes from the probably want to check if your changes to the file and the changes from the
other person should be merged. Write the file under another name and check for other person should be merged. Write the file under another name and check
differences (the "diff" program can be used for this). for differences (the "diff" program can be used for this).
It is also possible that you modified the file yourself, from another edit It is also possible that you modified the file yourself, from another edit
session or with another command (e.g., a filter command). Then you will know session or with another command (e.g., a filter command). Then you will know
which version of the file you want to keep. which version of the file you want to keep.
The accuracy of the time check depends on the filesystem. On Unix it is The accuracy of the time check depends on the filesystem. On Unix it is
usually sub-second. With old file systems and on MS-Windows it is normally one usually sub-second. With old file systems and on MS-Windows it is normally
second. Use `has('nanotime')` to check if sub-second time stamp checks are one second. Use `has('nanotime')` to check if sub-second time stamp checks
available. are available.
There is one situation where you get the message while there is nothing wrong: There is one situation where you get the message while there is nothing wrong:
On a Win32 system on the day daylight saving time starts. There is something On a Win32 system on the day daylight saving time starts. There is something
@ -1791,8 +1791,8 @@ There are three different types of searching:
- It ONLY matches directories. - It ONLY matches directories.
- It matches up to 30 directories deep by default, so you can use it to - It matches up to 30 directories deep by default, so you can use it to
search an entire directory tree search an entire directory tree
- The maximum number of levels matched can be given by appending a number - The maximum number of levels matched can be given by appending a
to '**'. number to '**'.
Thus '/usr/**2' can match: > Thus '/usr/**2' can match: >
/usr /usr
/usr/include /usr/include

106
runtime/doc/eval.txt
View File

@ -1,4 +1,4 @@
*eval.txt* For Vim version 9.1. Last change: 2025 Sep 25 *eval.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -86,7 +86,7 @@ Job Used for a job, see |job_start()|. *Job* *Jobs*
Channel Used for a channel, see |ch_open()|. *Channel* *Channels* Channel Used for a channel, see |ch_open()|. *Channel* *Channels*
Blob Binary Large Object. Stores any sequence of bytes. See |Blob| Blob Binary Large Object. Stores any sequence of bytes. See |Blob|
for details for details
Example: 0zFF00ED015DAF Example: 0zFF00ED015DAF
0z is an empty Blob. 0z is an empty Blob.
@ -1020,7 +1020,7 @@ Blob modification ~
To change a specific byte of a blob use |:let| this way: > To change a specific byte of a blob use |:let| this way: >
:let blob[4] = 0x44 :let blob[4] = 0x44
When the index is just one beyond the end of the Blob, it is appended. Any When the index is just one beyond the end of the Blob, it is appended. Any
higher index is an error. higher index is an error.
To change a sequence of bytes the [:] notation can be used: > To change a sequence of bytes the [:] notation can be used: >
@ -1536,8 +1536,8 @@ byte under the cursor: >
In |Vim9| script: *E1147* *E1148* In |Vim9| script: *E1147* *E1148*
If expr10 is a String this results in a String that contains the expr1'th If expr10 is a String this results in a String that contains the expr1'th
single character (including any composing characters) from expr10. To use byte single character (including any composing characters) from expr10. To use
indexes use |strpart()|. byte indexes use |strpart()|.
Index zero gives the first byte or character. Careful: text column numbers Index zero gives the first byte or character. Careful: text column numbers
start with one! start with one!
@ -1595,7 +1595,7 @@ Examples: >
*slice* *slice*
If expr10 is a |List| this results in a new |List| with the items indicated by If expr10 is a |List| this results in a new |List| with the items indicated by
the indexes expr1a and expr1b. This works like with a String, as explained the indexes expr1a and expr1b. This works like with a String, as explained
just above. Also see |sublist| below. Examples: > just above. Also see |sublist| below. Examples: >
:let l = mylist[:3] " first four items :let l = mylist[:3] " first four items
:let l = mylist[4:4] " List with one item :let l = mylist[4:4] " List with one item
:let l = mylist[:] " shallow copy of a List :let l = mylist[:] " shallow copy of a List
@ -1786,8 +1786,8 @@ A string constant accepts these special characters:
Don't use <Char-xxxx> to get a UTF-8 character, use \uxxxx as Don't use <Char-xxxx> to get a UTF-8 character, use \uxxxx as
mentioned above. mentioned above.
\<*xxx> Like \<xxx> but prepends a modifier instead of including it in the \<*xxx> Like \<xxx> but prepends a modifier instead of including it in the
character. E.g. "\<C-w>" is one character 0x17 while "\<*C-w>" is four character. E.g. "\<C-w>" is one character 0x17 while "\<*C-w>" is
bytes: 3 for the CTRL modifier and then character "W". four bytes: 3 for the CTRL modifier and then character "W".
Note that "\xff" is stored as the byte 255, which may be invalid in some Note that "\xff" is stored as the byte 255, which may be invalid in some
encodings. Use "\u00ff" to store character 255 according to the current value encodings. Use "\u00ff" to store character 255 according to the current value
@ -2185,7 +2185,7 @@ variables for each buffer. Use local buffer variables instead |b:var|.
PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:* PREDEFINED VIM VARIABLES *vim-variable* *v:var* *v:*
*E963* *E1063* *E963* *E1063*
Most variables are read-only, when a variable can be set by the user, it will Most variables are read-only, when a variable can be set by the user, it will
be mentioned at the variable description below. The type cannot be changed. be mentioned at the variable description below. The type cannot be changed.
*v:argv* *argv-variable* *v:argv* *argv-variable*
v:argv The command line arguments Vim was invoked with. This is a v:argv The command line arguments Vim was invoked with. This is a
@ -2198,11 +2198,11 @@ v:beval_col The number of the column, over which the mouse pointer is.
Only valid while evaluating the 'balloonexpr' option. Only valid while evaluating the 'balloonexpr' option.
*v:beval_bufnr* *beval_bufnr-variable* *v:beval_bufnr* *beval_bufnr-variable*
v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only v:beval_bufnr The number of the buffer, over which the mouse pointer is.
valid while evaluating the 'balloonexpr' option. Only valid while evaluating the 'balloonexpr' option.
*v:beval_lnum* *beval_lnum-variable* *v:beval_lnum* *beval_lnum-variable*
v:beval_lnum The number of the line, over which the mouse pointer is. Only v:beval_lnum The number of the line, over which the mouse pointer is. Only
valid while evaluating the 'balloonexpr' option. valid while evaluating the 'balloonexpr' option.
*v:beval_text* *beval_text-variable* *v:beval_text* *beval_text-variable*
@ -2215,9 +2215,9 @@ v:beval_text The text under or after the mouse pointer. Usually a word as
Only valid while evaluating the 'balloonexpr' option. Only valid while evaluating the 'balloonexpr' option.
*v:beval_winnr* *beval_winnr-variable* *v:beval_winnr* *beval_winnr-variable*
v:beval_winnr The number of the window, over which the mouse pointer is. Only v:beval_winnr The number of the window, over which the mouse pointer is.
valid while evaluating the 'balloonexpr' option. The first Only valid while evaluating the 'balloonexpr' option. The
window has number zero (unlike most other places where a first window has number zero (unlike most other places where a
window gets a number). window gets a number).
*v:beval_winid* *beval_winid-variable* *v:beval_winid* *beval_winid-variable*
@ -2280,8 +2280,8 @@ v:collate The current locale setting for collation order of the runtime
See |multi-lang|. See |multi-lang|.
*v:colornames* *v:colornames*
v:colornames A dictionary that maps color names to hex color strings. These v:colornames A dictionary that maps color names to hex color strings.
color names can be used with the |highlight-guifg|, These color names can be used with the |highlight-guifg|,
|highlight-guibg|, and |highlight-guisp| parameters. |highlight-guibg|, and |highlight-guisp| parameters.
The key values in the dictionary (the color names) should be The key values in the dictionary (the color names) should be
@ -2289,20 +2289,20 @@ v:colornames A dictionary that maps color names to hex color strings. These
name. name.
Updating an entry in v:colornames has no immediate effect on Updating an entry in v:colornames has no immediate effect on
the syntax highlighting. The highlight commands (probably in a the syntax highlighting. The highlight commands (probably in
colorscheme script) need to be re-evaluated in order to use a colorscheme script) need to be re-evaluated in order to use
the updated color values. For example: > the updated color values. For example: >
:let v:colornames['fuscia'] = '#cf3ab4' :let v:colornames['fuscia'] = '#cf3ab4'
:let v:colornames['mauve'] = '#915f6d' :let v:colornames['mauve'] = '#915f6d'
:highlight Normal guifg=fuscia guibg=mauve :highlight Normal guifg=fuscia guibg=mauve
< <
This cannot be used to override the |cterm-colors| but it can This cannot be used to override the |cterm-colors| but it can
be used to override other colors. For example, the X11 colors be used to override other colors. For example, the X11 colors
defined in the `colors/lists/default.vim` (previously defined defined in the `colors/lists/default.vim` (previously defined
in |rgb.txt|). When defining new color names in a plugin, the in |rgb.txt|). When defining new color names in a plugin, the
recommended practice is to set a color entry only when it does recommended practice is to set a color entry only when it does
not already exist. For example: > not already exist. For example: >
:call extend(v:colornames, { :call extend(v:colornames, {
\ 'fuscia': '#cf3ab4', \ 'fuscia': '#cf3ab4',
@ -2310,20 +2310,20 @@ v:colornames A dictionary that maps color names to hex color strings. These
\ }, 'keep') \ }, 'keep')
< <
Using |extend()| with the 'keep' option updates each color only Using |extend()| with the 'keep' option updates each color only
if it did not exist in |v:colornames|. Doing so allows the if it did not exist in |v:colornames|. Doing so allows the
user to choose the precise color value for a common name user to choose the precise color value for a common name
by setting it in their |.vimrc|. by setting it in their |.vimrc|.
It is possible to remove entries from this dictionary but It is possible to remove entries from this dictionary but
doing so is NOT recommended, because it is disruptive to doing so is NOT recommended, because it is disruptive to
other scripts. It is also unlikely to achieve the desired other scripts. It is also unlikely to achieve the desired
result because the |:colorscheme| and |:highlight| commands result because the |:colorscheme| and |:highlight| commands
will both automatically load all `colors/lists/default.vim` will both automatically load all `colors/lists/default.vim`
color scripts. color scripts.
You can make changes to that file, but make sure to add new You can make changes to that file, but make sure to add new
keys instead of updating existing ones, otherwise Vim will skip keys instead of updating existing ones, otherwise Vim will
loading the file (thinking it hasn't been changed). skip loading the file (thinking it hasn't been changed).
*v:completed_item* *completed_item-variable* *v:completed_item* *completed_item-variable*
v:completed_item v:completed_item
@ -2426,7 +2426,7 @@ v:exception The value of the exception most recently caught and not
< Output: "caught oops". < Output: "caught oops".
*v:false* *false-variable* *v:false* *false-variable*
v:false A Number with value zero. Used to put "false" in JSON. See v:false A Number with value zero. Used to put "false" in JSON. See
|json_encode()|. |json_encode()|.
When used as a string this evaluates to "v:false". > When used as a string this evaluates to "v:false". >
echo v:false echo v:false
@ -2519,7 +2519,7 @@ v:foldstart Used for 'foldtext': first line of closed fold.
*v:hlsearch* *hlsearch-variable* *v:hlsearch* *hlsearch-variable*
v:hlsearch Variable that indicates whether search highlighting is on. v:hlsearch Variable that indicates whether search highlighting is on.
Setting it makes sense only if 'hlsearch' is enabled which Setting it makes sense only if 'hlsearch' is enabled which
requires |+extra_search|. Setting this variable to zero acts requires |+extra_search|. Setting this variable to zero acts
like the |:nohlsearch| command, setting it to one acts like > like the |:nohlsearch| command, setting it to one acts like >
let &hlsearch = &hlsearch let &hlsearch = &hlsearch
< Note that the value is restored when returning from a < Note that the value is restored when returning from a
@ -2587,7 +2587,7 @@ v:mouse_col Column number for a mouse click obtained with |getchar()|.
value is zero when there was no mouse button click. value is zero when there was no mouse button click.
*v:none* *none-variable* *None* *v:none* *none-variable* *None*
v:none An empty String. Used to put an empty item in JSON. See v:none An empty String. Used to put an empty item in JSON. See
|json_encode()|. |json_encode()|.
This can also be used as a function argument to use the This can also be used as a function argument to use the
default value, see |none-function_argument|. default value, see |none-function_argument|.
@ -2601,7 +2601,7 @@ v:none An empty String. Used to put an empty item in JSON. See
an error. Instead, use `is v:none` and `isnot v:none` . an error. Instead, use `is v:none` and `isnot v:none` .
*v:null* *null-variable* *v:null* *null-variable*
v:null An empty String. Used to put "null" in JSON. See v:null An empty String. Used to put "null" in JSON. See
|json_encode()|. |json_encode()|.
When used as a number this evaluates to zero. When used as a number this evaluates to zero.
When used as a string this evaluates to "v:null". > When used as a string this evaluates to "v:null". >
@ -2637,27 +2637,27 @@ v:oldfiles List of file names that is loaded from the |viminfo| file on
{only when compiled with the |+viminfo| feature} {only when compiled with the |+viminfo| feature}
*v:option_new* *v:option_new*
v:option_new New value of the option. Valid while executing an |OptionSet| v:option_new New value of the option. Valid while executing an |OptionSet|
autocommand. autocommand.
*v:option_old* *v:option_old*
v:option_old Old value of the option. Valid while executing an |OptionSet| v:option_old Old value of the option. Valid while executing an |OptionSet|
autocommand. Depending on the command used for setting and the autocommand. Depending on the command used for setting and
kind of option this is either the local old value or the the kind of option this is either the local old value or the
global old value. global old value.
*v:option_oldlocal* *v:option_oldlocal*
v:option_oldlocal v:option_oldlocal
Old local value of the option. Valid while executing an Old local value of the option. Valid while executing an
|OptionSet| autocommand. |OptionSet| autocommand.
*v:option_oldglobal* *v:option_oldglobal*
v:option_oldglobal v:option_oldglobal
Old global value of the option. Valid while executing an Old global value of the option. Valid while executing an
|OptionSet| autocommand. |OptionSet| autocommand.
*v:option_type* *v:option_type*
v:option_type Scope of the set command. Valid while executing an v:option_type Scope of the set command. Valid while executing an
|OptionSet| autocommand. Can be either "global" or "local" |OptionSet| autocommand. Can be either "global" or "local"
*v:option_command* *v:option_command*
v:option_command v:option_command
Command used to set the option. Valid while executing an Command used to set the option. Valid while executing an
|OptionSet| autocommand. |OptionSet| autocommand.
value option was set via ~ value option was set via ~
"setlocal" |:setlocal| or ":let l:xxx" "setlocal" |:setlocal| or ":let l:xxx"
@ -2704,7 +2704,7 @@ v:progpath Contains the command with which Vim was invoked, in a form
To get the full path use: > To get the full path use: >
echo exepath(v:progpath) echo exepath(v:progpath)
< If the command has a relative path it will be expanded to the < If the command has a relative path it will be expanded to the
full path, so that it still works after `:cd`. Thus starting full path, so that it still works after `:cd`. Thus starting
"./vim" results in "/home/user/path/to/vim/src/vim". "./vim" results in "/home/user/path/to/vim/src/vim".
On Linux and other systems it will always be the full path. On Linux and other systems it will always be the full path.
On Mac it may just be "vim" and using exepath() as mentioned On Mac it may just be "vim" and using exepath() as mentioned
@ -2871,9 +2871,9 @@ v:termresponse The escape sequence returned by the terminal for the |t_RV|
terminal. The TermResponseAll event is also fired, with terminal. The TermResponseAll event is also fired, with
<amatch> set to "version". You can use |terminalprops()| to <amatch> set to "version". You can use |terminalprops()| to
see what Vim figured out about the terminal. see what Vim figured out about the terminal.
The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c". Pp The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c".
is the terminal type: 0 for vt100 and 1 for vt220. Pv is the Pp is the terminal type: 0 for vt100 and 1 for vt220. Pv is
patch level (since this was introduced in patch 95, it's the patch level (since this was introduced in patch 95, it's
always 95 or higher). Pc is always zero. always 95 or higher). Pc is always zero.
If Pv is 141 or higher then Vim will try to request terminal If Pv is 141 or higher then Vim will try to request terminal
codes. This only works with xterm |xterm-codes|. codes. This only works with xterm |xterm-codes|.
@ -2882,7 +2882,7 @@ v:termresponse The escape sequence returned by the terminal for the |t_RV|
*v:termblinkresp* *termblinkresp-variable* *v:termblinkresp* *termblinkresp-variable*
v:termblinkresp The escape sequence returned by the terminal for the |t_RC| v:termblinkresp The escape sequence returned by the terminal for the |t_RC|
termcap entry. This is used to find out whether the terminal termcap entry. This is used to find out whether the terminal
cursor is blinking. This is used by |term_getcursor()|. When cursor is blinking. This is used by |term_getcursor()|. When
this variable is set, the TermResponseAll autocommand event is this variable is set, the TermResponseAll autocommand event is
fired, with <amatch> set to "cursorblink". fired, with <amatch> set to "cursorblink".
@ -2951,7 +2951,7 @@ v:throwpoint The point where the exception most recently caught and not
< Output: "Exception from test.vim, line 2" < Output: "Exception from test.vim, line 2"
*v:true* *true-variable* *v:true* *true-variable*
v:true A Number with value one. Used to put "true" in JSON. See v:true A Number with value one. Used to put "true" in JSON. See
|json_encode()|. |json_encode()|.
When used as a string this evaluates to "v:true". > When used as a string this evaluates to "v:true". >
echo v:true echo v:true
@ -2991,7 +2991,8 @@ v:vim_did_enter Zero until most of startup is done. It is set to one just
before |VimEnter| autocommands are triggered. before |VimEnter| autocommands are triggered.
*v:warningmsg* *warningmsg-variable* *v:warningmsg* *warningmsg-variable*
v:warningmsg Last given warning message. It's allowed to set this variable. v:warningmsg Last given warning message. It's allowed to set this
variable.
*v:wayland_display* *wayland_display-variable* *v:wayland_display* *wayland_display-variable*
v:wayland_display v:wayland_display
@ -3289,7 +3290,8 @@ text...
END END
< There can be multiple Vim expressions in a single line < There can be multiple Vim expressions in a single line
but an expression cannot span multiple lines. If any but an expression cannot span multiple lines. If any
expression evaluation fails, then the assignment fails. expression evaluation fails, then the assignment
fails.
{endmarker} must not contain white space. {endmarker} must not contain white space.
{endmarker} cannot start with a lower case character. {endmarker} cannot start with a lower case character.
@ -5212,7 +5214,7 @@ $VIMRUNTIME/plugin/openPlugin.vim
dist#vim9#Open(file: string) ~ dist#vim9#Open(file: string) ~
Opens `path` with the system default handler (macOS `open`, Windows Opens `path` with the system default handler (macOS `open`, Windows
`explorer.exe`, Linux `xdg-open`, …). If the variable |g:Openprg| exists the `explorer.exe`, Linux `xdg-open`, …). If the variable |g:Openprg| exists the
string specified in the variable is used instead. string specified in the variable is used instead.
The |:Open| user command uses file completion for its argument. The |:Open| user command uses file completion for its argument.
@ -5224,11 +5226,11 @@ This function is by default called using the gx mapping. In visual mode
tries to open the visually selected text. tries to open the visually selected text.
Associated setting variables: Associated setting variables:
`g:gx_word`: control how gx picks up the text under the cursor. Uses `g:gx_word`: control how gx picks up the text under the cursor. Uses
`g:netrw_gx` as a fallback for backward compatibility. `g:netrw_gx` as a fallback for backward compatibility.
(default: `<cfile>`) (default: `<cfile>`)
`g:nogx`: disables the gx mapping. Uses `g:netrw_nogx` as a fallback for `g:nogx`: disables the gx mapping. Uses `g:netrw_nogx` as a fallback for
backward compatibility. (default: `unset`) backward compatibility. (default: `unset`)
@ -5242,7 +5244,7 @@ Usage: >vim
*dist#vim9#Launch()* *:Launch* *dist#vim9#Launch()* *:Launch*
dist#vim9#Launch(file: string) ~ dist#vim9#Launch(file: string) ~
Launches <args> with the appropriate system programs. Intended for launching Launches <args> with the appropriate system programs. Intended for launching
GUI programs within Vim. GUI programs within Vim.
The |:Launch| user command uses shell completion for its first argument. The |:Launch| user command uses shell completion for its first argument.

39
runtime/doc/filetype.txt
View File

@ -1,4 +1,4 @@
*filetype.txt* For Vim version 9.1. Last change: 2025 Sep 24 *filetype.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -530,12 +530,13 @@ g:changelog_new_date_format
%% insert a single '%' character %% insert a single '%' character
%d insert the date from above %d insert the date from above
%u insert the user from above %u insert the user from above
%p insert result of b:changelog_entry_prefix %p insert result of
b:changelog_entry_prefix
%c where to position cursor when done %c where to position cursor when done
The default is "%d %u\n\n\t* %p%c\n\n", which produces The default is "%d %u\n\n\t* %p%c\n\n", which
something like (| is where cursor will be, unless at produces something like (| is where cursor will be,
the start of the line where it denotes the beginning unless at the start of the line where it denotes the
of the line) > beginning of the line) >
|2003-01-14 Full Name <user@host> |2003-01-14 Full Name <user@host>
| |
| * prefix| | * prefix|
@ -544,7 +545,8 @@ g:changelog_new_entry_format
The format used when creating a new entry. The format used when creating a new entry.
The following table describes special tokens in the The following table describes special tokens in the
string: string:
%p insert result of b:changelog_entry_prefix %p insert result of
b:changelog_entry_prefix
%c where to position cursor when done %c where to position cursor when done
The default is "\t*%c", which produces something The default is "\t*%c", which produces something
similar to > similar to >
@ -604,8 +606,9 @@ Options:
'expandtab' is switched on to avoid tabs as required by the Fortran 'expandtab' is switched on to avoid tabs as required by the Fortran
standards unless the user has set fortran_have_tabs in .vimrc. standards unless the user has set fortran_have_tabs in .vimrc.
'textwidth' is set to 80 for fixed source format whereas it is set to 132 'textwidth' is set to 80 for fixed source format whereas it is set to 132
for free source format. Setting the fortran_extended_line_length for free source format. Setting the
variable increases the width to 132 for fixed source format. fortran_extended_line_length variable increases the width to
132 for fixed source format.
'formatoptions' is set to break code and comment lines and to preserve long 'formatoptions' is set to break code and comment lines and to preserve long
lines. You can format comments with |gq|. lines. You can format comments with |gq|.
For further discussion of fortran_have_tabs and the method used for the For further discussion of fortran_have_tabs and the method used for the
@ -889,7 +892,7 @@ not running man {name} if no page is found, then use this: >
< <
*g:ft_man_implementation* *g:ft_man_implementation*
The completion for the :Man command tries to guess which implementation of man The completion for the :Man command tries to guess which implementation of man
the system has. If it guesses wrong, you can set g:ft_man_implementation to the system has. If it guesses wrong, you can set g:ft_man_implementation to
one of these values: one of these values:
'man-db' https://man-db.nongnu.org/ 'man-db' https://man-db.nongnu.org/
'' Unknown, fall back to completing shell commands '' Unknown, fall back to completing shell commands
@ -969,27 +972,27 @@ QF QUICKFIX *qf.vim* *ft-qf-plugin*
The "qf" filetype is used for the quickfix window, see |quickfix-window|. The "qf" filetype is used for the quickfix window, see |quickfix-window|.
The quickfix filetype plugin includes configuration for displaying the command The quickfix filetype plugin includes configuration for displaying the command
that produced the quickfix list in the |status-line|. To disable this setting, that produced the quickfix list in the |status-line|. To disable this setting,
configure as follows: > configure as follows: >
:let g:qf_disable_statusline = 1 :let g:qf_disable_statusline = 1
R MARKDOWN *ft-rmd-plugin* R MARKDOWN *ft-rmd-plugin*
By default ftplugin/html.vim is not sourced. If you want it sourced, add to By default ftplugin/html.vim is not sourced. If you want it sourced, add to
your |vimrc|: > your |vimrc|: >
let rmd_include_html = 1 let rmd_include_html = 1
The 'formatexpr' option is set dynamically with different values for R code The 'formatexpr' option is set dynamically with different values for R code
and for Markdown code. If you prefer that 'formatexpr' is not set, add to your and for Markdown code. If you prefer that 'formatexpr' is not set, add to
|vimrc|: > your |vimrc|: >
let rmd_dynamic_comments = 0 let rmd_dynamic_comments = 0
R RESTRUCTURED TEXT *ft-rrst-plugin* R RESTRUCTURED TEXT *ft-rrst-plugin*
The 'formatexpr' option is set dynamically with different values for R code The 'formatexpr' option is set dynamically with different values for R code
and for ReStructured text. If you prefer that 'formatexpr' is not set, add to and for ReStructured text. If you prefer that 'formatexpr' is not set, add to
your |vimrc|: > your |vimrc|: >
let rrst_dynamic_comments = 0 let rrst_dynamic_comments = 0
@ -1006,7 +1009,7 @@ To enable this behavior, set the following variable in your vimrc: >
RNOWEB *ft-rnoweb-plugin* RNOWEB *ft-rnoweb-plugin*
The 'formatexpr' option is set dynamically with different values for R code The 'formatexpr' option is set dynamically with different values for R code
and for LaTeX code. If you prefer that 'formatexpr' is not set, add to your and for LaTeX code. If you prefer that 'formatexpr' is not set, add to your
|vimrc|: > |vimrc|: >
let rnw_dynamic_comments = 0 let rnw_dynamic_comments = 0
@ -1100,8 +1103,8 @@ To disable this behavior, set |g:zig_recommended_style| to 0: >
let g:zig_recommended_style = 0 let g:zig_recommended_style = 0
< <
*g:zig_std_dir* *g:zig_std_dir*
The path to the Zig standard library. The Zig |ftplugin| reads |g:zig_std_dir| The path to the Zig standard library. The Zig |ftplugin| reads |g:zig_std_dir|
and appends it to the 'path' for Zig files. Where the Zig standard library and appends it to the 'path' for Zig files. Where the Zig standard library
is located is system and installation method dependent. is located is system and installation method dependent.
One can automatically set |g:zig_std_dir| using `zig env`: > One can automatically set |g:zig_std_dir| using `zig env`: >

20
runtime/doc/gui.txt
View File

@ -1,4 +1,4 @@
*gui.txt* For Vim version 9.1. Last change: 2025 Aug 10 *gui.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -164,7 +164,7 @@ window Vim is running in with these commands: >
*gui-IME* *iBus* *gui-IME* *iBus*
Input methods for international characters in X that rely on the XIM Input methods for international characters in X that rely on the XIM
framework, most notably iBus, have been known to produce undesirable results framework, most notably iBus, have been known to produce undesirable results
in gvim. These may include an inability to enter spaces, or long delays in gvim. These may include an inability to enter spaces, or long delays
between typing a character and it being recognized by the application. between typing a character and it being recognized by the application.
One workaround that has been successful, for unknown reasons, is to prevent One workaround that has been successful, for unknown reasons, is to prevent
@ -574,8 +574,8 @@ the mouse button down on this will pop up a menu containing the item
which when selected, performs the operation. which when selected, performs the operation.
To create a menu for terminal mode, use |:tlmenu| instead of |:tmenu| unlike To create a menu for terminal mode, use |:tlmenu| instead of |:tmenu| unlike
key mapping (|:tmap|). This is because |:tmenu| is already used for defining key mapping (|:tmap|). This is because |:tmenu| is already used for defining
tooltips for menus. See |terminal-typing|. tooltips for menus. See |terminal-typing|.
Special characters in a menu name: Special characters in a menu name:
@ -851,7 +851,7 @@ not wrap.
Note that Vim may be in any mode when executing these commands. The menu Note that Vim may be in any mode when executing these commands. The menu
should be defined for Normal mode and will be executed without changing the should be defined for Normal mode and will be executed without changing the
current mode. Thus if the current window is in Visual mode and the menu current mode. Thus if the current window is in Visual mode and the menu
command does not intentionally change the mode, Vim will remain in Visual command does not intentionally change the mode, Vim will remain in Visual
mode. Best is to use `:nnoremenu` to avoid side effects. mode. Best is to use `:nnoremenu` to avoid side effects.
@ -1019,8 +1019,8 @@ The tip is defined like this: >
And delete it with: > And delete it with: >
:tunmenu MyMenu.Hello :tunmenu MyMenu.Hello
Tooltips are currently only supported for the X11 and Win32 GUI. However, they Tooltips are currently only supported for the X11 and Win32 GUI. However,
should appear for the other gui platforms in the not too distant future. they should appear for the other gui platforms in the not too distant future.
The ":tmenu" command works just like other menu commands, it uses the same The ":tmenu" command works just like other menu commands, it uses the same
arguments. ":tunmenu" deletes an existing menu tip, in the same way as the arguments. ":tunmenu" deletes an existing menu tip, in the same way as the
@ -1158,12 +1158,12 @@ Examples: >
See also |font-sizes|. See also |font-sizes|.
Note on Weights: Fonts often come with a variety of weights. "Normal" weights Note on Weights: Fonts often come with a variety of weights. "Normal" weights
in Windows have a value of 400 and, left unspecified, this is the value that in Windows have a value of 400 and, left unspecified, this is the value that
will be used when attempting to find fonts. Windows will often match fonts will be used when attempting to find fonts. Windows will often match fonts
based on their weight with higher priority than the font name which means a based on their weight with higher priority than the font name which means a
Book or Medium variant of a font might be used despite specifying a Light or Book or Medium variant of a font might be used despite specifying a Light or
ExtraLight variant. If you are experiencing heavier weight substitution, then ExtraLight variant. If you are experiencing heavier weight substitution, then
explicitly setting a lower weight value may mitigate against this unwanted explicitly setting a lower weight value may mitigate against this unwanted
substitution. substitution.

4
runtime/doc/gui_x11.txt
View File

@ -1,4 +1,4 @@
*gui_x11.txt* For Vim version 9.1. Last change: 2025 Sep 22 *gui_x11.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -602,7 +602,7 @@ your pkg-config works with your GTK+ 2: >
$ pkg-config --modversion gtk+-2.0 $ pkg-config --modversion gtk+-2.0
Replace gtk+-2.0 with gtk+-3.0 for GTK+ 3. If you get the correct version Replace gtk+-2.0 with gtk+-3.0 for GTK+ 3. If you get the correct version
number of your GTK+, you can proceed; if not, you probably need to do some number of your GTK+, you can proceed; if not, you probably need to do some
system administration chores to set up pkg-config and GTK+ correctly. system administration chores to set up pkg-config and GTK+ correctly.

12
runtime/doc/helphelp.txt
View File

@ -1,4 +1,4 @@
*helphelp.txt* For Vim version 9.1. Last change: 2025 Sep 29 *helphelp.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -297,9 +297,9 @@ the following pattern is used: >
^\w\+@\w\+:\f\+\$\s ^\w\+@\w\+:\f\+\$\s
This is meant to match a default bash prompt. If it doesn't match your prompt, This is meant to match a default bash prompt. If it doesn't match your
you can change the regex with the `shell_prompt` key from the `g:helptoc` prompt, you can change the regex with the `shell_prompt` key from the
dictionary variable: > `g:helptoc` dictionary variable: >
let g:helptoc = {'shell_prompt': 'regex matching your shell prompt'} let g:helptoc = {'shell_prompt': 'regex matching your shell prompt'}
@ -456,8 +456,8 @@ This will highlight the column heading in a different color. E.g.
Column heading~ Column heading~
To separate sections in a help file, place a series of '=' characters in a To separate sections in a help file, place a series of '=' characters in a
line starting from the first column. The section separator line is highlighted line starting from the first column. The section separator line is
differently. highlighted differently.
To quote a block of ex-commands verbatim, place a greater than (>) character To quote a block of ex-commands verbatim, place a greater than (>) character
at the end of the line before the block and a less than (<) character as the at the end of the line before the block and a less than (<) character as the

4
runtime/doc/if_cscop.txt
View File

@ -1,4 +1,4 @@
*if_cscop.txt* For Vim version 9.1. Last change: 2025 Aug 10 *if_cscop.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Andy Kahn VIM REFERENCE MANUAL by Andy Kahn
@ -255,7 +255,7 @@ started will have no effect!
*cscopequickfix* *csqf* *E469* *cscopequickfix* *csqf* *E469*
{not available when compiled without the |+quickfix| feature} {not available when compiled without the |+quickfix| feature}
'cscopequickfix' specifies whether to use quickfix window to show cscope 'cscopequickfix' specifies whether to use quickfix window to show cscope
results. This is a list of comma-separated values. Each item consists of results. This is a list of comma-separated values. Each item consists of
|cscope-find| command (s, g, d, c, t, e, f, i or a) and flag (+, - or 0). |cscope-find| command (s, g, d, c, t, e, f, i or a) and flag (+, - or 0).
'+' indicates that results must be appended to quickfix window, '+' indicates that results must be appended to quickfix window,
'-' implies previous results clearance, '0' or command absence - don't use '-' implies previous results clearance, '0' or command absence - don't use

101
runtime/doc/if_lua.txt
View File

@ -1,4 +1,4 @@
*if_lua.txt* For Vim version 9.1. Last change: 2021 Aug 06 *if_lua.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Luis Carvalho VIM REFERENCE MANUAL by Luis Carvalho
@ -71,7 +71,7 @@ If you use LuaJIT you can also use this: >
argument being set to the text of each line in turn, argument being set to the text of each line in turn,
without a trailing <EOL>, and the current line number. without a trailing <EOL>, and the current line number.
If the value returned by the function is a string it If the value returned by the function is a string it
becomes the text of the line in the current turn. The becomes the text of the line in the current turn. The
default for [range] is the whole file: "1,$". default for [range] is the whole file: "1,$".
Examples: Examples:
@ -96,14 +96,14 @@ Examples:
< <
All these commands execute a Lua chunk from either the command line (:lua and All these commands execute a Lua chunk from either the command line (:lua and
:luado) or a file (:luafile) with the given line [range]. Similarly to the Lua :luado) or a file (:luafile) with the given line [range]. Similarly to the
interpreter, each chunk has its own scope and so only global variables are Lua interpreter, each chunk has its own scope and so only global variables are
shared between command calls. All Lua default libraries are available. In shared between command calls. All Lua default libraries are available. In
addition, Lua "print" function has its output redirected to the Vim message addition, Lua "print" function has its output redirected to the Vim message
area, with arguments separated by a white space instead of a tab. area, with arguments separated by a white space instead of a tab.
Lua uses the "vim" module (see |lua-vim|) to issue commands to Vim Lua uses the "vim" module (see |lua-vim|) to issue commands to Vim
and manage buffers (|lua-buffer|) and windows (|lua-window|). However, and manage buffers (|lua-buffer|) and windows (|lua-window|). However,
procedures that alter buffer content, open new buffers, and change cursor procedures that alter buffer content, open new buffers, and change cursor
position are restricted when the command is executed in the |sandbox|. position are restricted when the command is executed in the |sandbox|.
@ -111,18 +111,18 @@ position are restricted when the command is executed in the |sandbox|.
============================================================================== ==============================================================================
2. The vim module *lua-vim* 2. The vim module *lua-vim*
Lua interfaces Vim through the "vim" module. The first and last line of the Lua interfaces Vim through the "vim" module. The first and last line of the
input range are stored in "vim.firstline" and "vim.lastline" respectively. The input range are stored in "vim.firstline" and "vim.lastline" respectively.
module also includes routines for buffer, window, and current line queries, The module also includes routines for buffer, window, and current line
Vim evaluation and command execution, and others. queries, Vim evaluation and command execution, and others.
vim.list([arg]) Returns an empty list or, if "arg" is a Lua vim.list([arg]) Returns an empty list or, if "arg" is a Lua
table with numeric keys 1, ..., n (a table with numeric keys 1, ..., n (a
"sequence"), returns a list l such that l[i] = "sequence"), returns a list l such that l[i] =
arg[i] for i = 1, ..., n (see |List|). arg[i] for i = 1, ..., n (see |List|).
Non-numeric keys are not used to initialize Non-numeric keys are not used to initialize
the list. See also |lua-eval| for conversion the list. See also |lua-eval| for conversion
rules. Example: > rules. Example: >
:lua t = {math.pi, false, say = 'hi'} :lua t = {math.pi, false, say = 'hi'}
:echo luaeval('vim.list(t)') :echo luaeval('vim.list(t)')
:" [3.141593, v:false], 'say' is ignored :" [3.141593, v:false], 'say' is ignored
@ -130,10 +130,10 @@ Vim evaluation and command execution, and others.
vim.dict([arg]) Returns an empty dictionary or, if "arg" is a vim.dict([arg]) Returns an empty dictionary or, if "arg" is a
Lua table, returns a dict d such that d[k] = Lua table, returns a dict d such that d[k] =
arg[k] for all string keys k in "arg" (see arg[k] for all string keys k in "arg" (see
|Dictionary|). Number keys are converted to |Dictionary|). Number keys are converted to
strings. Keys that are not strings are not strings. Keys that are not strings are not
used to initialize the dictionary. See also used to initialize the dictionary. See also
|lua-eval| for conversion rules. Example: > |lua-eval| for conversion rules. Example: >
:lua t = {math.pi, false, say = 'hi'} :lua t = {math.pi, false, say = 'hi'}
:echo luaeval('vim.dict(t)') :echo luaeval('vim.dict(t)')
:" {'1': 3.141593, '2': v:false, :" {'1': 3.141593, '2': v:false,
@ -148,29 +148,29 @@ Vim evaluation and command execution, and others.
:" 0z31326162.0080FEFF :" 0z31326162.0080FEFF
< <
vim.funcref({name}) Returns a Funcref to function {name} (see vim.funcref({name}) Returns a Funcref to function {name} (see
|Funcref|). It is equivalent to Vim's |Funcref|). It is equivalent to Vim's
function(). function().
vim.buffer([arg]) If "arg" is a number, returns buffer with vim.buffer([arg]) If "arg" is a number, returns buffer with
number "arg" in the buffer list or, if "arg" number "arg" in the buffer list or, if "arg"
is a string, returns buffer whose full or short is a string, returns buffer whose full or
name is "arg". In both cases, returns 'nil' short name is "arg". In both cases, returns
(nil value, not string) if the buffer is not 'nil' (nil value, not string) if the buffer is
found. Otherwise, if "toboolean(arg)" is not found. Otherwise, if "toboolean(arg)" is
'true' returns the first buffer in the buffer 'true' returns the first buffer in the buffer
list or else the current buffer. list or else the current buffer.
vim.window([arg]) If "arg" is a number, returns window with vim.window([arg]) If "arg" is a number, returns window with
number "arg" or 'nil' (nil value, not string) number "arg" or 'nil' (nil value, not string)
if not found. Otherwise, if "toboolean(arg)" if not found. Otherwise, if "toboolean(arg)"
is 'true' returns the first window or else the is 'true' returns the first window or else the
current window. current window.
vim.type({arg}) Returns the type of {arg}. It is equivalent to vim.type({arg}) Returns the type of {arg}. It is equivalent
Lua's "type" function, but returns "list", to Lua's "type" function, but returns "list",
"dict", "funcref", "buffer", or "window" if "dict", "funcref", "buffer", or "window" if
{arg} is a list, dictionary, funcref, buffer, {arg} is a list, dictionary, funcref, buffer,
or window, respectively. Examples: > or window, respectively. Examples: >
:lua l = vim.list() :lua l = vim.list()
:lua print(type(l), vim.type(l)) :lua print(type(l), vim.type(l))
:" list :" list
@ -190,7 +190,7 @@ Vim evaluation and command execution, and others.
vim.eval({expr}) Evaluates expression {expr} (see |expression|), vim.eval({expr}) Evaluates expression {expr} (see |expression|),
converts the result to Lua, and returns it. converts the result to Lua, and returns it.
Vim strings and numbers are directly converted Vim strings and numbers are directly converted
to Lua strings and numbers respectively. Vim to Lua strings and numbers respectively. Vim
lists and dictionaries are converted to Lua lists and dictionaries are converted to Lua
userdata (see |lua-list| and |lua-dict|). userdata (see |lua-list| and |lua-dict|).
Examples: > Examples: >
@ -203,16 +203,16 @@ Vim evaluation and command execution, and others.
vim.beep() Beeps. vim.beep() Beeps.
vim.open({fname}) Opens a new buffer for file {fname} and vim.open({fname}) Opens a new buffer for file {fname} and
returns it. Note that the buffer is not set as returns it. Note that the buffer is not set
current. as current.
vim.call({name} [, {args}]) vim.call({name} [, {args}])
Proxy to call Vim function named {name} with Proxy to call Vim function named {name} with
arguments {args}. Example: > arguments {args}. Example: >
:lua print(vim.call('has', 'timers')) :lua print(vim.call('has', 'timers'))
< <
vim.fn Proxy to call Vim functions. Proxy methods are vim.fn Proxy to call Vim functions. Proxy methods
created on demand. Example: > are created on demand. Example: >
:lua print(vim.fn.has('timers')) :lua print(vim.fn.has('timers'))
< <
vim.lua_version The Lua version Vim was compiled with, in the vim.lua_version The Lua version Vim was compiled with, in the
@ -227,7 +227,7 @@ Vim evaluation and command execution, and others.
*lua-vim-variables* *lua-vim-variables*
The Vim editor global dictionaries |g:| |w:| |b:| |t:| |v:| can be accessed The Vim editor global dictionaries |g:| |w:| |b:| |t:| |v:| can be accessed
from Lua conveniently and idiomatically by referencing the `vim.*` Lua tables from Lua conveniently and idiomatically by referencing the `vim.*` Lua tables
described below. In this way you can easily read and modify global Vim script described below. In this way you can easily read and modify global Vim script
variables from Lua. variables from Lua.
Example: > Example: >
@ -260,8 +260,8 @@ vim.v *vim.v*
3. List userdata *lua-list* 3. List userdata *lua-list*
List userdata represent vim lists, and the interface tries to follow closely List userdata represent vim lists, and the interface tries to follow closely
Vim's syntax for lists. Since lists are objects, changes in list references in Vim's syntax for lists. Since lists are objects, changes in list references
Lua are reflected in Vim and vice-versa. A list "l" has the following in Lua are reflected in Vim and vice-versa. A list "l" has the following
properties and methods: properties and methods:
NOTE: In patch 8.2.1066 array indexes were changed from zero-based to NOTE: In patch 8.2.1066 array indexes were changed from zero-based to
@ -274,23 +274,23 @@ Properties
in Vim. in Vim.
o "l[k]" returns the k-th item in "l"; "l" is one-indexed, as in Lua. o "l[k]" returns the k-th item in "l"; "l" is one-indexed, as in Lua.
To modify the k-th item, simply do "l[k] = newitem"; in To modify the k-th item, simply do "l[k] = newitem"; in
particular, "l[k] = nil" removes the k-th item from "l". Item can particular, "l[k] = nil" removes the k-th item from "l". Item can
be added to the end of the list by "l[#l + 1] = newitem" be added to the end of the list by "l[#l + 1] = newitem"
o "l()" returns an iterator for "l". o "l()" returns an iterator for "l".
o "table.insert(l, newitem)" inserts an item at the end of the list. o "table.insert(l, newitem)" inserts an item at the end of the list.
(only Lua 5.3 and later) (only Lua 5.3 and later)
o "table.insert(l, position, newitem)" inserts an item at the o "table.insert(l, position, newitem)" inserts an item at the
specified position. "position" is one-indexed. (only Lua 5.3 and specified position. "position" is one-indexed. (only Lua 5.3 and
later) later)
o "table.remove(l, position)" removes an item at the specified o "table.remove(l, position)" removes an item at the specified
position. "position" is one-indexed. position. "position" is one-indexed.
Methods Methods
------- -------
o "l:add(item)" appends "item" to the end of "l". o "l:add(item)" appends "item" to the end of "l".
o "l:insert(item[, pos])" inserts "item" at (optional) o "l:insert(item[, pos])" inserts "item" at (optional)
position "pos" in the list. The default value for "pos" is 0. position "pos" in the list. The default value for "pos" is 0.
Examples: Examples:
> >
@ -312,8 +312,8 @@ Examples:
4. Dict userdata *lua-dict* 4. Dict userdata *lua-dict*
Similarly to list userdata, dict userdata represent vim dictionaries; since Similarly to list userdata, dict userdata represent vim dictionaries; since
dictionaries are also objects, references are kept between Lua and Vim. A dict dictionaries are also objects, references are kept between Lua and Vim. A
"d" has the following properties: dict "d" has the following properties:
Properties Properties
---------- ----------
@ -340,7 +340,7 @@ Examples:
============================================================================== ==============================================================================
5. Blob userdata *lua-blob* 5. Blob userdata *lua-blob*
Blob userdata represent vim blobs. A blob "b" has the following properties: Blob userdata represent vim blobs. A blob "b" has the following properties:
Properties Properties
---------- ----------
@ -367,7 +367,7 @@ Examples:
============================================================================== ==============================================================================
6. Funcref userdata *lua-funcref* 6. Funcref userdata *lua-funcref*
Funcref userdata represent funcref variables in Vim. Funcrefs that were Funcref userdata represent funcref variables in Vim. Funcrefs that were
defined with a "dict" attribute need to be obtained as a dictionary key defined with a "dict" attribute need to be obtained as a dictionary key
in order to have "self" properly assigned to the dictionary (see examples in order to have "self" properly assigned to the dictionary (see examples
below.) A funcref "f" has the following properties: below.) A funcref "f" has the following properties:
@ -408,8 +408,8 @@ can be accessed in Vim scripts. Example:
============================================================================== ==============================================================================
7. Buffer userdata *lua-buffer* 7. Buffer userdata *lua-buffer*
Buffer userdata represent vim buffers. A buffer userdata "b" has the following Buffer userdata represent vim buffers. A buffer userdata "b" has the
properties and methods: following properties and methods:
Properties Properties
---------- ----------
@ -425,8 +425,8 @@ Properties
Methods Methods
------- -------
o "b:insert(newline[, pos])" inserts string "newline" at (optional) o "b:insert(newline[, pos])" inserts string "newline" at (optional)
position "pos" in the buffer. The default value for "pos" is position "pos" in the buffer. The default value for "pos" is
"#b + 1". If "pos == 0" then "newline" becomes the first line in "#b + 1". If "pos == 0" then "newline" becomes the first line in
the buffer. the buffer.
o "b:next()" returns the buffer next to "b" in the buffer list. o "b:next()" returns the buffer next to "b" in the buffer list.
o "b:previous()" returns the buffer previous to "b" in the buffer o "b:previous()" returns the buffer previous to "b" in the buffer
@ -460,7 +460,7 @@ Examples:
============================================================================== ==============================================================================
8. Window userdata *lua-window* 8. Window userdata *lua-window*
Window objects represent vim windows. A window userdata "w" has the following Window objects represent vim windows. A window userdata "w" has the following
properties and methods: properties and methods:
Properties Properties
@ -493,8 +493,9 @@ Examples:
9. luaeval() Vim function *lua-luaeval* *lua-eval* 9. luaeval() Vim function *lua-luaeval* *lua-eval*
The (dual) equivalent of "vim.eval" for passing Lua values to Vim is The (dual) equivalent of "vim.eval" for passing Lua values to Vim is
"luaeval". "luaeval" takes an expression string and an optional argument and "luaeval". "luaeval" takes an expression string and an optional argument and
returns the result of the expression. It is semantically equivalent in Lua to: returns the result of the expression. It is semantically equivalent in Lua
to:
> >
local chunkheader = "local _A = select(1, ...) return " local chunkheader = "local _A = select(1, ...) return "
function luaeval (expstr, arg) function luaeval (expstr, arg)
@ -502,9 +503,9 @@ returns the result of the expression. It is semantically equivalent in Lua to:
return chunk(arg) -- return typval return chunk(arg) -- return typval
end end
< <
Note that "_A" receives the argument to "luaeval". Lua numbers, strings, and Note that "_A" receives the argument to "luaeval". Lua numbers, strings, and
list, dict, blob, and funcref userdata are converted to their Vim respective list, dict, blob, and funcref userdata are converted to their Vim respective
types, while Lua booleans are converted to numbers. An error is thrown if types, while Lua booleans are converted to numbers. An error is thrown if
conversion of any of the remaining Lua types, including userdata other than conversion of any of the remaining Lua types, including userdata other than
lists, dicts, blobs, and funcrefs, is attempted. lists, dicts, blobs, and funcrefs, is attempted.

47
runtime/doc/if_mzsch.txt
View File

@ -1,4 +1,4 @@
*if_mzsch.txt* For Vim version 9.1. Last change: 2020 Oct 14 *if_mzsch.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Sergey Khorev VIM REFERENCE MANUAL by Sergey Khorev
@ -20,7 +20,7 @@ The MzScheme Interface to Vim *mzscheme* *MzScheme*
Based on the work of Brent Fulgham. Based on the work of Brent Fulgham.
Dynamic loading added by Sergey Khorev Dynamic loading added by Sergey Khorev
MzScheme and PLT Scheme names have been rebranded as Racket. For more MzScheme and PLT Scheme names have been rebranded as Racket. For more
information please check http://racket-lang.org information please check http://racket-lang.org
Futures and places of Racket version 5.x up to and including 5.3.1 do not Futures and places of Racket version 5.x up to and including 5.3.1 do not
@ -67,8 +67,8 @@ MzScheme interface defines exception exn:vim, derived from exn.
It is raised for various Vim errors. It is raised for various Vim errors.
During compilation, the MzScheme interface will remember the current MzScheme During compilation, the MzScheme interface will remember the current MzScheme
collection path. If you want to specify additional paths use the collection path. If you want to specify additional paths use the
'current-library-collection-paths' parameter. E.g., to cons the user-local 'current-library-collection-paths' parameter. E.g., to cons the user-local
MzScheme collection path: > MzScheme collection path: >
:mz << EOF :mz << EOF
(current-library-collection-paths (current-library-collection-paths
@ -150,9 +150,9 @@ Auto-instantiation of vimext module (can be placed in your |vimrc|): >
============================================================================== ==============================================================================
3. Threads *mzscheme-threads* 3. Threads *mzscheme-threads*
The MzScheme interface supports threads. They are independent from OS threads, The MzScheme interface supports threads. They are independent from OS
thus scheduling is required. The option 'mzquantum' determines how often threads, thus scheduling is required. The option 'mzquantum' determines how
Vim should poll for available MzScheme threads. often Vim should poll for available MzScheme threads.
NOTE NOTE
Thread scheduling in the console version of Vim is less reliable than in the Thread scheduling in the console version of Vim is less reliable than in the
GUI version. GUI version.
@ -181,12 +181,12 @@ Common
(get-option {option-name} [buffer-or-window]) Get Vim option value (either (get-option {option-name} [buffer-or-window]) Get Vim option value (either
local or global, see set-option). local or global, see set-option).
(set-option {string} [buffer-or-window]) (set-option {string} [buffer-or-window])
Set a Vim option. String must have option Set a Vim option. String must have option
setting form (like optname=optval, or setting form (like optname=optval, or
optname+=optval, etc.) When called with optname+=optval, etc.) When called with
{buffer} or {window} the local option will {buffer} or {window} the local option will
be set. The symbol 'global can be passed be set. The symbol 'global can be passed
as {buffer-or-window}. Then |:setglobal| as {buffer-or-window}. Then |:setglobal|
will be used. will be used.
Buffers *mzscheme-buffer* Buffers *mzscheme-buffer*
@ -197,17 +197,17 @@ Buffers *mzscheme-buffer*
(get-buff-line {linenr} [buffer]) (get-buff-line {linenr} [buffer])
Get line from a buffer. Get line from a buffer.
(set-buff-line {linenr} {string} [buffer]) (set-buff-line {linenr} {string} [buffer])
Set a line in a buffer. If {string} is #f, Set a line in a buffer. If {string} is
the line gets deleted. The [buffer] #f, the line gets deleted. The [buffer]
argument is optional. If omitted, the argument is optional. If omitted, the
current buffer will be used. current buffer will be used.
(get-buff-line-list {start} {end} [buffer]) (get-buff-line-list {start} {end} [buffer])
Get a list of lines in a buffer. {Start} Get a list of lines in a buffer. {Start}
and {end} are 1-based and inclusive. and {end} are 1-based and inclusive.
(set-buff-line-list {start} {end} {string-list} [buffer]) (set-buff-line-list {start} {end} {string-list} [buffer])
Set a list of lines in a buffer. If Set a list of lines in a buffer. If
string-list is #f or null, the lines get string-list is #f or null, the lines get
deleted. If a list is shorter than deleted. If a list is shorter than
{end}-{start} the remaining lines will {end}-{start} the remaining lines will
be deleted. be deleted.
(get-buff-name [buffer]) Get a buffer's text name. (get-buff-name [buffer]) Get a buffer's text name.
@ -215,13 +215,14 @@ Buffers *mzscheme-buffer*
(get-buff-size [buffer]) Get buffer line count. (get-buff-size [buffer]) Get buffer line count.
(insert-buff-line-list {linenr} {string/string-list} [buffer]) (insert-buff-line-list {linenr} {string/string-list} [buffer])
Insert a list of lines into a buffer after Insert a list of lines into a buffer after
{linenr}. If {linenr} is 0, lines will be {linenr}. If {linenr} is 0, lines will be
inserted at start. inserted at start.
(curr-buff) Get the current buffer. Use other MzScheme (curr-buff) Get the current buffer. Use other
interface procedures to change it. MzScheme interface procedures to change
it.
(buff-count) Get count of total buffers in the editor. (buff-count) Get count of total buffers in the editor.
(get-next-buff [buffer]) Get next buffer. (get-next-buff [buffer]) Get next buffer.
(get-prev-buff [buffer]) Get previous buffer. Return #f when there (get-prev-buff [buffer]) Get previous buffer. Return #f when there
are no more buffers. are no more buffers.
(open-buff {filename}) Open a new buffer (for file "name") (open-buff {filename}) Open a new buffer (for file "name")
(get-buff-by-name {buffername}) Get a buffer by its filename or #f (get-buff-by-name {buffername}) Get a buffer by its filename or #f
@ -258,7 +259,7 @@ evaluate MzScheme expressions and pass their values to Vim script.
6. Using Function references *mzscheme-funcref* 6. Using Function references *mzscheme-funcref*
MzScheme interface allows use of |Funcref|s so you can call Vim functions MzScheme interface allows use of |Funcref|s so you can call Vim functions
directly from Scheme. For instance: > directly from Scheme. For instance: >
function! MyAdd2(arg) function! MyAdd2(arg)
return a:arg + 2 return a:arg + 2
endfunction endfunction
@ -273,7 +274,7 @@ directly from Scheme. For instance: >
============================================================================== ==============================================================================
7. Dynamic loading *mzscheme-dynamic* *E815* 7. Dynamic loading *mzscheme-dynamic* *E815*
On MS-Windows the MzScheme libraries can be loaded dynamically. The |:version| On MS-Windows the MzScheme libraries can be loaded dynamically. The |:version|
output then includes |+mzscheme/dyn|. output then includes |+mzscheme/dyn|.
This means that Vim will search for the MzScheme DLL files only when needed. This means that Vim will search for the MzScheme DLL files only when needed.
@ -291,7 +292,7 @@ name of the library to load. The initial value is specified at build time.
The version of the DLL must match the MzScheme version Vim was compiled with. The version of the DLL must match the MzScheme version Vim was compiled with.
For MzScheme version 209 they will be "libmzsch209_000.dll" and For MzScheme version 209 they will be "libmzsch209_000.dll" and
"libmzgc209_000.dll". To know for sure look at the output of the ":version" "libmzgc209_000.dll". To know for sure look at the output of the ":version"
command, look for -DDYNAMIC_MZSCH_DLL="something" and command, look for -DDYNAMIC_MZSCH_DLL="something" and
-DDYNAMIC_MZGC_DLL="something" in the "Compilation" info. -DDYNAMIC_MZGC_DLL="something" in the "Compilation" info.

18
runtime/doc/if_perl.txt
View File

@ -1,4 +1,4 @@
*if_perl.txt* For Vim version 9.1. Last change: 2025 Oct 04 *if_perl.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Sven Verdoolaege VIM REFERENCE MANUAL by Sven Verdoolaege
@ -17,9 +17,9 @@ Perl and Vim *perl* *Perl*
1. Editing Perl files *perl-editing* 1. Editing Perl files *perl-editing*
Vim syntax highlighting supports Perl and POD files. Vim assumes a file is Vim syntax highlighting supports Perl and POD files. Vim assumes a file is
Perl code if the filename has a .pl or .pm suffix. Vim also examines the first Perl code if the filename has a .pl or .pm suffix. Vim also examines the
line of a file, regardless of the filename suffix, to check if a file is a first line of a file, regardless of the filename suffix, to check if a file is
Perl script (see scripts.vim in Vim's syntax directory). Vim assumes a file a Perl script (see scripts.vim in Vim's syntax directory). Vim assumes a file
is POD text if the filename has a .POD suffix. is POD text if the filename has a .POD suffix.
To use tags with Perl, you need Universal/Exuberant Ctags. Look here: To use tags with Perl, you need Universal/Exuberant Ctags. Look here:
@ -90,9 +90,9 @@ To see what version of Perl you have: >
*:perldo* *:perld* *:perldo* *:perld*
:[range]perld[o] {cmd} Execute Perl command {cmd} for each line in the :[range]perld[o] {cmd} Execute Perl command {cmd} for each line in the
[range], with $_ being set to the text of each line in [range], with $_ being set to the text of each line in
turn, without a trailing <EOL>. Setting $_ will change turn, without a trailing <EOL>. Setting $_ will
the text, but note that it is not possible to add or change the text, but note that it is not possible to
delete lines using this command. add or delete lines using this command.
The default for [range] is the whole file: "1,$". The default for [range] is the whole file: "1,$".
Here are some things you can try: > Here are some things you can try: >
@ -296,8 +296,8 @@ version of the shared library must match the Perl version Vim was compiled
with. with.
Note: If you are building Perl locally, you have to use a version compiled Note: If you are building Perl locally, you have to use a version compiled
with threading support for it for Vim to successfully link against it. You can with threading support for it for Vim to successfully link against it. You
use the `-Dusethreads` flags when configuring Perl, and check that a Perl can use the `-Dusethreads` flags when configuring Perl, and check that a Perl
binary has it enabled by running `perl -V` and verify that `USE_ITHREADS` is binary has it enabled by running `perl -V` and verify that `USE_ITHREADS` is
under "Compile-time options". under "Compile-time options".

73
runtime/doc/if_pyth.txt
View File

@ -1,4 +1,4 @@
*if_pyth.txt* For Vim version 9.1. Last change: 2025 Mar 26 *if_pyth.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Paul Moore VIM REFERENCE MANUAL by Paul Moore
@ -80,9 +80,9 @@ and "EOF" do not have any indent.
{body}" for each line in the [range], with the {body}" for each line in the [range], with the
function arguments being set to the text of each line function arguments being set to the text of each line
in turn, without a trailing <EOL>, and the current in turn, without a trailing <EOL>, and the current
line number. The function should return a string or line number. The function should return a string or
None. If a string is returned, it becomes the text of None. If a string is returned, it becomes the text of
the line in the current turn. The default for [range] the line in the current turn. The default for [range]
is the whole file: "1,$". is the whole file: "1,$".
Examples: Examples:
@ -91,7 +91,7 @@ Examples:
:pydo if line: return "%4d: %s" % (linenr, line) :pydo if line: return "%4d: %s" % (linenr, line)
< <
One can use `:pydo` in possible conjunction with `:py` to filter a range using One can use `:pydo` in possible conjunction with `:py` to filter a range using
python. For example: > python. For example: >
:py3 << EOF :py3 << EOF
needle = vim.eval('@a') needle = vim.eval('@a')
@ -205,12 +205,12 @@ vim.eval(str) *python-eval*
'eval_expr', 'kind': 'f', 'filename': './src/eval.c'}] ~ 'eval_expr', 'kind': 'f', 'filename': './src/eval.c'}] ~
NOTE: In Vim9 script, local variables in def functions are not visible NOTE: In Vim9 script, local variables in def functions are not visible
to python evaluations. To pass local variables to python evaluations, to python evaluations. To pass local variables to python evaluations,
use the {locals} dict when calling |py3eval()| and friends. use the {locals} dict when calling |py3eval()| and friends.
vim.bindeval(str) *python-bindeval* vim.bindeval(str) *python-bindeval*
Like |python-eval|, but returns special objects described in Like |python-eval|, but returns special objects described in
|python-bindeval-objects|. These python objects let you modify |python-bindeval-objects|. These python objects let you modify
(|List|, |Tuple| or |Dictionary|) or call (|Funcref|) vim objects. (|List|, |Tuple| or |Dictionary|) or call (|Funcref|) vim objects.
vim.strwidth(str) *python-strwidth* vim.strwidth(str) *python-strwidth*
@ -220,14 +220,14 @@ vim.strwidth(str) *python-strwidth*
vim.foreach_rtp(callable) *python-foreach_rtp* vim.foreach_rtp(callable) *python-foreach_rtp*
Call the given callable for each path in 'runtimepath' until either Call the given callable for each path in 'runtimepath' until either
callable returns something but None, the exception is raised or there callable returns something but None, the exception is raised or there
are no longer paths. If stopped in case callable returned non-None, are no longer paths. If stopped in case callable returned non-None,
vim.foreach_rtp function returns the value returned by callable. vim.foreach_rtp function returns the value returned by callable.
vim.chdir(*args, **kwargs) *python-chdir* vim.chdir(*args, **kwargs) *python-chdir*
vim.fchdir(*args, **kwargs) *python-fchdir* vim.fchdir(*args, **kwargs) *python-fchdir*
Run os.chdir or os.fchdir, then all appropriate vim stuff. Run os.chdir or os.fchdir, then all appropriate vim stuff.
Note: you should not use these functions directly, use os.chdir and Note: you should not use these functions directly, use os.chdir and
os.fchdir instead. Behavior of vim.fchdir is undefined in case os.fchdir instead. Behavior of vim.fchdir is undefined in case
os.fchdir does not exist. os.fchdir does not exist.
Error object of the "vim" module Error object of the "vim" module
@ -265,12 +265,12 @@ vim.windows *python-windows*
< Note: vim.windows object always accesses current tab page. < Note: vim.windows object always accesses current tab page.
|python-tabpage|.windows objects are bound to parent |python-tabpage| |python-tabpage|.windows objects are bound to parent |python-tabpage|
object and always use windows from that tab page (or throw vim.error object and always use windows from that tab page (or throw vim.error
in case tab page was deleted). You can keep a reference to both in case tab page was deleted). You can keep a reference to both
without keeping a reference to vim module object or |python-tabpage|, without keeping a reference to vim module object or |python-tabpage|,
they will not lose their properties in this case. they will not lose their properties in this case.
vim.tabpages *python-tabpages* vim.tabpages *python-tabpages*
A sequence object providing access to the list of vim tab pages. The A sequence object providing access to the list of vim tab pages. The
object supports the following operations: > object supports the following operations: >
:py t = vim.tabpages[i] # Indexing (read-only) :py t = vim.tabpages[i] # Indexing (read-only)
:py t in vim.tabpages # Membership test :py t in vim.tabpages # Membership test
@ -293,10 +293,10 @@ vim.current *python-current*
Note: When assigning to vim.current.{buffer,window,tabpage} it expects Note: When assigning to vim.current.{buffer,window,tabpage} it expects
valid |python-buffer|, |python-window| or |python-tabpage| objects valid |python-buffer|, |python-window| or |python-tabpage| objects
respectively. Assigning triggers normal (with |autocommand|s) respectively. Assigning triggers normal (with |autocommand|s)
switching to given buffer, window or tab page. It is the only way to switching to given buffer, window or tab page. It is the only way to
switch UI objects in python: you can't assign to switch UI objects in python: you can't assign to
|python-tabpage|.window attribute. To switch without triggering |python-tabpage|.window attribute. To switch without triggering
autocommands use > autocommands use >
py << EOF py << EOF
saved_eventignore = vim.options['eventignore'] saved_eventignore = vim.options['eventignore']
@ -310,16 +310,16 @@ vim.current *python-current*
vim.vars *python-vars* vim.vars *python-vars*
vim.vvars *python-vvars* vim.vvars *python-vvars*
Dictionary-like objects holding dictionaries with global (|g:|) and Dictionary-like objects holding dictionaries with global (|g:|) and
vim (|v:|) variables respectively. Identical to `vim.bindeval("g:")`, vim (|v:|) variables respectively. Identical to `vim.bindeval("g:")`,
but faster. but faster.
vim.options *python-options* vim.options *python-options*
Object partly supporting mapping protocol (supports setting and Object partly supporting mapping protocol (supports setting and
getting items) providing a read-write access to global options. getting items) providing a read-write access to global options.
Note: unlike |:set| this provides access only to global options. You Note: unlike |:set| this provides access only to global options. You
cannot use this object to obtain or set local options' values or cannot use this object to obtain or set local options' values or
access local-only options in any fashion. Raises KeyError if no global access local-only options in any fashion. Raises KeyError if no
option with such name exists (i.e. does not raise KeyError for global option with such name exists (i.e. does not raise KeyError for
|global-local| options and global only options, but does for window- |global-local| options and global only options, but does for window-
and buffer-local ones). Use |python-buffer| objects to access to and buffer-local ones). Use |python-buffer| objects to access to
buffer-local options and |python-window| objects to access to buffer-local options and |python-window| objects to access to
@ -340,8 +340,8 @@ Output from Python *python-output*
*python-input* *python-input*
Input (via sys.stdin, including input() and raw_input()) is not Input (via sys.stdin, including input() and raw_input()) is not
supported, and may cause the program to crash. This should probably be supported, and may cause the program to crash. This should probably
fixed. be fixed.
*python2-directory* *python3-directory* *pythonx-directory* *python2-directory* *python3-directory* *pythonx-directory*
Python 'runtimepath' handling *python-special-path* Python 'runtimepath' handling *python-special-path*
@ -401,11 +401,11 @@ Implementation is similar to the following, but written in C: >
sys.path_hooks.append(hook) sys.path_hooks.append(hook)
vim.VIM_SPECIAL_PATH *python-VIM_SPECIAL_PATH* vim.VIM_SPECIAL_PATH *python-VIM_SPECIAL_PATH*
String constant used in conjunction with vim path hook. If path hook String constant used in conjunction with vim path hook. If path hook
installed by vim is requested to handle anything but path equal to installed by vim is requested to handle anything but path equal to
vim.VIM_SPECIAL_PATH constant it raises ImportError. In the only other vim.VIM_SPECIAL_PATH constant it raises ImportError. In the only
case it uses special loader. other case it uses special loader.
Note: you must not use value of this constant directly, always use Note: you must not use value of this constant directly, always use
vim.VIM_SPECIAL_PATH object. vim.VIM_SPECIAL_PATH object.
@ -422,7 +422,7 @@ vim.find_spec(...) *python-find_spec*
vim._get_paths *python-_get_paths* vim._get_paths *python-_get_paths*
Methods returning a list of paths which will be searched for by path Methods returning a list of paths which will be searched for by path
hook. You should not rely on this method being present in future hook. You should not rely on this method being present in future
versions, but can use it for debugging. versions, but can use it for debugging.
It returns a list of {rtp}/python2 (or {rtp}/python3) and It returns a list of {rtp}/python2 (or {rtp}/python3) and
@ -431,7 +431,8 @@ vim._get_paths *python-_get_paths*
============================================================================== ==============================================================================
3. Buffer objects *python-buffer* 3. Buffer objects *python-buffer*
Buffer objects represent vim buffers. You can obtain them in a number of ways: Buffer objects represent vim buffers. You can obtain them in a number of
ways:
- via vim.current.buffer (|python-current|) - via vim.current.buffer (|python-current|)
- from indexing vim.buffers (|python-buffers|) - from indexing vim.buffers (|python-buffers|)
- from the "buffer" attribute of a window (|python-window|) - from the "buffer" attribute of a window (|python-window|)
@ -445,9 +446,10 @@ act as if they were lists (yes, they are mutable) of strings, with each
element being a line of the buffer. All of the usual sequence operations, element being a line of the buffer. All of the usual sequence operations,
including indexing, index assignment, slicing and slice assignment, work as including indexing, index assignment, slicing and slice assignment, work as
you would expect. Note that the result of indexing (slicing) a buffer is a you would expect. Note that the result of indexing (slicing) a buffer is a
string (list of strings). This has one unusual consequence - b[:] is different string (list of strings). This has one unusual consequence - b[:] is
from b. In particular, "b[:] = None" deletes the whole of the buffer, whereas different from b. In particular, "b[:] = None" deletes the whole of the
"b = None" merely updates the variable b, with no effect on the buffer. buffer, whereas "b = None" merely updates the variable b, with no effect on
the buffer.
Buffer indexes start at zero, as is normal in Python. This differs from vim Buffer indexes start at zero, as is normal in Python. This differs from vim
line numbers, which start from 1. This is particularly relevant when dealing line numbers, which start from 1. This is particularly relevant when dealing
@ -458,17 +460,17 @@ The buffer object attributes are:
|buffer-variable|s. |buffer-variable|s.
b.options Mapping object (supports item getting, setting and b.options Mapping object (supports item getting, setting and
deleting) that provides access to buffer-local options deleting) that provides access to buffer-local options
and buffer-local values of |global-local| options. Use and buffer-local values of |global-local| options. Use
|python-window|.options if option is window-local, |python-window|.options if option is window-local,
this object will raise KeyError. If option is this object will raise KeyError. If option is
|global-local| and local value is missing getting it |global-local| and local value is missing getting it
will return None. will return None.
b.name String, RW. Contains buffer name (full path). b.name String, RW. Contains buffer name (full path).
Note: when assigning to b.name |BufFilePre| and Note: when assigning to b.name |BufFilePre| and
|BufFilePost| autocommands are launched. |BufFilePost| autocommands are launched.
b.number Buffer number. Can be used as |python-buffers| key. b.number Buffer number. Can be used as |python-buffers| key.
Read-only. Read-only.
b.valid True or False. Buffer object becomes invalid when b.valid True or False. Buffer object becomes invalid when
corresponding buffer is wiped out. corresponding buffer is wiped out.
The buffer object methods are: The buffer object methods are:
@ -541,7 +543,8 @@ Example (assume r is the current range): >
============================================================================== ==============================================================================
5. Window objects *python-window* 5. Window objects *python-window*
Window objects represent vim windows. You can obtain them in a number of ways: Window objects represent vim windows. You can obtain them in a number of
ways:
- via vim.current.window (|python-current|) - via vim.current.window (|python-current|)
- from indexing vim.windows (|python-windows|) - from indexing vim.windows (|python-windows|)
- from indexing "windows" attribute of a tab page (|python-tabpage|) - from indexing "windows" attribute of a tab page (|python-tabpage|)

26
runtime/doc/if_ruby.txt
View File

@ -1,4 +1,4 @@
*if_ruby.txt* For Vim version 9.1. Last change: 2019 Jul 21 *if_ruby.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Shugo Maeda VIM REFERENCE MANUAL by Shugo Maeda
@ -69,14 +69,14 @@ To see what version of Ruby you have: >
*:rubydo* *:rubyd* *E265* *:rubydo* *:rubyd* *E265*
:[range]rubyd[o] {cmd} Evaluate Ruby command {cmd} for each line in the :[range]rubyd[o] {cmd} Evaluate Ruby command {cmd} for each line in the
[range], with $_ being set to the text of each line in [range], with $_ being set to the text of each line in
turn, without a trailing <EOL>. Setting $_ will change turn, without a trailing <EOL>. Setting $_ will
the text, but note that it is not possible to add or change the text, but note that it is not possible to
delete lines using this command. add or delete lines using this command.
The default for [range] is the whole file: "1,$". The default for [range] is the whole file: "1,$".
*:rubyfile* *:rubyf* *:rubyfile* *:rubyf*
:rubyf[ile] {file} Execute the Ruby script in {file}. This is the same as :rubyf[ile] {file} Execute the Ruby script in {file}. This is the same
`:ruby load 'file'`, but allows file name completion. as `:ruby load 'file'`, but allows file name completion.
Executing Ruby commands is not possible in the |sandbox|. Executing Ruby commands is not possible in the |sandbox|.
@ -148,8 +148,8 @@ Class Methods:
current Returns the current buffer object. current Returns the current buffer object.
count Returns the number of buffers. count Returns the number of buffers.
self[{n}] Returns the buffer object for the number {n}. The first number self[{n}] Returns the buffer object for the number {n}. The first
is 0. number is 0.
Methods: Methods:
@ -157,10 +157,10 @@ name Returns the full name of the buffer.
number Returns the number of the buffer. number Returns the number of the buffer.
count Returns the number of lines. count Returns the number of lines.
length Returns the number of lines. length Returns the number of lines.
self[{n}] Returns a line from the buffer. {n} is the line number. self[{n}] Returns a line from the buffer. {n} is the line number.
self[{n}] = {str} self[{n}] = {str}
Sets a line in the buffer. {n} is the line number. Sets a line in the buffer. {n} is the line number.
delete({n}) Deletes a line from the buffer. {n} is the line number. delete({n}) Deletes a line from the buffer. {n} is the line number.
append({n}, {str}) append({n}, {str})
Appends a line after the line {n}. Appends a line after the line {n}.
line Returns the current line of the buffer if the buffer is line Returns the current line of the buffer if the buffer is
@ -178,8 +178,8 @@ Class Methods:
current Returns the current window object. current Returns the current window object.
count Returns the number of windows. count Returns the number of windows.
self[{n}] Returns the window object for the number {n}. The first number self[{n}] Returns the window object for the number {n}. The first
is 0. number is 0.
Methods: Methods:

17
runtime/doc/if_tcl.txt
View File

@ -1,4 +1,4 @@
*if_tcl.txt* For Vim version 9.1. Last change: 2025 Aug 29 *if_tcl.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Ingo Wilken VIM REFERENCE MANUAL by Ingo Wilken
@ -234,8 +234,8 @@ The ::vim::current(window) variable contains the name of the window command
for the current window. A window command is automatically deleted when the for the current window. A window command is automatically deleted when the
corresponding vim window is closed. corresponding vim window is closed.
Let's assume the name of the window command is stored in the Tcl variable "win", Let's assume the name of the window command is stored in the Tcl variable
i.e. "$win" calls the command. The following options are available: > "win", i.e. "$win" calls the command. The following options are available: >
$win buffer # Create Tcl command for window's buffer. $win buffer # Create Tcl command for window's buffer.
$win command {cmd} # Execute Ex command in windows context. $win command {cmd} # Execute Ex command in windows context.
@ -264,7 +264,8 @@ Options:
array set here [$win cursor] array set here [$win cursor]
< "here(row)" and "here(column)" now contain the cursor position. < "here(row)" and "here(column)" now contain the cursor position.
With a single argument, the argument is interpreted as the name of a With a single argument, the argument is interpreted as the name of a
Tcl array variable, which must contain two elements "row" and "column". Tcl array variable, which must contain two elements "row" and
"column".
These are used to set the cursor to the new position: > These are used to set the cursor to the new position: >
$win cursor here ;# not $here ! $win cursor here ;# not $here !
< With two arguments, sets the cursor to the specified row and column: > < With two arguments, sets the cursor to the specified row and column: >
@ -313,8 +314,8 @@ changed, all marks in the buffer are automatically adjusted. Any changes to
the buffer's contents made by Tcl commands can be undone with the "undo" vim the buffer's contents made by Tcl commands can be undone with the "undo" vim
command (see |undo|). command (see |undo|).
Let's assume the name of the buffer command is stored in the Tcl variable "buf", Let's assume the name of the buffer command is stored in the Tcl variable
i.e. "$buf" calls the command. The following options are available: > "buf", i.e. "$buf" calls the command. The following options are available: >
$buf append {n} {str} # Append a line to buffer, after line {n}. $buf append {n} {str} # Append a line to buffer, after line {n}.
$buf command {cmd} # Execute Ex command in buffers context. $buf command {cmd} # Execute Ex command in buffers context.
@ -404,8 +405,8 @@ Options:
deleted from the buffer. deleted from the buffer.
$buf windows *tcl-buffer-windows* $buf windows *tcl-buffer-windows*
Creates a window command for each window that displays this buffer, and Creates a window command for each window that displays this buffer,
returns a list of the command names as the result. and returns a list of the command names as the result.
Example: > Example: >
set winlist [$buf windows] set winlist [$buf windows]
foreach win $winlist { $win height 4 } foreach win $winlist { $win height 4 }

75
runtime/doc/indent.txt
View File

@ -1,4 +1,4 @@
*indent.txt* For Vim version 9.1. Last change: 2024 Dec 16 *indent.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -44,7 +44,8 @@ These five options control C program indenting:
'cinkeys' Specifies which keys trigger reindenting in insert mode. 'cinkeys' Specifies which keys trigger reindenting in insert mode.
'cinoptions' Sets your preferred indent style. 'cinoptions' Sets your preferred indent style.
'cinwords' Defines keywords that start an extra indent in the next line. 'cinwords' Defines keywords that start an extra indent in the next line.
'cinscopedecls' Defines strings that are recognized as a C++ scope declaration. 'cinscopedecls' Defines strings that are recognized as a C++ scope
declaration.
If 'lisp' is not on and 'equalprg' is empty, the "=" operator indents using If 'lisp' is not on and 'equalprg' is empty, the "=" operator indents using
Vim's built-in algorithm rather than calling an external program. Vim's built-in algorithm rather than calling an external program.
@ -229,8 +230,8 @@ The examples below assume a 'shiftwidth' of 4.
} } } } } }
< <
*cino-L* *cino-L*
LN Controls placement of jump labels. If N is negative, the label LN Controls placement of jump labels. If N is negative, the label
will be placed at column 1. If N is non-negative, the indent of will be placed at column 1. If N is non-negative, the indent of
the label will be the prevailing indent minus N. (default -1). the label will be the prevailing indent minus N. (default -1).
cino= cino=L2 cino=Ls > cino= cino=L2 cino=Ls >
@ -291,8 +292,8 @@ The examples below assume a 'shiftwidth' of 4.
< <
*cino-g* *cino-g*
gN Place C++ scope declarations N characters from the indent of the gN Place C++ scope declarations N characters from the indent of the
block they are in. (default 'shiftwidth'). By default, a scope block they are in. (default 'shiftwidth'). By default, a scope
declaration is "public:", "protected:" or "private:". This can declaration is "public:", "protected:" or "private:". This can
be adjusted with the 'cinscopedecls' option. be adjusted with the 'cinscopedecls' option.
cino= cino=g0 > cino= cino=g0 >
@ -714,13 +715,13 @@ FORTRAN *ft-fortran-indent*
Block if, select case, select type, select rank, where, forall, type, Block if, select case, select type, select rank, where, forall, type,
interface, associate, block, enum, critical, and change team constructs are interface, associate, block, enum, critical, and change team constructs are
indented. The indenting of subroutines, functions, modules, and program blocks indented. The indenting of subroutines, functions, modules, and program
is optional. Comments, labeled statements, and continuation lines are indented blocks is optional. Comments, labeled statements, and continuation lines are
if the Fortran is in free source form, whereas they are not indented if the indented if the Fortran is in free source form, whereas they are not indented
Fortran is in fixed source form because of the left margin requirements. Hence if the Fortran is in fixed source form because of the left margin
manual indent corrections will be necessary for labeled statements and requirements. Hence manual indent corrections will be necessary for labeled
continuation lines when fixed source form is being used. For further statements and continuation lines when fixed source form is being used. For
discussion of the method used for the detection of source format see further discussion of the method used for the detection of source format see
|ft-fortran-syntax|. |ft-fortran-syntax|.
Do loops ~ Do loops ~
@ -819,19 +820,19 @@ Idris 2 indentation can be configured with several variables that control the
indentation level for different language constructs: indentation level for different language constructs:
The "g:idris2_indent_if" variable controls the indentation of `then` and `else` The "g:idris2_indent_if" variable controls the indentation of `then` and `else`
blocks after `if` statements. Defaults to 3. blocks after `if` statements. Defaults to 3.
The "g:idris2_indent_case" variable controls the indentation of patterns in The "g:idris2_indent_case" variable controls the indentation of patterns in
`case` expressions. Defaults to 5. `case` expressions. Defaults to 5.
The "g:idris2_indent_let" variable controls the indentation after `let` The "g:idris2_indent_let" variable controls the indentation after `let`
bindings. Defaults to 4. bindings. Defaults to 4.
The "g:idris2_indent_rewrite" variable controls the indentation after `rewrite` The "g:idris2_indent_rewrite" variable controls the indentation after `rewrite`
expressions. Defaults to 8. expressions. Defaults to 8.
The "g:idris2_indent_where" variable controls the indentation of `where` The "g:idris2_indent_where" variable controls the indentation of `where`
blocks. Defaults to 6. blocks. Defaults to 6.
The "g:idris2_indent_do" variable controls the indentation in `do` blocks. The "g:idris2_indent_do" variable controls the indentation in `do` blocks.
Defaults to 3. Defaults to 3.
@ -951,7 +952,7 @@ To indent 'case:' and 'default:' statements in switch() blocks: >
In PHP braces are not required inside 'case/default' blocks therefore 'case:' In PHP braces are not required inside 'case/default' blocks therefore 'case:'
and 'default:' are indented at the same level than the 'switch()' to avoid and 'default:' are indented at the same level than the 'switch()' to avoid
meaningless indentation. You can use the above option to return to the meaningless indentation. You can use the above option to return to the
traditional way. traditional way.
------------- -------------
@ -978,7 +979,7 @@ You will obtain the following result: >
Extra indentation levels to add to parameters in multi-line function calls. > Extra indentation levels to add to parameters in multi-line function calls. >
let g:PHP_IndentFunctionCallParameters = 1 let g:PHP_IndentFunctionCallParameters = 1
Function call arguments will indent 1 extra level. For two-space indentation: > Function call arguments will indent 1 extra level. For two-space indentation: >
function call_the_thing( function call_the_thing(
$with_this, $with_this,
@ -997,7 +998,7 @@ Extra indentation levels to add to arguments in multi-line function
definitions. > definitions. >
let g:PHP_IndentFunctionDeclarationParameters = 1 let g:PHP_IndentFunctionDeclarationParameters = 1
Function arguments in declarations will indent 1 extra level. For two-space Function arguments in declarations will indent 1 extra level. For two-space
indentation: > indentation: >
function call_the_thing( function call_the_thing(
@ -1027,8 +1028,8 @@ Indent after a nested paren: >
Indent for a continuation line: > Indent for a continuation line: >
let g:python_indent.continue = 'shiftwidth() * 2' let g:python_indent.continue = 'shiftwidth() * 2'
By default, the closing paren on a multiline construct lines up under the first By default, the closing paren on a multiline construct lines up under the
non-whitespace character of the previous line. first non-whitespace character of the previous line.
If you prefer that it's lined up under the first character of the line that If you prefer that it's lined up under the first character of the line that
starts the multiline construct, reset this key: > starts the multiline construct, reset this key: >
let g:python_indent.closed_paren_align_last_line = v:false let g:python_indent.closed_paren_align_last_line = v:false
@ -1053,15 +1054,15 @@ For backward compatibility, these variables are also supported: >
R *ft-r-indent* R *ft-r-indent*
Function arguments are aligned if they span for multiple lines. If you prefer Function arguments are aligned if they span for multiple lines. If you prefer
do not have the arguments of functions aligned, put in your |vimrc|: do not have the arguments of functions aligned, put in your |vimrc|:
> >
let r_indent_align_args = 0 let r_indent_align_args = 0
< <
All lines beginning with a comment character, #, get the same indentation All lines beginning with a comment character, #, get the same indentation
level of the normal R code. Users of Emacs/ESS may be used to have lines level of the normal R code. Users of Emacs/ESS may be used to have lines
beginning with a single # indented in the 40th column, ## indented as R code, beginning with a single # indented in the 40th column, ## indented as R code,
and ### not indented. If you prefer that lines beginning with comment and ### not indented. If you prefer that lines beginning with comment
characters are aligned as they are by Emacs/ESS, put in your |vimrc|: characters are aligned as they are by Emacs/ESS, put in your |vimrc|:
> >
let r_indent_ess_comments = 1 let r_indent_ess_comments = 1
@ -1072,8 +1073,8 @@ r_indent_comment_column, as in the example below:
> >
let r_indent_comment_column = 30 let r_indent_comment_column = 30
< <
Any code after a line that ends with "<-" is indented. Emacs/ESS does not Any code after a line that ends with "<-" is indented. Emacs/ESS does not
indent the code if it is a top-level function. If you prefer a behavior like indent the code if it is a top-level function. If you prefer a behavior like
Emacs/ESS one in this regard, put in your |vimrc|: Emacs/ESS one in this regard, put in your |vimrc|:
> >
let r_indent_ess_compatible = 1 let r_indent_ess_compatible = 1
@ -1088,7 +1089,7 @@ Below is an example of indentation with and without this option enabled:
} } } }
< <
The code will be indented after lines that match the pattern The code will be indented after lines that match the pattern
`'\(&\||\|+\|-\|\*\|/\|=\|\~\|%\|->\)\s*$'`. If you want indentation after `'\(&\||\|+\|-\|\*\|/\|=\|\~\|%\|->\)\s*$'`. If you want indentation after
lines that match a different pattern, you should set the appropriate value of lines that match a different pattern, you should set the appropriate value of
`r_indent_op_pattern` in your |vimrc|. `r_indent_op_pattern` in your |vimrc|.
@ -1153,7 +1154,7 @@ Make sure to do ":set cmdheight=2" first to allow the display of the message.
VHDL *ft-vhdl-indent* VHDL *ft-vhdl-indent*
Alignment of generic/port mapping statements are performed by default. This Alignment of generic/port mapping statements are performed by default. This
causes the following alignment example: > causes the following alignment example: >
ENTITY sync IS ENTITY sync IS
@ -1183,7 +1184,7 @@ to the .vimrc file, which causes the previous alignment example to change: >
---------------------------------------- ----------------------------------------
Alignment of right-hand side assignment "<=" statements are performed by Alignment of right-hand side assignment "<=" statements are performed by
default. This causes the following alignment example: > default. This causes the following alignment example: >
sig_out <= (bus_a(1) AND sig_out <= (bus_a(1) AND
(sig_b OR sig_c)) OR (sig_b OR sig_c)) OR
@ -1201,9 +1202,9 @@ to the .vimrc file, which causes the previous alignment example to change: >
---------------------------------------- ----------------------------------------
Full-line comments (lines that begin with "--") are indented to be aligned with Full-line comments (lines that begin with "--") are indented to be aligned
the very previous line's comment, PROVIDED that a whitespace follows after with the very previous line's comment, PROVIDED that a whitespace follows
"--". after "--".
For example: > For example: >
@ -1255,9 +1256,9 @@ results in: >
Notice that "--debug_code:" does not align with "-- comment 2" Notice that "--debug_code:" does not align with "-- comment 2"
because there is no whitespace that follows after "--" in "--debug_code:". because there is no whitespace that follows after "--" in "--debug_code:".
Given the dynamic nature of indenting comments, indenting should be done TWICE. Given the dynamic nature of indenting comments, indenting should be done
On the first pass, code will be indented. On the second pass, full-line TWICE. On the first pass, code will be indented. On the second pass,
comments will be indented according to the correctly indented code. full-line comments will be indented according to the correctly indented code.
VIM *ft-vim-indent* VIM *ft-vim-indent*

85
runtime/doc/insert.txt
View File

@ -130,7 +130,7 @@ CTRL-R {register} *i_CTRL-R*
'.' the last inserted text '.' the last inserted text
*i_CTRL-R_-* *i_CTRL-R_-*
'-' the last small (less than a line) delete '-' the last small (less than a line) delete
register. This is repeatable using |.| since register. This is repeatable using |.| since
it remembers the register to put instead of it remembers the register to put instead of
the literal text to insert. the literal text to insert.
*i_CTRL-R_=* *i_CTRL-R_=*
@ -167,12 +167,12 @@ CTRL-R CTRL-R {register} *i_CTRL-R_CTRL-R*
CTRL-R CTRL-O {register} *i_CTRL-R_CTRL-O* CTRL-R CTRL-O {register} *i_CTRL-R_CTRL-O*
Insert the contents of a register literally and don't Insert the contents of a register literally and don't
auto-indent. Does the same as pasting with the mouse auto-indent. Does the same as pasting with the mouse
|<MiddleMouse>|. When the register is linewise this will |<MiddleMouse>|. When the register is linewise this will
insert the text above the current line, like with `P`. insert the text above the current line, like with `P`.
The '.' register (last inserted text) is still inserted as The '.' register (last inserted text) is still inserted as
typed. typed.
After this command, the '.' register contains the command After this command, the '.' register contains the command
typed and not the text. I.e., the literals "^R^O" and not the typed and not the text. I.e., the literals "^R^O" and not the
text from the register. text from the register.
Does not replace characters in |Replace-mode|! Does not replace characters in |Replace-mode|!
@ -182,7 +182,7 @@ CTRL-R CTRL-P {register} *i_CTRL-R_CTRL-P*
The '.' register (last inserted text) is still inserted as The '.' register (last inserted text) is still inserted as
typed. typed.
After this command, the '.' register contains the command After this command, the '.' register contains the command
typed and not the text. I.e., the literals "^R^P" and not the typed and not the text. I.e., the literals "^R^P" and not the
text from the register. text from the register.
Does not replace characters in |Replace-mode|! Does not replace characters in |Replace-mode|!
@ -559,10 +559,10 @@ extra spaces to get where you want to be.
*ins-smarttab* *ins-smarttab*
When the 'smarttab' option is on, the <Tab> key indents by 'shiftwidth' if the When the 'smarttab' option is on, the <Tab> key indents by 'shiftwidth' if the
cursor is in leading whitespace. The <BS> key has the opposite effect. This cursor is in leading whitespace. The <BS> key has the opposite effect. This
behaves as if 'softtabstop' were set to the value of 'shiftwidth'. This option behaves as if 'softtabstop' were set to the value of 'shiftwidth'. This
allows the user to set 'softtabstop' to a value other than 'shiftwidth' and option allows the user to set 'softtabstop' to a value other than 'shiftwidth'
still use the <Tab> key for indentation. and still use the <Tab> key for indentation.
============================================================================== ==============================================================================
5. Replace mode *Replace* *Replace-mode* *mode-replace* 5. Replace mode *Replace* *Replace-mode* *mode-replace*
@ -663,7 +663,8 @@ not a valid CTRL-X mode command. Valid keys are the CTRL-X command itself,
CTRL-N (next), and CTRL-P (previous). CTRL-N (next), and CTRL-P (previous).
By default, the possible completions are showed in a menu and the first By default, the possible completions are showed in a menu and the first
completion is inserted into the text. This can be adjusted with 'completeopt'. completion is inserted into the text. This can be adjusted with
'completeopt'.
To get the current completion information, |complete_info()| can be used. To get the current completion information, |complete_info()| can be used.
Also see the 'infercase' option if you want to adjust the case of the match. Also see the 'infercase' option if you want to adjust the case of the match.
@ -889,7 +890,7 @@ Completing keywords with 'thesaurusfunc' *compl-thesaurusfunc*
If the 'thesaurusfunc' option is set, then the user specified function is If the 'thesaurusfunc' option is set, then the user specified function is
invoked to get the list of completion matches and the 'thesaurus' option is invoked to get the list of completion matches and the 'thesaurus' option is
not used. See |complete-functions| for an explanation of how the function is not used. See |complete-functions| for an explanation of how the function is
invoked and what it should return. invoked and what it should return.
Here is an example that uses the "aiksaurus" command (provided by Magnus Here is an example that uses the "aiksaurus" command (provided by Magnus
@ -1139,8 +1140,8 @@ CTRL-X CTRL-Z Stop completion without changing the text.
AUTOCOMPLETION *ins-autocompletion* AUTOCOMPLETION *ins-autocompletion*
Vim can display a completion menu as you type, similar to using |i_CTRL-N|, Vim can display a completion menu as you type, similar to using |i_CTRL-N|,
but triggered automatically. See 'autocomplete'. The menu items are collected but triggered automatically. See 'autocomplete'. The menu items are
from the sources listed in the 'complete' option, in order. collected from the sources listed in the 'complete' option, in order.
A decaying timeout keeps Vim responsive. Sources earlier in the 'complete' A decaying timeout keeps Vim responsive. Sources earlier in the 'complete'
list get more time (higher priority), but all sources receive at least a small list get more time (higher priority), but all sources receive at least a small
@ -1248,7 +1249,7 @@ items:
items to be equal; when omitted zero is used, thus items to be equal; when omitted zero is used, thus
items that only differ in case are added items that only differ in case are added
equal when non-zero, always treat this item to be equal when equal when non-zero, always treat this item to be equal when
comparing. Which means, "equal=1" disables filtering comparing. Which means, "equal=1" disables filtering
of this item. of this item.
dup when non-zero this match will be added even when an dup when non-zero this match will be added even when an
item with the same word is already present. item with the same word is already present.
@ -1264,7 +1265,7 @@ items:
properties (with higher priority) like strikethrough properties (with higher priority) like strikethrough
to the completion items abbreviation to the completion items abbreviation
kind_hlgroup an additional highlight group specifically for setting kind_hlgroup an additional highlight group specifically for setting
the highlight attributes of the completion kind. When the highlight attributes of the completion kind. When
this field is present, it will override the this field is present, it will override the
|hl-PmenuKind| highlight group, allowing for the |hl-PmenuKind| highlight group, allowing for the
customization of ctermfg and guifg properties for the customization of ctermfg and guifg properties for the
@ -1455,7 +1456,8 @@ any printable, non-white character:
Add this character and reduce the number of matches. Add this character and reduce the number of matches.
In all three states these can be used: In all three states these can be used:
CTRL-Y Yes: Accept the currently selected match and stop completion. CTRL-Y Yes: Accept the currently selected match and stop
completion.
CTRL-E End completion, go back to what was there before selecting a CTRL-E End completion, go back to what was there before selecting a
match (what was typed or longest common string). match (what was typed or longest common string).
<PageUp> Select a match several entries back, but don't insert it. <PageUp> Select a match several entries back, but don't insert it.
@ -1559,7 +1561,7 @@ XHTML *ft-xhtml-omni*
CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is
designed to support writing of XHTML 1.0 Strict files but will also work for designed to support writing of XHTML 1.0 Strict files but will also work for
other versions of HTML. Features: other versions of HTML. Features:
- after "<" complete tag name depending on context (no div suggestion inside - after "<" complete tag name depending on context (no div suggestion inside
of an a tag); '/>' indicates empty tags of an a tag); '/>' indicates empty tags
@ -1577,7 +1579,7 @@ other versions of HTML. Features:
Note: When used first time completion menu will be shown with little delay Note: When used first time completion menu will be shown with little delay
- this is time needed for loading of data file. - this is time needed for loading of data file.
Note: Completion may fail in badly formatted documents. In such case try to Note: Completion may fail in badly formatted documents. In such case try to
run |:make| command to detect formatting problems. run |:make| command to detect formatting problems.
@ -1591,7 +1593,7 @@ When doing completion outside of any other tag you will have possibility to
choose DOCTYPE and the appropriate data file will be loaded and used for all choose DOCTYPE and the appropriate data file will be loaded and used for all
next completions. next completions.
More about format of data file in |xml-omni-datafile|. Some of the data files More about format of data file in |xml-omni-datafile|. Some of the data files
may be found on the Vim website (|www|). may be found on the Vim website (|www|).
Note that b:html_omni_flavor may point to a file with any XML data. This Note that b:html_omni_flavor may point to a file with any XML data. This
@ -1620,8 +1622,8 @@ of external files).
DOM compatibility DOM compatibility
At the moment (beginning of 2006) there are two main browsers - MS Internet At the moment (beginning of 2006) there are two main browsers - MS Internet
Explorer and Mozilla Firefox. These two applications are covering over 90% of Explorer and Mozilla Firefox. These two applications are covering over 90% of
market. Theoretically standards are created by W3C organisation market. Theoretically standards are created by W3C organisation
(http://www.w3c.org) but they are not always followed/implemented. (http://www.w3c.org) but they are not always followed/implemented.
IE FF W3C Omni completion ~ IE FF W3C Omni completion ~
@ -1631,16 +1633,16 @@ market. Theoretically standards are created by W3C organisation
- + - - ~ - + - - ~
Regardless from state of implementation in browsers but if element is defined Regardless from state of implementation in browsers but if element is defined
in standards, completion plugin will place element in suggestion list. When in standards, completion plugin will place element in suggestion list. When
both major engines implemented element, even if this is not in standards it both major engines implemented element, even if this is not in standards it
will be suggested. All other elements are not placed in suggestion list. will be suggested. All other elements are not placed in suggestion list.
PHP *ft-php-omni* PHP *ft-php-omni*
Completion of PHP code requires a tags file for completion of data from Completion of PHP code requires a tags file for completion of data from
external files and for class aware completion. You should use Universal/ external files and for class aware completion. You should use Universal/
Exuberant ctags version 5.5.4 or newer. You can find it here: Exuberant ctags version 5.5.4 or newer. You can find it here:
Universal Ctags: https://ctags.io Universal Ctags: https://ctags.io
Exuberant Ctags: http://ctags.sourceforge.net Exuberant Ctags: http://ctags.sourceforge.net
@ -1648,11 +1650,12 @@ Exuberant ctags version 5.5.4 or newer. You can find it here:
Script completes: Script completes:
- after $ variables name - after $ variables name
- if variable was declared as object add "->", if tags file is available show - if variable was declared as object add "->", if tags file is available
name of class show name of class
- after "->" complete only function and variable names specific for given - after "->" complete only function and variable names specific for given
class. To find class location and contents tags file is required. Because class. To find class location and contents tags file is required.
PHP isn't strongly typed language user can use @var tag to declare class: > Because PHP isn't strongly typed language user can use @var tag to declare
class: >
/* @var $myVar myClass */ /* @var $myVar myClass */
$myVar-> $myVar->
@ -1670,11 +1673,11 @@ Script completes:
Note: when doing completion first time Vim will load all necessary data into Note: when doing completion first time Vim will load all necessary data into
memory. It may take several seconds. After next use of completion delay memory. It may take several seconds. After next use of completion delay
should not be noticeable. should not be noticeable.
Script detects if cursor is inside <?php ?> tags. If it is outside it will Script detects if cursor is inside <?php ?> tags. If it is outside it will
automatically switch to HTML/CSS/JavaScript completion. Note: contrary to automatically switch to HTML/CSS/JavaScript completion. Note: contrary to
original HTML files completion of tags (and only tags) isn't context aware. original HTML files completion of tags (and only tags) isn't context aware.
@ -1701,11 +1704,11 @@ The completions provided by CTRL-X CTRL-O are sensitive to the context:
Notes: Notes:
- Vim will load/evaluate code in order to provide completions. This may - Vim will load/evaluate code in order to provide completions. This may
cause some code execution, which may be a concern. This is no longer cause some code execution, which may be a concern. This is no longer
enabled by default, to enable this feature add > enabled by default, to enable this feature add >
let g:rubycomplete_buffer_loading = 1 let g:rubycomplete_buffer_loading = 1
<- In context 1 above, Vim can parse the entire buffer to add a list of <- In context 1 above, Vim can parse the entire buffer to add a list of
classes to the completion results. This feature is turned off by default, classes to the completion results. This feature is turned off by default,
to enable it add > to enable it add >
let g:rubycomplete_classes_in_global = 1 let g:rubycomplete_classes_in_global = 1
< to your vimrc < to your vimrc
@ -1713,7 +1716,7 @@ Notes:
- In context 3 above, Vim will attempt to determine the methods supported by - In context 3 above, Vim will attempt to determine the methods supported by
the object. the object.
- Vim can detect and load the Rails environment for files within a rails - Vim can detect and load the Rails environment for files within a rails
project. The feature is disabled by default, to enable it add > project. The feature is disabled by default, to enable it add >
let g:rubycomplete_rails = 1 let g:rubycomplete_rails = 1
< to your vimrc < to your vimrc
@ -1750,11 +1753,11 @@ a look at the PHP filetype to see how this works.
If you edit a file called, index.php, run the following command: > If you edit a file called, index.php, run the following command: >
syntax list syntax list
The first thing you will notice is that there are many different syntax groups. The first thing you will notice is that there are many different syntax
The PHP language can include elements from different languages like HTML, groups. The PHP language can include elements from different languages like
JavaScript and many more. The syntax plugin will only include syntax groups HTML, JavaScript and many more. The syntax plugin will only include syntax
that begin with the filetype, "php", in this case. For example these syntax groups that begin with the filetype, "php", in this case. For example these
groups are included by default with the PHP: phpEnvVar, phpIntVar, syntax groups are included by default with the PHP: phpEnvVar, phpIntVar,
phpFunctions. phpFunctions.
If you wish non-filetype syntax items to also be included, you can use a If you wish non-filetype syntax items to also be included, you can use a
@ -1873,7 +1876,7 @@ be used in commands. It should be a unique name which will not create
conflicts. For example, the name xhtml10s.vim means it is the data file for conflicts. For example, the name xhtml10s.vim means it is the data file for
XHTML 1.0 Strict. XHTML 1.0 Strict.
Each file contains a variable with a name like g:xmldata_xhtml10s . It is Each file contains a variable with a name like g:xmldata_xhtml10s . It is
a compound from two parts: a compound from two parts:
1. "g:xmldata_" general prefix, constant for all data files 1. "g:xmldata_" general prefix, constant for all data files
@ -2090,7 +2093,7 @@ These two commands will keep on asking for lines, until you type a line
containing only a ".". Watch out for lines starting with a backslash, see containing only a ".". Watch out for lines starting with a backslash, see
|line-continuation|. |line-continuation|.
Text typed after a "|" command separator is used first. So the following Text typed after a "|" command separator is used first. So the following
command in ex mode: > command in ex mode: >
:a|one :a|one
two two

12
runtime/doc/intro.txt
View File

@ -1,4 +1,4 @@
*intro.txt* For Vim version 9.1. Last change: 2025 Oct 11 *intro.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -99,7 +99,8 @@ There are several mailing lists for Vim:
For discussions about using and improving the Macintosh version of For discussions about using and improving the Macintosh version of
Vim. Vim.
<vim-security@googlegroups.com> *vim-security* <vim-security@googlegroups.com> *vim-security*
This list is for (privately) discussing security relevant issues of Vim. This list is for (privately) discussing security relevant issues of
Vim.
See http://www.vim.org/maillist.php for the latest information. See http://www.vim.org/maillist.php for the latest information.
@ -236,7 +237,8 @@ Vim would never have become what it is now, without the help of these people!
Felix von Leitner Previous maintainer of Vim Mailing Lists Felix von Leitner Previous maintainer of Vim Mailing Lists
David Leonard Port of Python extensions to Unix David Leonard Port of Python extensions to Unix
Avner Lottem Edit in right-to-left windows Avner Lottem Edit in right-to-left windows
Flemming Madsen X11 client-server, various features and patches Flemming Madsen X11 client-server, various features and
patches
Tony Mechelynck answers many user questions Tony Mechelynck answers many user questions
Paul Moore Python interface extensions, many patches Paul Moore Python interface extensions, many patches
Katsuhito Nagano Work on multibyte versions Katsuhito Nagano Work on multibyte versions
@ -606,8 +608,8 @@ Operator-pending mode This is like Normal mode, but after an operator
Replace mode Replace mode is a special case of Insert mode. You Replace mode Replace mode is a special case of Insert mode. You
can do the same things as in Insert mode, but for can do the same things as in Insert mode, but for
each character you enter, one character of the existing each character you enter, one character of the
text is deleted. See |Replace-mode|. existing text is deleted. See |Replace-mode|.
If the 'showmode' option is on "-- REPLACE --" is If the 'showmode' option is on "-- REPLACE --" is
shown at the bottom of the window. shown at the bottom of the window.

60
runtime/doc/map.txt
View File

@ -1,4 +1,4 @@
*map.txt* For Vim version 9.1. Last change: 2025 Aug 06 *map.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -105,7 +105,7 @@ modes.
map command applies. The mapping may remain defined map command applies. The mapping may remain defined
for other modes where it applies. for other modes where it applies.
It also works when {lhs} matches the {rhs} of a It also works when {lhs} matches the {rhs} of a
mapping. This is for when an abbreviation applied. mapping. This is for when an abbreviation applied.
Note: Trailing spaces are included in the {lhs}. Note: Trailing spaces are included in the {lhs}.
See |map-trailing-white|. See |map-trailing-white|.
@ -295,7 +295,7 @@ In case you want the mapping to not do anything, you can have the expression
evaluate to an empty string. If something changed that requires Vim to evaluate to an empty string. If something changed that requires Vim to
go through the main loop (e.g. to update the display), return "\<Ignore>". go through the main loop (e.g. to update the display), return "\<Ignore>".
This is similar to "nothing" but makes Vim return from the loop that waits for This is similar to "nothing" but makes Vim return from the loop that waits for
input. Example: > input. Example: >
func s:OpenPopup() func s:OpenPopup()
call popup_create(... arguments ...) call popup_create(... arguments ...)
return "\<Ignore>" return "\<Ignore>"
@ -330,7 +330,7 @@ For this reason the following is blocked:
If you want the mapping to do any of these let the returned characters do If you want the mapping to do any of these let the returned characters do
that, or use a |<Cmd>| mapping instead. that, or use a |<Cmd>| mapping instead.
You can use getchar(), it consumes typeahead if there is any. E.g., if you You can use getchar(), it consumes typeahead if there is any. E.g., if you
have these mappings: > have these mappings: >
inoremap <expr> <C-L> nr2char(getchar()) inoremap <expr> <C-L> nr2char(getchar())
inoremap <expr> <C-L>x "foo" inoremap <expr> <C-L>x "foo"
@ -542,7 +542,7 @@ it's just used here for this situation.
The simplest way to load a set of related language mappings is by using the The simplest way to load a set of related language mappings is by using the
'keymap' option. See |45.5|. 'keymap' option. See |45.5|.
In Insert mode and in Command-line mode the mappings can be disabled with In Insert mode and in Command-line mode the mappings can be disabled with
the CTRL-^ command |i_CTRL-^| |c_CTRL-^|. These commands change the value of the CTRL-^ command |i_CTRL-^| |c_CTRL-^|. These commands change the value of
the 'iminsert' option. When starting to enter a normal command line (not a the 'iminsert' option. When starting to enter a normal command line (not a
search pattern) the mappings are disabled until a CTRL-^ is typed. The state search pattern) the mappings are disabled until a CTRL-^ is typed. The state
last used is remembered for Insert mode and Search patterns separately. The last used is remembered for Insert mode and Search patterns separately. The
@ -590,7 +590,7 @@ e.g. from a timer callback. *E1309*
*:map-verbose* *:map-verbose*
When 'verbose' is non-zero, the detected and used 'keyprotocol' value will be When 'verbose' is non-zero, the detected and used 'keyprotocol' value will be
displayed in the first line. Also a key map will also display where it was displayed in the first line. Also a key map will also display where it was
last defined. Example: > last defined. Example: >
:verbose map <C-W>* :verbose map <C-W>*
@ -748,7 +748,7 @@ Upper and lowercase differences are ignored.
*map-comments* *map-comments*
It is not possible to put a comment after these commands, because the '"' It is not possible to put a comment after these commands, because the '"'
character is considered to be part of the {lhs} or {rhs}. However, one can character is considered to be part of the {lhs} or {rhs}. However, one can
use |", since this starts a new, empty command with a comment. use |", since this starts a new, empty command with a comment.
*map_bar* *map-bar* *map_bar* *map-bar*
@ -827,7 +827,7 @@ Multiplying a count
When you type a count before triggering a mapping, it's like the count was When you type a count before triggering a mapping, it's like the count was
typed before the {lhs}. For example, with this mapping: > typed before the {lhs}. For example, with this mapping: >
:map <F4> 3w :map <F4> 3w
Typing 2<F4> will result in "23w". Thus not moving 2 * 3 words but 23 words. Typing 2<F4> will result in "23w". Thus not moving 2 * 3 words but 23 words.
If you want to multiply counts use the expression register: > If you want to multiply counts use the expression register: >
:map <F4> @='3w'<CR> :map <F4> @='3w'<CR>
The part between quotes is the expression being executed. |@=| The part between quotes is the expression being executed. |@=|
@ -960,7 +960,7 @@ configuration). For that, you can add the line: >
set convert-meta on set convert-meta on
to your ~/.inputrc file. If you're creating the file, you might want to use: > to your ~/.inputrc file. If you're creating the file, you might want to use: >
$include /etc/inputrc $include /etc/inputrc
@ -991,8 +991,8 @@ in Insert mode: >
1.12 MAPPING SUPER-KEYS or COMMAND-KEYS *:map-super-keys* *:map-cmd-key* 1.12 MAPPING SUPER-KEYS or COMMAND-KEYS *:map-super-keys* *:map-cmd-key*
The Super modifier is available in GUI mode (when |gui_running| is 1) for gVim The Super modifier is available in GUI mode (when |gui_running| is 1) for gVim
on Linux and MacVim on Mac OS. If you're on a Mac, this represents the Command on Linux and MacVim on Mac OS. If you're on a Mac, this represents the
key, on Linux with the GTK GUI it represents the Super key. Command key, on Linux with the GTK GUI it represents the Super key.
The character "D" is used for the Super / Command modifier. The character "D" is used for the Super / Command modifier.
For example, to map Command-b in Insert mode: > For example, to map Command-b in Insert mode: >
@ -1244,7 +1244,7 @@ an additional rule:
full-id In front of the match is a non-keyword character, or this is where full-id In front of the match is a non-keyword character, or this is where
the line or insertion starts. Exception: When the abbreviation is the line or insertion starts. Exception: When the abbreviation is
only one character, it is not recognized if there is a non-keyword only one character, it is not recognized if there is a non-keyword
character in front of it, other than a space or a tab. However, for character in front of it, other than a space or a tab. However, for
the command line "'<,'>" (or any other marks) is ignored, as if the the command line "'<,'>" (or any other marks) is ignored, as if the
command line starts after it. command line starts after it.
@ -1502,8 +1502,8 @@ be the user command ":Cc2" without an argument, or the command ":Cc" with
argument "2". It is advised to put a space between the command name and the argument "2". It is advised to put a space between the command name and the
argument to avoid these problems. argument to avoid these problems.
When using a user-defined command, the command can be abbreviated. However, if When using a user-defined command, the command can be abbreviated. However,
an abbreviation is not unique, an error will be issued. Furthermore, a if an abbreviation is not unique, an error will be issued. Furthermore, a
built-in command will always take precedence. built-in command will always take precedence.
Example: > Example: >
@ -1519,8 +1519,8 @@ It is recommended that full names for user-defined commands are used in
scripts. scripts.
:com[mand] *:com* *:command* :com[mand] *:com* *:command*
List all user-defined commands. When listing commands, List all user-defined commands. When listing
the characters in the first columns are: commands, the characters in the first columns are:
! Command has the -bang attribute ! Command has the -bang attribute
" Command has the -register attribute " Command has the -register attribute
| Command has the -bar attribute | Command has the -bar attribute
@ -1535,7 +1535,7 @@ scripts.
*:command-verbose* *:command-verbose*
When 'verbose' is non-zero, listing a command will also display where it was When 'verbose' is non-zero, listing a command will also display where it was
last defined and any completion argument. Example: > last defined and any completion argument. Example: >
:verbose command TOhtml :verbose command TOhtml
< Name Args Range Complete Definition ~ < Name Args Range Complete Definition ~
@ -1571,10 +1571,10 @@ See |:verbose-cmd| for more information.
Command attributes ~ Command attributes ~
*command-attributes* *command-attributes*
User-defined commands are treated by Vim just like any other Ex commands. They User-defined commands are treated by Vim just like any other Ex commands.
can have arguments, or have a range specified. Arguments are subject to They can have arguments, or have a range specified. Arguments are subject to
completion as filenames, buffers, etc. Exactly how this works depends upon the completion as filenames, buffers, etc. Exactly how this works depends upon
command's attributes, which are specified when the command is defined. the command's attributes, which are specified when the command is defined.
When defining a user command in a script, it will be able to call functions When defining a user command in a script, it will be able to call functions
local to the script and use mappings local to the script. When the user local to the script and use mappings local to the script. When the user
@ -1659,7 +1659,7 @@ completion can be enabled:
-complete=scriptnames sourced script names -complete=scriptnames sourced script names
-complete=shellcmd Shell command -complete=shellcmd Shell command
-complete=shellcmdline First is a shell command and subsequent ones -complete=shellcmdline First is a shell command and subsequent ones
are filenames. The same behavior as |:!cmd| are filenames. The same behavior as |:!cmd|
-complete=sign |:sign| suboptions -complete=sign |:sign| suboptions
-complete=syntax syntax file names 'syntax' -complete=syntax syntax file names 'syntax'
-complete=syntime |:syntime| suboptions -complete=syntime |:syntime| suboptions
@ -1684,8 +1684,8 @@ function with the following signature: >
:function {func}(ArgLead, CmdLine, CursorPos) :function {func}(ArgLead, CmdLine, CursorPos)
The function need not use all these arguments. The function should provide the The function need not use all these arguments. The function should provide
completion candidates as the return value. the completion candidates as the return value.
For the "custom" argument, the function should return the completion For the "custom" argument, the function should return the completion
candidates one per line in a newline separated string. candidates one per line in a newline separated string.
@ -1701,7 +1701,7 @@ The function arguments are:
The function may use these for determining context. For the "custom" The function may use these for determining context. For the "custom"
argument, it is not necessary to filter candidates against the (implicit argument, it is not necessary to filter candidates against the (implicit
pattern in) ArgLead. Vim will filter the candidates with its regexp engine pattern in) ArgLead. Vim will filter the candidates with its regexp engine
after function return, and this is probably more efficient in most cases. If after function return, and this is probably more efficient in most cases. If
'wildoptions' contains "fuzzy", then the candidates will be filtered using 'wildoptions' contains "fuzzy", then the candidates will be filtered using
|fuzzy-matching|. For the "customlist" argument, Vim will not |fuzzy-matching|. For the "customlist" argument, Vim will not
filter the returned completion candidates and the user supplied function filter the returned completion candidates and the user supplied function
@ -1833,8 +1833,8 @@ The valid escape sequences are
command was executed with a ! modifier, otherwise command was executed with a ! modifier, otherwise
expands to nothing. expands to nothing.
*<mods>* *<q-mods>* *:command-modifiers* *<mods>* *<q-mods>* *:command-modifiers*
<mods> The command modifiers, if specified. Otherwise, expands to <mods> The command modifiers, if specified. Otherwise, expands to
nothing. Supported modifiers are |:aboveleft|, |:belowright|, nothing. Supported modifiers are |:aboveleft|, |:belowright|,
|:botright|, |:browse|, |:confirm|, |:hide|, |:horizontal|, |:botright|, |:browse|, |:confirm|, |:hide|, |:horizontal|,
|:keepalt|, |:keepjumps|, |:keepmarks|, |:keeppatterns|, |:keepalt|, |:keepjumps|, |:keepmarks|, |:keeppatterns|,
|:leftabove|, |:lockmarks|, |:noautocmd|, |:noswapfile|, |:leftabove|, |:lockmarks|, |:noautocmd|, |:noswapfile|,
@ -1943,9 +1943,9 @@ A more substantial example: >
:endfunction :endfunction
:command -nargs=+ -complete=command Allargs call Allargs(<q-args>) :command -nargs=+ -complete=command Allargs call Allargs(<q-args>)
The command Allargs takes any Vim command(s) as argument and executes it on all The command Allargs takes any Vim command(s) as argument and executes it on
files in the argument list. Usage example (note use of the "e" flag to ignore all files in the argument list. Usage example (note use of the "e" flag to
errors and the "update" command to write modified buffers): > ignore errors and the "update" command to write modified buffers): >
:Allargs %s/foo/bar/ge|update :Allargs %s/foo/bar/ge|update
This will invoke: > This will invoke: >
:call Allargs("%s/foo/bar/ge|update") :call Allargs("%s/foo/bar/ge|update")

12
runtime/doc/mbyte.txt
View File

@ -1,4 +1,4 @@
*mbyte.txt* For Vim version 9.1. Last change: 2025 Oct 04 *mbyte.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar et al. VIM REFERENCE MANUAL by Bram Moolenaar et al.
@ -1138,8 +1138,8 @@ it to the Vim maintainer for inclusion in the distribution:
HEBREW KEYMAP *keymap-hebrew* HEBREW KEYMAP *keymap-hebrew*
This file explains what characters are available in UTF-8 and CP1255 encodings, This file explains what characters are available in UTF-8 and CP1255
and what the keymaps are to get those characters: encodings, and what the keymaps are to get those characters:
glyph encoding keymap ~ glyph encoding keymap ~
Char UTF-8 cp1255 hebrew hebrewp name ~ Char UTF-8 cp1255 hebrew hebrewp name ~
@ -1270,9 +1270,9 @@ Combining forms:
============================================================================== ==============================================================================
10. Input with imactivatefunc() *mbyte-func* 10. Input with imactivatefunc() *mbyte-func*
Vim has the 'imactivatefunc' and 'imstatusfunc' options. These are useful to Vim has the 'imactivatefunc' and 'imstatusfunc' options. These are useful to
activate/deactivate the input method from Vim in any way, also with an external activate/deactivate the input method from Vim in any way, also with an
command. For example, fcitx provide fcitx-remote command: > external command. For example, fcitx provide fcitx-remote command: >
set iminsert=2 set iminsert=2
set imsearch=2 set imsearch=2

2
runtime/doc/message.txt
View File

@ -126,7 +126,7 @@ path leading to the file.
Cannot switch buffer. 'winfixbuf' is enabled ~ Cannot switch buffer. 'winfixbuf' is enabled ~
If a window has 'winfixbuf' enabled, you cannot change that window's current If a window has 'winfixbuf' enabled, you cannot change that window's current
buffer. You need to set 'nowinfixbuf' before continuing. You may use [!] to buffer. You need to set 'nowinfixbuf' before continuing. You may use [!] to
force the window to switch buffers, if your command supports it. force the window to switch buffers, if your command supports it.
*E72* *E72*

4
runtime/doc/mlang.txt
View File

@ -1,4 +1,4 @@
*mlang.txt* For Vim version 9.1. Last change: 2024 Jul 11 *mlang.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -81,7 +81,7 @@ use of "-" and "_".
This sets $LC_TIME. This sets $LC_TIME.
With the "collate" argument the language used for the With the "collate" argument the language used for the
collation order is set. This affects sorting of collation order is set. This affects sorting of
characters. This sets $LC_COLLATE. characters. This sets $LC_COLLATE.
Without an argument all are set, and additionally Without an argument all are set, and additionally
$LANG is set. $LANG is set.
If available the LC_NUMERIC value will always be set If available the LC_NUMERIC value will always be set

49
runtime/doc/motion.txt
View File

@ -1,4 +1,4 @@
*motion.txt* For Vim version 9.1. Last change: 2025 Aug 06 *motion.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -66,7 +66,7 @@ the two counts are multiplied. For example: "2d3w" deletes six words.
*operator-doubled* *operator-doubled*
When doubling the operator it operates on a line. When using a count, before When doubling the operator it operates on a line. When using a count, before
or after the first character, that many lines are operated upon. Thus `3dd` or after the first character, that many lines are operated upon. Thus `3dd`
deletes three lines. A count before and after the first character is deletes three lines. A count before and after the first character is
multiplied, thus `2y3y` yanks six lines. multiplied, thus `2y3y` yanks six lines.
*operator-resulting-pos* *operator-resulting-pos*
After applying the operator the cursor is mostly left at the start of the text After applying the operator the cursor is mostly left at the start of the text
@ -300,11 +300,11 @@ T{char} Till after [count]'th occurrence of {char} to the
{char} can be entered like with the |f| command. {char} can be entered like with the |f| command.
*;* *;*
; Repeat latest f, t, F or T [count] times. See |cpo-;| ; Repeat latest f, t, F or T [count] times. See |cpo-;|
*,* *,*
, Repeat latest f, t, F or T in opposite direction , Repeat latest f, t, F or T in opposite direction
[count] times. See also |cpo-;| [count] times. See also |cpo-;|
============================================================================== ==============================================================================
3. Up-down motions *up-down-motions* 3. Up-down motions *up-down-motions*
@ -625,11 +625,11 @@ ab "a block", select [count] blocks, from "[count] [(" to
i) *v_i)* *i)* *i(* i) *v_i)* *i)* *i(*
i( *vib* *v_ib* *v_i(* *ib* i( *vib* *v_ib* *v_i(* *ib*
ib "inner block", select [count] blocks, from "[count] [(" ib "inner block", select [count] blocks, from "[count]
to the matching ')', excluding the '(' and ')' (see [(" to the matching ')', excluding the '(' and ')'
|[(|). If the cursor is not inside a () block, then (see |[(|). If the cursor is not inside a () block,
find the next "(". It's an error to select an empty then find the next "(". It's an error to select an
inner block like "()". The |cpo-M| option flag empty inner block like "()". The |cpo-M| option flag
is used to handle escaped parenthesis. is used to handle escaped parenthesis.
When used in Visual mode it is made characterwise. When used in Visual mode it is made characterwise.
@ -673,11 +673,11 @@ aB "a Block", select [count] Blocks, from "[count] [{" to
i} *v_i}* *i}* *i{* i} *v_i}* *i}* *i{*
i{ *v_iB* *v_i{* *iB* i{ *v_iB* *v_i{* *iB*
iB "inner Block", select [count] Blocks, from "[count] [{" iB "inner Block", select [count] Blocks, from "[count]
to the matching '}', excluding the '{' and '}' (see [{" to the matching '}', excluding the '{' and '}'
|[{|). It's an error to select an empty inner block (see |[{|). It's an error to select an empty inner
like "{}". The |cpo-M| option flag is used to handle block like "{}". The |cpo-M| option flag is used to
escaped braces. handle escaped braces.
When used in Visual mode it is made characterwise. When used in Visual mode it is made characterwise.
a" *v_aquote* *aquote* a" *v_aquote* *aquote*
@ -876,9 +876,9 @@ buffer list. If you remove the file from the buffer list, all its marks are
lost. If you delete a line that contains a mark, that mark is erased. lost. If you delete a line that contains a mark, that mark is erased.
Lowercase marks can be used in combination with operators. For example: "d't" Lowercase marks can be used in combination with operators. For example: "d't"
deletes the lines from the cursor position to mark 't'. Hint: Use mark 't' for deletes the lines from the cursor position to mark 't'. Hint: Use mark 't'
Top, 'b' for Bottom, etc.. Lowercase marks are restored when using undo and for Top, 'b' for Bottom, etc.. Lowercase marks are restored when using undo
redo. and redo.
Uppercase marks 'A to 'Z include the file name. You can use them to jump from Uppercase marks 'A to 'Z include the file name. You can use them to jump from
file to file. You can only use an uppercase mark with an operator if the mark file to file. You can only use an uppercase mark with an operator if the mark
@ -1159,9 +1159,9 @@ stored in the viminfo file and restored when starting Vim.
*jumplist-stack* *jumplist-stack*
When 'jumpoptions' option includes "stack", the jumplist behaves like the tag When 'jumpoptions' option includes "stack", the jumplist behaves like the tag
stack. When jumping to a new location from the middle of the jumplist, the stack. When jumping to a new location from the middle of the jumplist, the
locations after the current position will be discarded. With this option set locations after the current position will be discarded. With this option set
you can move through a tree of jump locations. When going back up a branch and you can move through a tree of jump locations. When going back up a branch
then down another branch, CTRL-O still takes you further up the tree. and then down another branch, CTRL-O still takes you further up the tree.
Given a jumplist like the following in which CTRL-O has been used to move back Given a jumplist like the following in which CTRL-O has been used to move back
three times to location X: > three times to location X: >
@ -1263,7 +1263,7 @@ remembered.
*%* *%*
% Find the next item in this line after or under the % Find the next item in this line after or under the
cursor and jump to its match. |inclusive| motion. cursor and jump to its match. |inclusive| motion.
Items can be: Items can be:
([{}]) parenthesis or (curly/square) brackets ([{}]) parenthesis or (curly/square) brackets
(this can be changed with the (this can be changed with the
@ -1334,13 +1334,13 @@ bring you back to the switch statement.
similar structured language). When not after the similar structured language). When not after the
start of a method, jump to the start or end of the start of a method, jump to the start or end of the
class. When no '{' is found before the cursor this is class. When no '{' is found before the cursor this is
an error. |exclusive| motion. an error. |exclusive| motion.
*[M* *[M*
[M Go to [count] previous end of a method (for Java or [M Go to [count] previous end of a method (for Java or
similar structured language). When not after the similar structured language). When not after the
end of a method, jump to the start or end of the end of a method, jump to the start or end of the
class. When no '}' is found before the cursor this is class. When no '}' is found before the cursor this is
an error. |exclusive| motion. an error. |exclusive| motion.
The above four commands assume that the file contains a class with methods. The above four commands assume that the file contains a class with methods.
The class definition is surrounded in '{' and '}'. Each method in the class The class definition is surrounded in '{' and '}'. Each method in the class
@ -1375,7 +1375,8 @@ Using "3[m" will jump to the start of the class.
These two commands work in C programs that contain #if/#else/#endif These two commands work in C programs that contain #if/#else/#endif
constructs. It brings you to the start or end of the #if/#else/#endif where constructs. It brings you to the start or end of the #if/#else/#endif where
the current line is included. You can then use "%" to go to the matching line. the current line is included. You can then use "%" to go to the matching
line.
*[star* *[/* *[star* *[/*
[* or [/ Go to [count] previous start of a C comment "/*". [* or [/ Go to [count] previous start of a C comment "/*".

38
runtime/doc/netbeans.txt
View File

@ -35,10 +35,10 @@ longer exists for recent versions of NetBeans but the protocol was developed
in such a way that any IDE can use it to integrate Vim. in such a way that any IDE can use it to integrate Vim.
The NetBeans protocol of Vim is a text based communication protocol, over a The NetBeans protocol of Vim is a text based communication protocol, over a
classical TCP socket. There is no dependency on Java or NetBeans. Any language classical TCP socket. There is no dependency on Java or NetBeans. Any
or environment providing a socket interface can control Vim using this language or environment providing a socket interface can control Vim using
protocol. There are existing implementations in C, C++, Python and Java. The this protocol. There are existing implementations in C, C++, Python and Java.
name NetBeans is kept today for historical reasons. The name NetBeans is kept today for historical reasons.
Active project using the NetBeans protocol of Vim: Active project using the NetBeans protocol of Vim:
- Eclim, (dead link) eclim.org/ - Eclim, (dead link) eclim.org/
@ -252,7 +252,7 @@ environment variable "__NETBEANS_SOCKET" is used or the default 3219.
environment variable "__NETBEANS_VIM_PASSWORD" is used or "changeme". environment variable "__NETBEANS_VIM_PASSWORD" is used or "changeme".
Vim will initiate a socket connection (client side) to the specified host and Vim will initiate a socket connection (client side) to the specified host and
port upon startup. The password will be sent with the AUTH event when the port upon startup. The password will be sent with the AUTH event when the
connection has been established. connection has been established.
@ -262,7 +262,7 @@ connection has been established.
The communication between the Vim Controller and Vim uses plain text The communication between the Vim Controller and Vim uses plain text
messages. This protocol was first designed to work with the external editor messages. This protocol was first designed to work with the external editor
module of NetBeans. Later it was extended to work with Agide (A-A-P GUI IDE, module of NetBeans. Later it was extended to work with Agide (A-A-P GUI IDE,
see http://www.a-a-p.org) and then with other IDE. The extensions are marked see http://www.a-a-p.org) and then with other IDE. The extensions are marked
with "version 2.1". with "version 2.1".
Version 2.2 of the protocol has several minor changes which should only affect Version 2.2 of the protocol has several minor changes which should only affect
@ -285,7 +285,7 @@ mechanism.
Netbeans messages are processed when Vim is idle, waiting for user input. Netbeans messages are processed when Vim is idle, waiting for user input.
When Vim is run in non-interactive mode, for example when running an automated When Vim is run in non-interactive mode, for example when running an automated
test case that sources a Vim script, the idle loop may not be called often test case that sources a Vim script, the idle loop may not be called often
enough. In that case, insert |:sleep| commands in the Vim script. The |:sleep| enough. In that case, insert |:sleep| commands in the Vim script. The |:sleep|
command does invoke Netbeans messages processing. command does invoke Netbeans messages processing.
6.1 Kinds of messages |nb-messages| 6.1 Kinds of messages |nb-messages|
@ -442,7 +442,7 @@ editFile pathname
Normal way for the IDE to tell the editor to edit a file. Normal way for the IDE to tell the editor to edit a file.
You must set a bufId different of 0 with this command to You must set a bufId different of 0 with this command to
assign a bufId to the buffer. It will trigger an event assign a bufId to the buffer. It will trigger an event
fileOpened with a bufId of 0 but the buffer has been assigned. fileOpened with a bufId of 0 but the buffer has been assigned.
If the IDE is going to pass the file text to the editor use If the IDE is going to pass the file text to the editor use
@ -470,8 +470,8 @@ initDone Mark the buffer as ready for use. Implicitly makes the buffer
insertDone starteol readonly insertDone starteol readonly
Sent by Vim Controller to tell Vim an initial file insert is Sent by Vim Controller to tell Vim an initial file insert is
done. This triggers a read message being printed. If done. This triggers a read message being printed. If
"starteol" is "F" then the last line doesn't have a EOL. If "starteol" is "F" then the last line doesn't have a EOL. If
"readonly" is "T" then the file is marked as readonly. Prior "readonly" is "T" then the file is marked as readonly. Prior
to version 2.3, no read messages were displayed after opening to version 2.3, no read messages were displayed after opening
a file. New in version 2.3. a file. New in version 2.3.
@ -862,7 +862,7 @@ These errors occur when a message violates the protocol:
':echo has("netbeans_enabled")' ':echo has("netbeans_enabled")'
*:nbclose* *:nbclose*
:nbc[lose] Close the current NetBeans session. Remove all placed :nbc[lose] Close the current NetBeans session. Remove all placed
signs. signs.
*:nbkey* *:nbkey*
@ -871,7 +871,7 @@ These errors occur when a message violates the protocol:
command, this command can be used to generate a hotkey command, this command can be used to generate a hotkey
message to the Vim Controller. message to the Vim Controller.
This command can also be used to pass any text to the This command can also be used to pass any text to the
Vim Controller. It is used by Pyclewn, for example, Vim Controller. It is used by Pyclewn, for example,
to build the complete set of gdb commands as Vim user to build the complete set of gdb commands as Vim user
commands. commands.
The events newDotAndMark, keyCommand and keyAtPos are The events newDotAndMark, keyCommand and keyAtPos are
@ -885,7 +885,7 @@ NUL bytes are not possible. For editor -> IDE they will appear as NL
characters. For IDE -> editor they cannot be inserted. characters. For IDE -> editor they cannot be inserted.
A NetBeans session may be initiated with Vim running in a terminal, and A NetBeans session may be initiated with Vim running in a terminal, and
continued later in a GUI environment after running the |:gui| command. In this continued later in a GUI environment after running the |:gui| command. In this
case, the highlighting defined for the NetBeans annotations may be cleared case, the highlighting defined for the NetBeans annotations may be cleared
when the ":gui" command sources .gvimrc and this file loads a colorscheme when the ":gui" command sources .gvimrc and this file loads a colorscheme
that runs the command ":highlight clear". that runs the command ":highlight clear".
@ -935,14 +935,14 @@ version of NetBeans.
10.1. Downloading NetBeans *netbeans-download* 10.1. Downloading NetBeans *netbeans-download*
The NetBeans IDE is available for download from netbeans.org. You can download The NetBeans IDE is available for download from netbeans.org. You can
a released version, download sources, or use CVS to download the current download a released version, download sources, or use CVS to download the
source tree. If you choose to download sources, follow directions from current source tree. If you choose to download sources, follow directions
netbeans.org on building NetBeans. from netbeans.org on building NetBeans.
Depending on the version of NetBeans you download, you may need to do further Depending on the version of NetBeans you download, you may need to do further
work to get the required External Editor module. This is the module which lets work to get the required External Editor module. This is the module which
NetBeans work with gvim (or xemacs :-). See (dead link) lets NetBeans work with gvim (or xemacs :-). See (dead link)
externaleditor.netbeans.org externaleditor.netbeans.org
for details on downloading this module if your NetBeans release does not have for details on downloading this module if your NetBeans release does not have
it. it.

60
runtime/doc/options.txt
View File

@ -1,4 +1,4 @@
*options.txt* For Vim version 9.1. Last change: 2025 Oct 07 *options.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -32,8 +32,8 @@ achieve special effects. These options come in three forms:
:se[t] termcap Show all terminal options. Note that in the GUI the :se[t] termcap Show all terminal options. Note that in the GUI the
key codes are not shown, because they are generated key codes are not shown, because they are generated
internally and can't be changed. Changing the terminal internally and can't be changed. Changing the
codes in the GUI is not useful either... terminal codes in the GUI is not useful either...
The options have the form t_AB, see The options have the form t_AB, see
|terminal-options|. |terminal-options|.
@ -1493,8 +1493,8 @@ A jump table for the options with a short description can be found at |Q_op|.
{not available when compiled without the |+linebreak| {not available when compiled without the |+linebreak|
feature} feature}
Every wrapped line will continue visually indented (same amount of Every wrapped line will continue visually indented (same amount of
space as the beginning of that line), thus preserving horizontal blocks space as the beginning of that line), thus preserving horizontal
of text. blocks of text.
NOTE: This option is reset when 'compatible' is set. NOTE: This option is reset when 'compatible' is set.
*'breakindentopt'* *'briopt'* *'breakindentopt'* *'briopt'*
@ -1839,13 +1839,14 @@ A jump table for the options with a short description can be found at |Q_op|.
register '*' for all yank, delete, change and put register '*' for all yank, delete, change and put
operations which would normally go to the unnamed operations which would normally go to the unnamed
register. When "unnamed" is also included to the register. When "unnamed" is also included to the
option, yank operations (but not delete, change or put) option, yank operations (but not delete, change or
will additionally copy the text into register '*'. If put) will additionally copy the text into register
Wayland is being used and the compositor does not '*'. If Wayland is being used and the compositor does
support the primary-selection-unstable-v1 protocol, not support the primary-selection-unstable-v1
then the regular selection is used in its place. Only protocol, then the regular selection is used in its
available with the |+X11| or |+wayland_clipboard| place. Only available with the |+X11| or
feature. Availability can be checked with: > |+wayland_clipboard| feature. Availability can be
checked with: >
if has('unnamedplus') if has('unnamedplus')
< <
*clipboard-autoselect* *clipboard-autoselect*
@ -2147,12 +2148,12 @@ A jump table for the options with a short description can be found at |Q_op|.
|i_CTRL-X_CTRL-D| |i_CTRL-X_CTRL-D|
] tag completion ] tag completion
t same as "]" t same as "]"
F{func} call the function {func}. Multiple "F" flags may be specified. F{func} call the function {func}. Multiple "F" flags may be
Refer to |complete-functions| for details on how the function specified. Refer to |complete-functions| for details on how
is invoked and what it should return. The value can be the the function is invoked and what it should return. The value
name of a function or a |Funcref|. For |Funcref| values, can be the name of a function or a |Funcref|. For |Funcref|
spaces must be escaped with a backslash ('\'), and commas with values, spaces must be escaped with a backslash ('\'), and
double backslashes ('\\') (see |option-backslash|). commas with double backslashes ('\\') (see |option-backslash|).
Unlike other sources, functions can provide completions Unlike other sources, functions can provide completions
starting from a non-keyword character before the cursor, and starting from a non-keyword character before the cursor, and
their start position for replacing text may differ from other their start position for replacing text may differ from other
@ -2354,7 +2355,8 @@ A jump table for the options with a short description can be found at |Q_op|.
completion in insert mode. This is useful when editing HTML tag, or completion in insert mode. This is useful when editing HTML tag, or
Makefile with 'noshellslash' on MS-Windows. Makefile with 'noshellslash' on MS-Windows.
- When this option is set to "backslash", backslash is used. This is - When this option is set to "backslash", backslash is used. This is
useful when editing a batch file with 'shellslash' set on MS-Windows. useful when editing a batch file with 'shellslash' set on
MS-Windows.
- When this option is empty, same character is used as for - When this option is empty, same character is used as for
'shellslash'. 'shellslash'.
For Insert mode completion the buffer-local value is used. For For Insert mode completion the buffer-local value is used. For
@ -5575,8 +5577,8 @@ A jump table for the options with a short description can be found at |Q_op|.
global global
{only available when compiled with the |+langmap| {only available when compiled with the |+langmap|
feature} feature}
When off, setting 'langmap' does not apply to characters resulting from When off, setting 'langmap' does not apply to characters resulting
a mapping. This basically means, if you noticed that setting from a mapping. This basically means, if you noticed that setting
'langmap' disables some of your mappings, try resetting this option. 'langmap' disables some of your mappings, try resetting this option.
This option defaults to on for backwards compatibility. Set it off if This option defaults to on for backwards compatibility. Set it off if
that works for you to avoid mappings to break. that works for you to avoid mappings to break.
@ -5599,8 +5601,8 @@ A jump table for the options with a short description can be found at |Q_op|.
executing macros, registers and other commands that have not been executing macros, registers and other commands that have not been
typed. Also, updating the window title is postponed. To force an typed. Also, updating the window title is postponed. To force an
update use |:redraw|. update use |:redraw|.
This may occasionally cause display errors. It is only meant to be set This may occasionally cause display errors. It is only meant to be
temporarily when performing an operation where redrawing may cause set temporarily when performing an operation where redrawing may cause
flickering or cause a slowdown. flickering or cause a slowdown.
*'lhistory'* *'lhi'* *'lhistory'* *'lhi'*
@ -6517,10 +6519,10 @@ A jump table for the options with a short description can be found at |Q_op|.
some text from one window and paste it in Vim. This will avoid some text from one window and paste it in Vim. This will avoid
unexpected effects. unexpected effects.
Setting this option is useful when using Vim in a terminal, where Vim Setting this option is useful when using Vim in a terminal, where Vim
cannot distinguish between typed text and pasted text. In the GUI, Vim cannot distinguish between typed text and pasted text. In the GUI,
knows about pasting and will mostly do the right thing without 'paste' Vim knows about pasting and will mostly do the right thing without
being set. The same is true for a terminal where Vim handles the 'paste' being set. The same is true for a terminal where Vim handles
mouse clicks itself. the mouse clicks itself.
This option is reset when starting the GUI. Thus if you set it in This option is reset when starting the GUI. Thus if you set it in
your .vimrc it will work in a terminal, but not in the GUI. Setting your .vimrc it will work in a terminal, but not in the GUI. Setting
'paste' in the GUI has side effects: e.g., the Paste toolbar button 'paste' in the GUI has side effects: e.g., the Paste toolbar button
@ -6566,8 +6568,8 @@ A jump table for the options with a short description can be found at |Q_op|.
'pastetoggle' works in Insert mode and Normal mode, but not in 'pastetoggle' works in Insert mode and Normal mode, but not in
Command-line mode. Command-line mode.
Mappings are checked first, thus overrule 'pastetoggle'. However, Mappings are checked first, thus overrule 'pastetoggle'. However,
when 'paste' is on mappings are ignored in Insert mode, thus you can do when 'paste' is on mappings are ignored in Insert mode, thus you can
this: > do this: >
:map <F10> :set paste<CR> :map <F10> :set paste<CR>
:map <F11> :set nopaste<CR> :map <F11> :set nopaste<CR>
:imap <F10> <C-O>:set paste<CR> :imap <F10> <C-O>:set paste<CR>

6
runtime/doc/os_amiga.txt
View File

@ -1,4 +1,4 @@
*os_amiga.txt* For Vim version 9.1. Last change: 2025 Aug 10 *os_amiga.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -74,8 +74,8 @@ example to get white text on a blue background: >
When using multiple commands with a filter command, e.g. > When using multiple commands with a filter command, e.g. >
:r! echo this; echo that :r! echo this; echo that
Only the output of the last command is used. To fix this you have to group the Only the output of the last command is used. To fix this you have to group
commands. This depends on the shell you use (that is why it is not done the commands. This depends on the shell you use (that is why it is not done
automatically in Vim). Examples: > automatically in Vim). Examples: >
:r! (echo this; echo that) :r! (echo this; echo that)
:r! {echo this; echo that} :r! {echo this; echo that}

22
runtime/doc/os_haiku.txt
View File

@ -1,4 +1,4 @@
*os_haiku.txt* For Vim version 9.1. Last change: 2025 Sep 08 *os_haiku.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -40,7 +40,7 @@ instance (r,g,b)=(168,168,168)) with black letters also works nicely.
2. Compiling Vim *haiku-compiling* 2. Compiling Vim *haiku-compiling*
Vim can be compiled using the standard configure/make approach. Running Vim can be compiled using the standard configure/make approach. Running
./configure without any arguments or passing --enable-gui=haiku, will compile ./configure without any arguments or passing --enable-gui=haiku, will compile
vim with the Haiku GUI support. Run ./configure --help , to find out other vim with the Haiku GUI support. Run ./configure --help , to find out other
features you can enable/disable. features you can enable/disable.
@ -73,8 +73,8 @@ additionally installed over the GUI version. Typical build commands are:
Normally Vim starts with the GUI if you start it as gvim or vim -g. The vim Normally Vim starts with the GUI if you start it as gvim or vim -g. The vim
version with GUI tries to determine if it was started from the Tracker instead version with GUI tries to determine if it was started from the Tracker instead
of the Terminal, and if so, uses the GUI anyway. However, the current detection of the Terminal, and if so, uses the GUI anyway. However, the current
scheme is fooled if you use the command "vim - </dev/null". detection scheme is fooled if you use the command "vim - </dev/null".
Toggling between normal managed window and fullscreen mode can be done by Toggling between normal managed window and fullscreen mode can be done by
pressing <Alt-Enter>. pressing <Alt-Enter>.
@ -90,7 +90,7 @@ Stuff that does not work yet:
follows-mouse turned on). follows-mouse turned on).
- The cursor does not flash. - The cursor does not flash.
- Switching windows using <C-Tab-Up> and <C-Tab-Down> in Twitcher does not - Switching windows using <C-Tab-Up> and <C-Tab-Down> in Twitcher does not
work. This is due to each gvim window being managed by a separate instance work. This is due to each gvim window being managed by a separate instance
completely unaware of other vim processes. completely unaware of other vim processes.
4. The $VIM directory *haiku-vimdir* 4. The $VIM directory *haiku-vimdir*
@ -141,7 +141,7 @@ open the files instead. This works from the Tracker but also from the command
line. In the latter case, non-file (option) arguments are not supported. line. In the latter case, non-file (option) arguments are not supported.
Another drawback of the Single Launch is silent ignore of "Open With ..." Another drawback of the Single Launch is silent ignore of "Open With ..."
requests by vim instance that running as non-GUI application even GUI support requests by vim instance that running as non-GUI application even GUI support
was compiled in. Vim instance running with GUI has no such problems. was compiled in. Vim instance running with GUI has no such problems.
NB: Only the GUI version has a BApplication (and hence Application Flags). NB: Only the GUI version has a BApplication (and hence Application Flags).
This section does not apply to the GUI-less version, should you compile one. This section does not apply to the GUI-less version, should you compile one.
@ -201,14 +201,14 @@ $VIM/macros/swapmous.vim for an example. |gui-mouse-mapping|
11. Color names *haiku-colors* 11. Color names *haiku-colors*
Vim has a number of color names built-in. Additional names can be defined in Vim has a number of color names built-in. Additional names can be defined in
|v:colornames|. See |:colorscheme| for details. |v:colornames|. See |:colorscheme| for details.
12. GUI Toolbar Images *haiku-toolbar-images* 12. GUI Toolbar Images *haiku-toolbar-images*
Alternative set of toolbar images should be the PNG image of any height you Alternative set of toolbar images should be the PNG image of any height you
like. Image width is calculated to contain at least 32 buttons in one-row like. Image width is calculated to contain at least 32 buttons in one-row
cells. cells.
The image should be stored under the name $VIRUNTIME/bitmaps/builtin-tools.png The image should be stored under the name $VIRUNTIME/bitmaps/builtin-tools.png
More info about the buttons assignment are at |builtin-tools|. More info about the buttons assignment are at |builtin-tools|.
@ -229,8 +229,8 @@ Thank you, all!
14. Bugs & to-do *haiku-bugs* 14. Bugs & to-do *haiku-bugs*
The port is under development now and far away from the perfect state. For bug The port is under development now and far away from the perfect state. For
reports, patches and wishes, please use the Vim mailing list or Vim Github bug reports, patches and wishes, please use the Vim mailing list or Vim Github
repository. repository.
Mailing list: https://www.vim.org/maillist.php Mailing list: https://www.vim.org/maillist.php

4
runtime/doc/os_mac.txt
View File

@ -1,4 +1,4 @@
*os_mac.txt* For Vim version 9.1. Last change: 2025 Aug 10 *os_mac.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar et al. VIM REFERENCE MANUAL by Bram Moolenaar et al.
@ -36,7 +36,7 @@ Indianapolis IN 46220 USA
1. Filename Convention *mac-filename* 1. Filename Convention *mac-filename*
Starting with Vim version 7 you can just use the unix path separators with Starting with Vim version 7 you can just use the unix path separators with
Vim. In order to determine if the specified filename is relative to the Vim. In order to determine if the specified filename is relative to the
current folder or absolute (i.e. relative to the "Desktop"), the following current folder or absolute (i.e. relative to the "Desktop"), the following
algorithm is used: algorithm is used:

4
runtime/doc/os_mint.txt
View File

@ -1,11 +1,11 @@
*os_mint.txt* For Vim version 9.1. Last change: 2020 Jul 14 *os_mint.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Jens M. Felderhoff VIM REFERENCE MANUAL by Jens M. Felderhoff
*MiNT* *Atari* *MiNT* *Atari*
The Atari MiNT support was removed with patch 8.2.1215. It probably didn't The Atari MiNT support was removed with patch 8.2.1215. It probably didn't
work at that time, since the code was old and not maintained. work at that time, since the code was old and not maintained.

6
runtime/doc/os_qnx.txt
View File

@ -1,4 +1,4 @@
*os_qnx.txt* For Vim version 9.1. Last change: 2025 Aug 06 *os_qnx.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Julian Kinraid VIM REFERENCE MANUAL by Julian Kinraid
@ -22,8 +22,8 @@ Vim on QNX behaves much like other unix versions. |os_unix.txt|
2. Compiling Vim *qnx-compiling* 2. Compiling Vim *qnx-compiling*
Vim can be compiled using the standard configure/make approach. If you want to Vim can be compiled using the standard configure/make approach. If you want
compile for X11, pass the --with-x option to configure. Otherwise, running to compile for X11, pass the --with-x option to configure. Otherwise, running
./configure without any arguments or passing --enable-gui=photon, will compile ./configure without any arguments or passing --enable-gui=photon, will compile
vim with the Photon gui support. Run ./configure --help , to find out other vim with the Photon gui support. Run ./configure --help , to find out other
features you can enable/disable. features you can enable/disable.

60
runtime/doc/os_vms.txt
View File

@ -1,4 +1,4 @@
*os_vms.txt* For Vim version 9.1. Last change: 2025 Aug 06 *os_vms.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL VIM REFERENCE MANUAL
@ -80,9 +80,9 @@ See the file [.SRC]INSTALLVMS.TXT.
4. Problems *vms-problems* 4. Problems *vms-problems*
The code has been tested under Open VMS 6.2 - 9.2 on Alpha, VAX, IA64 and The code has been tested under Open VMS 6.2 - 9.2 on Alpha, VAX, IA64 and
X86_64 platforms with the DEC C compiler. It should work without major problems. X86_64 platforms with the DEC C compiler. It should work without major
If your system does not have some include libraries you can tune in the problems. If your system does not have some include libraries you can tune in
OS_VMS_CONF.H file. the OS_VMS_CONF.H file.
If you decided to build Vim with +perl, +python, etc. options, first you need If you decided to build Vim with +perl, +python, etc. options, first you need
to download OpenVMS distributions of Perl and Python. Build and deploy the to download OpenVMS distributions of Perl and Python. Build and deploy the
@ -96,7 +96,8 @@ VAX C compiler is not fully ANSI C compatible in pre-processor directives
semantics, therefore you have to use a converter program that will do the lion semantics, therefore you have to use a converter program that will do the lion
part of the job. For detailed instructions read file INSTALLvms.txt part of the job. For detailed instructions read file INSTALLvms.txt
To build XXD.EXE, you should change to the subdirectory and build it separately. To build XXD.EXE, you should change to the subdirectory and build it
separately.
CTAGS is not part of the Vim source distribution anymore, however the OpenVMS CTAGS is not part of the Vim source distribution anymore, however the OpenVMS
specific source might contain CTAGS source files as described above. specific source might contain CTAGS source files as described above.
@ -216,8 +217,8 @@ Example LOGIN.COM: >
$ set term/inq/ins ! inquire the terminal capabilities $ set term/inq/ins ! inquire the terminal capabilities
$ set disp/create/node=192.168.10.202/trans=tcpip $ set disp/create/node=192.168.10.202/trans=tcpip
Note: This set-up should be enough, if you are working on a standalone server or Note: This set-up should be enough, if you are working on a standalone server
clustered environment, but if you want to use Vim as an internode editor in or clustered environment, but if you want to use Vim as an internode editor in
DECNET environment, it will satisfy as well. DECNET environment, it will satisfy as well.
You just have to define the "whole" path: > You just have to define the "whole" path: >
@ -291,8 +292,8 @@ can be downloaded from http://www.polarhome.com/vim/).
$ set disp/create/node=<your IP address>/trans=<transport-name> $ set disp/create/node=<your IP address>/trans=<transport-name>
< <
and start Vim as in point 1. You can find more help in VMS documentation or and start Vim as in point 1. You can find more help in VMS documentation
type: help set disp in VMS prompt. or type: help set disp in VMS prompt.
Examples: > Examples: >
$ set disp/create/node=192.168.5.159 ! default trans is DECnet $ set disp/create/node=192.168.5.159 ! default trans is DECnet
@ -456,7 +457,8 @@ Try to force to inquire the terminal capabilities with: >
$ set term/inquire $ set term/inquire
If the inquire did not help, the solutions is to define the default terminal name: > If the inquire did not help, the solutions is to define the default terminal
name: >
$ ! unknown terminal name. Let us use vt320 or ansi instead. $ ! unknown terminal name. Let us use vt320 or ansi instead.
$ ! Note: it's case sensitive $ ! Note: it's case sensitive
@ -487,9 +489,9 @@ special commands to execute executables: >
OpenVMS users always have to be aware that the Vim command :! "just" drop them OpenVMS users always have to be aware that the Vim command :! "just" drop them
to DCL prompt. This feature is possible to use without any problem with all to DCL prompt. This feature is possible to use without any problem with all
DCL commands, but if we want to execute some programs such as XXD, CTAGS, JTAGS, DCL commands, but if we want to execute some programs such as XXD, CTAGS,
etc. we're running into trouble if we follow the Vim documentation (see: help JTAGS, etc. we're running into trouble if we follow the Vim documentation
xxd). (see: help xxd).
Solution: Execute with the MC command and add the full path to the executable. Solution: Execute with the MC command and add the full path to the executable.
Example: Instead of :%!xxd command use: > Example: Instead of :%!xxd command use: >
@ -707,7 +709,7 @@ console mode can avoid performance problems.
In a cluster that contains nodes with different architectures like below: In a cluster that contains nodes with different architectures like below:
$show cluster $show cluster
View of Cluster from system ID 11655 node: TOR 18-AUG-2008 11:58:31 View of Cluster from system ID 11655 node: TOR 18-AUG-2008 11:58:31
+---------------------------------+ +---------------------------------+
| SYSTEMS | MEMBERS | | SYSTEMS | MEMBERS |
+-----------------------+---------| +-----------------------+---------|
@ -773,17 +775,20 @@ GNU_TOOLS.ZIP package downloadable from http://www.polarhome.com/vim/
Version 9.0 (2023 Nov 27) Version 9.0 (2023 Nov 27)
- Vim is ported to the X86_64 architecture - Vim is ported to the X86_64 architecture
- IMPORTANT: because of the getline function name used in structs like in ex_cmds.h - IMPORTANT: because of the getline function name used in structs like
on X86_64 the CRTL_VER is kept under 80500000 level. The proper solution would be in ex_cmds.h on X86_64 the CRTL_VER is kept under 80500000 level. The
to rename the getline function to something else in the struct (and in all places proper solution would be to rename the getline function to something
it is used) - and avoiding to use POSIX functions in structs, but this change would else in the struct (and in all places it is used) - and avoiding to
impact on all other operating systems. (added to the VMS TODO list) use POSIX functions in structs, but this change would impact on all
Read more about at https://forum.vmssoftware.com/viewtopic.php?f=38&t=8914&p=20049 other operating systems. (added to the VMS TODO list)
Read more about at:
https://forum.vmssoftware.com/viewtopic.php?f=38&t=8914&p=20049
- os_vms_conf.h includes have been reviewed for all architectures - os_vms_conf.h includes have been reviewed for all architectures
- added support for the MODIFIED_BY define - added support for the MODIFIED_BY define
Version 8.2 (2020 Feb 6) Version 8.2 (2020 Feb 6)
- make all changes needed for clean compile build of v8.2 on VMS on all platforms - make all changes needed for clean compile build of v8.2 on VMS on all
platforms
- fix the call mkdir bug (vicente_polo@yahoo.es) - fix the call mkdir bug (vicente_polo@yahoo.es)
- test on VSI OpenVMS Alpha and Itanium platforms - test on VSI OpenVMS Alpha and Itanium platforms
- added LUA support - added LUA support
@ -797,21 +802,23 @@ Version 8.1 (2019 Jan 9)
Version 8.0 (2016 Nov 21) Version 8.0 (2016 Nov 21)
- solve the 100% cpu usage issue while waiting for a keystroke - solve the 100% cpu usage issue while waiting for a keystroke
- correct the VMS warnings and errors around handling the INFINITY (used in json.c) - correct the VMS warnings and errors around handling the INFINITY (used in
json.c)
- minor VMS port related changes - minor VMS port related changes
- correct the make_vms.mms file for 8.0 - correct the make_vms.mms file for 8.0
- fix [.TESTDIR]make_vms.mms for 8.0 - fix [.TESTDIR]make_vms.mms for 8.0
Version 7.4 (2013 Aug 10) Version 7.4 (2013 Aug 10)
- Undo: VMS can not handle more than one dot in the filenames use "dir/name" -> "dir/_un_name" - Undo: VMS can not handle more than one dot in the filenames use
"dir/name" -> "dir/_un_name"
add _un_ at the beginning to keep the extension add _un_ at the beginning to keep the extension
- correct swap file name wildcard handling - correct swap file name wildcard handling
- handle iconv usage correctly - handle iconv usage correctly
- do not optimize on vax - otherwise it hangs compiling crypto files - do not optimize on vax - otherwise it hangs compiling crypto files
- fileio.c fix the comment - fileio.c fix the comment
- correct RealWaitForChar - correct RealWaitForChar
- after 7.4-119 use different functions lib$cvtf_to_internal_time because Alpha and VAX have - after 7.4-119 use different functions lib$cvtf_to_internal_time because
G_FLOAT but IA64 uses IEEE float otherwise Vim crashes Alpha and VAX have G_FLOAT but IA64 uses IEEE float otherwise Vim crashes
- guard against crashes that are caused by mixed filenames - guard against crashes that are caused by mixed filenames
- [TESTDIR]make_vms.mms changed to see the output files - [TESTDIR]make_vms.mms changed to see the output files
- Improve tests, update known issues - Improve tests, update known issues
@ -820,7 +827,8 @@ Version 7.4 (2013 Aug 10)
Version 7.3 (2010 Aug 15) Version 7.3 (2010 Aug 15)
- CTAGS 5.8 included - CTAGS 5.8 included
- VMS compile warnings fixed - floating-point overflow warning corrected on VAX - VMS compile warnings fixed - floating-point overflow warning corrected on
VAX
- filepath completion corrected - too many chars were escaped in filename - filepath completion corrected - too many chars were escaped in filename
and shell commands and shell commands
- the following plugins are included into VMS runtime: - the following plugins are included into VMS runtime:

12
runtime/doc/os_win32.txt
View File

@ -1,4 +1,4 @@
*os_win32.txt* For Vim version 9.1. Last change: 2025 Oct 01 *os_win32.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by George Reilly VIM REFERENCE MANUAL by George Reilly
@ -153,7 +153,7 @@ Alternatively use three quotes to get one: >
The quotation rules are: The quotation rules are:
1. A `"` starts quotation. 1. A `"` starts quotation.
2. Another `"` or `""` ends quotation. If the quotation ends with `""`, a `"` 2. Another `"` or `""` ends quotation. If the quotation ends with `""`, a `"`
is produced at the end of the quoted string. is produced at the end of the quoted string.
Examples, with [] around an argument: Examples, with [] around an argument:
@ -295,7 +295,7 @@ A. You can't! This is a limitation of the NT console. NT 5.0 is reported to
*:!start* *:!start*
Q. How can I asynchronously run an external command or program, or open a Q. How can I asynchronously run an external command or program, or open a
document or URL with its default program? document or URL with its default program?
A. When using :! to run an external command, you can run it with "start". For A. When using :! to run an external command, you can run it with "start". For
example, to run notepad: > example, to run notepad: >
:!start notepad :!start notepad
< To open "image.jpg" with the default image viewer: > < To open "image.jpg" with the default image viewer: >
@ -320,14 +320,14 @@ A. When using :! to run an external command, you can run it with "start". For
Q. How do I avoid getting a window for programs that I run asynchronously? Q. How do I avoid getting a window for programs that I run asynchronously?
A. You have three possible solutions depending on what you want: A. You have three possible solutions depending on what you want:
1) You may use the /min flag in order to run program in a minimized state 1) You may use the /min flag in order to run program in a minimized state
with no other changes. It will work equally for console and GUI with no other changes. It will work equally for console and GUI
applications. applications.
2) You can use the /b flag to run console applications without creating a 2) You can use the /b flag to run console applications without creating a
console window for them (GUI applications are not affected). But you console window for them (GUI applications are not affected). But you
should use this flag only if the application you run doesn't require any should use this flag only if the application you run doesn't require any
input. Otherwise it will get an EOF error because its input stream input. Otherwise it will get an EOF error because its input stream
(stdin) would be redirected to \\.\NUL (stdout and stderr too). (stdin) would be redirected to \\.\NUL (stdout and stderr too).
3) Set the '!' flag in the 'guioptions' option |'go-!'|. This will make Vim 3) Set the '!' flag in the 'guioptions' option |'go-!'|. This will make Vim
run the "start" command inside Vims terminal window and not open a run the "start" command inside Vims terminal window and not open a
console window. console window.

19
runtime/doc/pattern.txt
View File

@ -1,4 +1,4 @@
*pattern.txt* For Vim version 9.1. Last change: 2025 Oct 09 *pattern.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -288,9 +288,9 @@ When searching backwards, searching starts at the start of the line, using the
cursor position is used. cursor position is used.
In Vi the ":tag" command sets the last search pattern when the tag is searched In Vi the ":tag" command sets the last search pattern when the tag is searched
for. In Vim this is not done, the previous search pattern is still remembered, for. In Vim this is not done, the previous search pattern is still
unless the 't' flag is present in 'cpoptions'. The search pattern is always remembered, unless the 't' flag is present in 'cpoptions'. The search pattern
put in the search history. is always put in the search history.
If the 'wrapscan' option is on (which is the default), searches wrap around If the 'wrapscan' option is on (which is the default), searches wrap around
the end of the buffer. If 'wrapscan' is not set, the backward search stops the end of the buffer. If 'wrapscan' is not set, the backward search stops
@ -1151,11 +1151,12 @@ x A single character, with no special meaning, matches itself
in the collection: "[^xyz]" matches anything but 'x', 'y' and 'z'. in the collection: "[^xyz]" matches anything but 'x', 'y' and 'z'.
- If two characters in the sequence are separated by '-', this is - If two characters in the sequence are separated by '-', this is
shorthand for the full list of ASCII characters between them. E.g., shorthand for the full list of ASCII characters between them. E.g.,
"[0-9]" matches any decimal digit. If the starting character exceeds "[0-9]" matches any decimal digit. If the starting character
the ending character, e.g. [c-a], E944 occurs. Non-ASCII characters exceeds the ending character, e.g. [c-a], E944 occurs. Non-ASCII
can be used, but the character values must not be more than 256 apart characters can be used, but the character values must not be more
in the old regexp engine. For example, searching by [\u3000-\u4000] than 256 apart in the old regexp engine. For example, searching by
after setting re=1 emits a E945 error. Prepending \%#=2 will fix it. [\u3000-\u4000] after setting re=1 emits a E945 error. Prepending
\%#=2 will fix it.
- A character class expression is evaluated to the set of characters - A character class expression is evaluated to the set of characters
belonging to that character class. The following character classes belonging to that character class. The following character classes
are supported: are supported:

26
runtime/doc/popup.txt
View File

@ -1,4 +1,4 @@
*popup.txt* For Vim version 9.1. Last change: 2025 Sep 26 *popup.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -314,7 +314,7 @@ popup_dialog({what}, {options}) *popup_dialog()*
\ padding: [], \ padding: [],
\ mapping: 0, \ mapping: 0,
\}) \})
< Use {options} to change the properties. E.g. add a 'filter' < Use {options} to change the properties. E.g. add a 'filter'
option with value 'popup_filter_yesno'. Example: > option with value 'popup_filter_yesno'. Example: >
call popup_create('do you want to quit (Yes/no)?', #{ call popup_create('do you want to quit (Yes/no)?', #{
\ filter: 'popup_filter_yesno', \ filter: 'popup_filter_yesno',
@ -331,7 +331,7 @@ popup_dialog({what}, {options}) *popup_dialog()*
popup_filter_menu({id}, {key}) *popup_filter_menu()* popup_filter_menu({id}, {key}) *popup_filter_menu()*
Filter that can be used for a popup. These keys can be used: Filter that can be used for a popup. These keys can be used:
j <Down> <C-N> select item below j <Down> <C-N> select item below
k <Up> <C-P> select item above k <Up> <C-P> select item above
<Space> <Enter> accept current selection <Space> <Enter> accept current selection
@ -354,7 +354,7 @@ popup_filter_menu({id}, {key}) *popup_filter_menu()*
popup_filter_yesno({id}, {key}) *popup_filter_yesno()* popup_filter_yesno({id}, {key}) *popup_filter_yesno()*
Filter that can be used for a popup. It handles only the keys Filter that can be used for a popup. It handles only the keys
'y', 'Y' and 'n' or 'N'. Invokes the "callback" of the 'y', 'Y' and 'n' or 'N'. Invokes the "callback" of the
popup menu with the 1 for 'y' or 'Y' and zero for 'n' or 'N' popup menu with the 1 for 'y' or 'Y' and zero for 'n' or 'N'
as the second argument. Pressing Esc and 'x' works like as the second argument. Pressing Esc and 'x' works like
@ -460,7 +460,7 @@ popup_getpos({id}) *popup_getpos()*
popup_hide({id}) *popup_hide()* popup_hide({id}) *popup_hide()*
If {id} is a displayed popup, hide it now. If the popup has a If {id} is a displayed popup, hide it now. If the popup has a
filter it will not be invoked for so long as the popup is filter it will not be invoked for so long as the popup is
hidden. hidden.
If window {id} does not exist nothing happens. If window {id} If window {id} does not exist nothing happens. If window {id}
@ -491,8 +491,8 @@ popup_locate({row}, {col}) *popup_locate()*
popup_menu({what}, {options}) *popup_menu()* popup_menu({what}, {options}) *popup_menu()*
Show the {what} near the cursor, handle selecting one of the Show the {what} near the cursor, handle selecting one of the
items with cursorkeys, and close it an item is selected with items with cursorkeys, and close it an item is selected with
Space or Enter. {what} should have multiple lines to make this Space or Enter. {what} should have multiple lines to make
useful. This works like: > this useful. This works like: >
call popup_create({what}, #{ call popup_create({what}, #{
\ pos: 'center', \ pos: 'center',
\ zindex: 200, \ zindex: 200,
@ -627,7 +627,7 @@ popup_setoptions({id}, {options}) *popup_setoptions()*
popup_settext({id}, {text}) *popup_settext()* popup_settext({id}, {text}) *popup_settext()*
Set the text of the buffer in popup win {id}. {text} is Set the text of the buffer in popup win {id}. {text} is
a string or a list of strings to be displayed in the popup. a string or a list of strings to be displayed in the popup.
Does not change the window size or position, other than caused Does not change the window size or position, other than caused
by the different text. by the different text.
@ -710,7 +710,7 @@ The second argument of |popup_create()| is a dictionary with options:
omitted or invalid the current window is used. Used omitted or invalid the current window is used. Used
when "textprop" is present. when "textprop" is present.
textpropid Used to identify the text property when "textprop" is textpropid Used to identify the text property when "textprop" is
present. Use zero to reset. present. Use zero to reset.
fixed When FALSE (the default), and: fixed When FALSE (the default), and:
- "pos" is "botleft" or "topleft", and - "pos" is "botleft" or "topleft", and
- the popup would be truncated at the right edge of - the popup would be truncated at the right edge of
@ -753,7 +753,7 @@ The second argument of |popup_create()| is a dictionary with options:
wrap TRUE to make the lines wrap (default TRUE). wrap TRUE to make the lines wrap (default TRUE).
drag TRUE to allow the popup to be dragged with the mouse drag TRUE to allow the popup to be dragged with the mouse
by grabbing at the border. Has no effect if the by grabbing at the border. Has no effect if the
popup does not have a border. As soon as dragging popup does not have a border. As soon as dragging
starts and "pos" is "center" it is changed to starts and "pos" is "center" it is changed to
"topleft". "topleft".
dragall TRUE to allow the popup to be dragged from every dragall TRUE to allow the popup to be dragged from every
@ -803,10 +803,10 @@ The second argument of |popup_create()| is a dictionary with options:
scrollbar 1 or true: show a scrollbar when the text doesn't fit. scrollbar 1 or true: show a scrollbar when the text doesn't fit.
zero: do not show a scrollbar. Default is non-zero. zero: do not show a scrollbar. Default is non-zero.
Also see |popup-scrollbar|. Also see |popup-scrollbar|.
scrollbarhighlight Highlight group name for the scrollbar. The scrollbarhighlight Highlight group name for the scrollbar. The
background color is what matters. When not given then background color is what matters. When not given then
PmenuSbar is used. PmenuSbar is used.
thumbhighlight Highlight group name for the scrollbar thumb. The thumbhighlight Highlight group name for the scrollbar thumb. The
background color is what matters. When not given then background color is what matters. When not given then
PmenuThumb is used. PmenuThumb is used.
zindex Priority for the popup, default 50. Minimum value is zindex Priority for the popup, default 50. Minimum value is
@ -831,7 +831,7 @@ The second argument of |popup_create()| is a dictionary with options:
line or to another window. line or to another window.
mousemoved Like "moved" but referring to the mouse pointer mousemoved Like "moved" but referring to the mouse pointer
position position
cursorline TRUE: Highlight the cursor line. Also scrolls the cursorline TRUE: Highlight the cursor line. Also scrolls the
text to show this line (only works properly text to show this line (only works properly
when 'wrap' is off). when 'wrap' is off).
zero: Do not highlight the cursor line. zero: Do not highlight the cursor line.

9
runtime/doc/print.txt
View File

@ -1,4 +1,4 @@
*print.txt* For Vim version 9.1. Last change: 2025 Aug 10 *print.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -178,7 +178,7 @@ value for non-MS-Windows a trick is used: Adding "v:shell_error" will result
in a non-zero number when the system() call fails. in a non-zero number when the system() call fails.
If the expression starts with s: or |<SID>|, then it is replaced with the If the expression starts with s: or |<SID>|, then it is replaced with the
script ID (|local-function|). Example: > script ID (|local-function|). Example: >
set printexpr=s:MyPrintFile() set printexpr=s:MyPrintFile()
set printexpr=<SID>SomePrintFile() set printexpr=<SID>SomePrintFile()
Otherwise, the expression is evaluated in the context of the script where the Otherwise, the expression is evaluated in the context of the script where the
@ -545,8 +545,9 @@ There are a number of possible causes as to why the printing may have failed:
not support the requested paper size. By default Vim uses A4 paper. Find not support the requested paper size. By default Vim uses A4 paper. Find
out what size paper your printer normally uses and set the appropriate paper out what size paper your printer normally uses and set the appropriate paper
size with 'printoptions'. If you cannot find the name of the paper used, size with 'printoptions'. If you cannot find the name of the paper used,
measure a sheet and compare it with the table of supported paper sizes listed measure a sheet and compare it with the table of supported paper sizes
for 'printoptions', using the paper that is closest in both width AND height. listed for 'printoptions', using the paper that is closest in both width AND
height.
Note: The dimensions of actual paper may vary slightly from the ones listed. Note: The dimensions of actual paper may vary slightly from the ones listed.
If there is no paper listed close enough, then you may want to try psresize If there is no paper listed close enough, then you may want to try psresize
from PSUtils, discussed below. from PSUtils, discussed below.

171
runtime/doc/quickfix.txt
View File

@ -1,4 +1,4 @@
*quickfix.txt* For Vim version 9.1. Last change: 2025 Oct 11 *quickfix.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -45,13 +45,13 @@ compiler (see |errorformat| below).
*quickfix-stack* *quickfix-ID* *E1545* *quickfix-stack* *quickfix-ID* *E1545*
Each quickfix list has a unique identifier called the quickfix ID and this Each quickfix list has a unique identifier called the quickfix ID and this
number will not change within a Vim session. The |getqflist()| function can be number will not change within a Vim session. The |getqflist()| function can be
used to get the identifier assigned to a list. There is also a quickfix list used to get the identifier assigned to a list. There is also a quickfix list
number which may change whenever more than 'chistory' lists are added to a number which may change whenever more than 'chistory' lists are added to a
quickfix stack. quickfix stack.
*location-list* *E776* *location-list* *E776*
A location list is a window-local quickfix list. You get one after commands A location list is a window-local quickfix list. You get one after commands
like `:lvimgrep`, `:lgrep`, `:lhelpgrep`, `:lmake`, etc., which create a like `:lvimgrep`, `:lgrep`, `:lhelpgrep`, `:lmake`, etc., which create a
location list instead of a quickfix list as the corresponding `:vimgrep`, location list instead of a quickfix list as the corresponding `:vimgrep`,
`:grep`, `:helpgrep`, `:make` do. `:grep`, `:helpgrep`, `:make` do.
@ -67,7 +67,7 @@ the location list is destroyed.
*quickfix-changedtick* *quickfix-changedtick*
Every quickfix and location list has a read-only changedtick variable that Every quickfix and location list has a read-only changedtick variable that
tracks the total number of changes made to the list. Every time the quickfix tracks the total number of changes made to the list. Every time the quickfix
list is modified, this count is incremented. This can be used to perform an list is modified, this count is incremented. This can be used to perform an
action only when the list has changed. The |getqflist()| and |getloclist()| action only when the list has changed. The |getqflist()| and |getloclist()|
functions can be used to query the current value of changedtick. You cannot functions can be used to query the current value of changedtick. You cannot
change the changedtick variable. change the changedtick variable.
@ -87,9 +87,9 @@ processing a quickfix or location list command, it will be aborted.
*:cc* *:cc*
:cc[!] [nr] Display error [nr]. If [nr] is omitted, the same :cc[!] [nr] Display error [nr]. If [nr] is omitted, the same
:[nr]cc[!] error is displayed again. Without [!] this doesn't :[nr]cc[!] error is displayed again. Without [!] this doesn't
work when jumping to another buffer, the current buffer work when jumping to another buffer, the current
has been changed, there is the only window for the buffer has been changed, there is the only window for
buffer and both 'hidden' and 'autowrite' are off. the buffer and both 'hidden' and 'autowrite' are off.
When jumping to another buffer with [!] any changes to When jumping to another buffer with [!] any changes to
the current buffer are lost, unless 'hidden' is set or the current buffer are lost, unless 'hidden' is set or
there is another window for this buffer. there is another window for this buffer.
@ -131,10 +131,10 @@ processing a quickfix or location list command, it will be aborted.
used. If there are no errors, then an error message used. If there are no errors, then an error message
is displayed. Assumes that the entries in a quickfix is displayed. Assumes that the entries in a quickfix
list are sorted by their buffer number and line list are sorted by their buffer number and line
number. If there are multiple errors on the same line, number. If there are multiple errors on the same
then only the first entry is used. If [count] exceeds line, then only the first entry is used. If [count]
the number of entries above the current line, then the exceeds the number of entries above the current line,
first error in the file is selected. then the first error in the file is selected.
*:lab* *:labove* *:lab* *:labove*
:[count]lab[ove] Same as ":cabove", except the location list for the :[count]lab[ove] Same as ":cabove", except the location list for the
@ -276,7 +276,7 @@ processing a quickfix or location list command, it will be aborted.
*:caddf* *:caddfile* *:caddf* *:caddfile*
:caddf[ile] [errorfile] Read the error file and add the errors from the :caddf[ile] [errorfile] Read the error file and add the errors from the
errorfile to the current quickfix list. If a quickfix errorfile to the current quickfix list. If a quickfix
list is not present, then a new list is created. list is not present, then a new list is created.
If the encoding of the error file differs from the If the encoding of the error file differs from the
'encoding' option, you can use the 'makeencoding' 'encoding' option, you can use the 'makeencoding'
@ -317,7 +317,7 @@ processing a quickfix or location list command, it will be aborted.
Read the error list from the current buffer and add Read the error list from the current buffer and add
the errors to the current quickfix list. If a the errors to the current quickfix list. If a
quickfix list is not present, then a new list is quickfix list is not present, then a new list is
created. Otherwise, same as ":cbuffer". created. Otherwise, same as ":cbuffer".
*:laddb* *:laddbuffer* *:laddb* *:laddbuffer*
:[range]laddb[uffer] [bufnr] :[range]laddb[uffer] [bufnr]
@ -354,9 +354,9 @@ processing a quickfix or location list command, it will be aborted.
*:cadde* *:caddexpr* *:cadde* *:caddexpr*
:cadde[xpr] {expr} Evaluate {expr} and add the resulting lines to the :cadde[xpr] {expr} Evaluate {expr} and add the resulting lines to the
current quickfix list. If a quickfix list is not current quickfix list. If a quickfix list is not
present, then a new list is created. The current present, then a new list is created. The current
cursor position will not be changed. See |:cexpr| for cursor position will not be changed. See |:cexpr| for
more information. more information.
Example: > Example: >
:g/mypattern/caddexpr expand("%") .. ":" .. line(".") .. ":" .. getline(".") :g/mypattern/caddexpr expand("%") .. ":" .. line(".") .. ":" .. getline(".")
@ -368,11 +368,12 @@ processing a quickfix or location list command, it will be aborted.
*:cl* *:clist* *:cl* *:clist*
:cl[ist] [from] [, [to]] :cl[ist] [from] [, [to]]
List all errors that are valid |quickfix-valid|. List all errors that are valid |quickfix-valid|.
If numbers [from] and/or [to] are given, the respective If numbers [from] and/or [to] are given, the
range of errors is listed. A negative number counts respective range of errors is listed. A negative
from the last error backwards, -1 being the last error. number counts from the last error backwards, -1 being
the last error.
The |:filter| command can be used to display only the The |:filter| command can be used to display only the
quickfix entries matching a supplied pattern. The quickfix entries matching a supplied pattern. The
pattern is matched against the filename, module name, pattern is matched against the filename, module name,
pattern and text of the entry. pattern and text of the entry.
@ -408,7 +409,7 @@ the error location may not be correct. If you quit Vim and start again the
marks are lost and the error locations may not be correct anymore. marks are lost and the error locations may not be correct anymore.
Two autocommands are available for running commands before and after a Two autocommands are available for running commands before and after a
quickfix command (':make', ':grep' and so on) is executed. See quickfix command (':make', ':grep' and so on) is executed. See
|QuickFixCmdPre| and |QuickFixCmdPost| for details. |QuickFixCmdPre| and |QuickFixCmdPost| for details.
*QuickFixCmdPost-example* *QuickFixCmdPost-example*
@ -427,11 +428,11 @@ use this code: >
Another option is using 'makeencoding'. Another option is using 'makeencoding'.
*quickfix-title* *quickfix-title*
Every quickfix and location list has a title. By default the title is set to Every quickfix and location list has a title. By default the title is set to
the command that created the list. The |getqflist()| and |getloclist()| the command that created the list. The |getqflist()| and |getloclist()|
functions can be used to get the title of a quickfix and a location list functions can be used to get the title of a quickfix and a location list
respectively. The |setqflist()| and |setloclist()| functions can be used to respectively. The |setqflist()| and |setloclist()| functions can be used to
modify the title of a quickfix and location list respectively. Examples: > modify the title of a quickfix and location list respectively. Examples: >
call setqflist([], 'a', {'title' : 'Cmd output'}) call setqflist([], 'a', {'title' : 'Cmd output'})
echo getqflist({'title' : 1}) echo getqflist({'title' : 1})
call setloclist(3, [], 'a', {'title' : 'Cmd output'}) call setloclist(3, [], 'a', {'title' : 'Cmd output'})
@ -440,32 +441,32 @@ modify the title of a quickfix and location list respectively. Examples: >
*quickfix-index* *quickfix-index*
When you jump to a quickfix/location list entry using any of the quickfix When you jump to a quickfix/location list entry using any of the quickfix
commands (e.g. |:cc|, |:cnext|, |:cprev|, etc.), that entry becomes the commands (e.g. |:cc|, |:cnext|, |:cprev|, etc.), that entry becomes the
currently selected entry. The index of the currently selected entry in a currently selected entry. The index of the currently selected entry in a
quickfix/location list can be obtained using the getqflist()/getloclist() quickfix/location list can be obtained using the getqflist()/getloclist()
functions. Examples: > functions. Examples: >
echo getqflist({'idx' : 0}).idx echo getqflist({'idx' : 0}).idx
echo getqflist({'id' : qfid, 'idx' : 0}).idx echo getqflist({'id' : qfid, 'idx' : 0}).idx
echo getloclist(2, {'idx' : 0}).idx echo getloclist(2, {'idx' : 0}).idx
< <
For a new quickfix list, the first entry is selected and the index is 1. Any For a new quickfix list, the first entry is selected and the index is 1. Any
entry in any quickfix/location list can be set as the currently selected entry entry in any quickfix/location list can be set as the currently selected entry
using the setqflist() function. Examples: > using the setqflist() function. Examples: >
call setqflist([], 'a', {'idx' : 12}) call setqflist([], 'a', {'idx' : 12})
call setqflist([], 'a', {'id' : qfid, 'idx' : 7}) call setqflist([], 'a', {'id' : qfid, 'idx' : 7})
call setloclist(1, [], 'a', {'idx' : 7}) call setloclist(1, [], 'a', {'idx' : 7})
< <
*quickfix-size* *quickfix-size*
You can get the number of entries (size) in a quickfix and a location list You can get the number of entries (size) in a quickfix and a location list
using the |getqflist()| and |getloclist()| functions respectively. Examples: > using the |getqflist()| and |getloclist()| functions respectively. Examples: >
echo getqflist({'size' : 1}) echo getqflist({'size' : 1})
echo getloclist(5, {'size' : 1}) echo getloclist(5, {'size' : 1})
< <
*quickfix-context* *quickfix-context*
Any Vim type can be associated as a context with a quickfix or location list. Any Vim type can be associated as a context with a quickfix or location list.
The |setqflist()| and the |setloclist()| functions can be used to associate a The |setqflist()| and the |setloclist()| functions can be used to associate a
context with a quickfix and a location list respectively. The |getqflist()| context with a quickfix and a location list respectively. The |getqflist()|
and the |getloclist()| functions can be used to retrieve the context of a and the |getloclist()| functions can be used to retrieve the context of a
quickfix and a location list respectively. This is useful for a Vim plugin quickfix and a location list respectively. This is useful for a Vim plugin
dealing with multiple quickfix/location lists. dealing with multiple quickfix/location lists.
Examples: > Examples: >
@ -479,11 +480,11 @@ Examples: >
< <
*quickfix-parse* *quickfix-parse*
You can parse a list of lines using 'errorformat' without creating or You can parse a list of lines using 'errorformat' without creating or
modifying a quickfix list using the |getqflist()| function. Examples: > modifying a quickfix list using the |getqflist()| function. Examples: >
echo getqflist({'lines' : ["F1:10:Line10", "F2:20:Line20"]}) echo getqflist({'lines' : ["F1:10:Line10", "F2:20:Line20"]})
echo getqflist({'lines' : systemlist('grep -Hn quickfix *')}) echo getqflist({'lines' : systemlist('grep -Hn quickfix *')})
This returns a dictionary where the "items" key contains the list of quickfix This returns a dictionary where the "items" key contains the list of quickfix
entries parsed from lines. The following shows how to use a custom entries parsed from lines. The following shows how to use a custom
'errorformat' to parse the lines without modifying the 'errorformat' option: > 'errorformat' to parse the lines without modifying the 'errorformat' option: >
echo getqflist({'efm' : '%f#%l#%m', 'lines' : ['F1#10#Line']}) echo getqflist({'efm' : '%f#%l#%m', 'lines' : ['F1#10#Line']})
< <
@ -562,11 +563,11 @@ Then you can use the following commands to filter a quickfix/location list: >
:Lfilter[!] /{pat}/ :Lfilter[!] /{pat}/
The |:Cfilter| command creates a new quickfix list from the entries matching The |:Cfilter| command creates a new quickfix list from the entries matching
{pat} in the current quickfix list. {pat} is a Vim |regular-expression| {pat} in the current quickfix list. {pat} is a Vim |regular-expression|
pattern. Both the file name and the text of the entries are matched against pattern. Both the file name and the text of the entries are matched against
{pat}. If the optional ! is supplied, then the entries not matching {pat} are {pat}. If the optional ! is supplied, then the entries not matching {pat} are
used. The pattern can be optionally enclosed using one of the following used. The pattern can be optionally enclosed using one of the following
characters: ', ", /. If the pattern is empty, then the last used search characters: ', ", /. If the pattern is empty, then the last used search
pattern is used. pattern is used.
The |:Lfilter| command does the same as |:Cfilter| but operates on the current The |:Lfilter| command does the same as |:Cfilter| but operates on the current
@ -595,19 +596,19 @@ can go back to the unfiltered list using the |:colder|/|:lolder| command.
'buftype' equal to "quickfix". Don't change this! 'buftype' equal to "quickfix". Don't change this!
The window will have the w:quickfix_title variable set The window will have the w:quickfix_title variable set
which will indicate the command that produced the which will indicate the command that produced the
quickfix list. This can be used to compose a custom quickfix list. This can be used to compose a custom
status line if the value of 'statusline' is adjusted status line if the value of 'statusline' is adjusted
properly. Whenever this buffer is modified by a properly. Whenever this buffer is modified by a
quickfix command or function, the |b:changedtick| quickfix command or function, the |b:changedtick|
variable is incremented. You can get the number of variable is incremented. You can get the number of
this buffer using the getqflist() and getloclist() this buffer using the getqflist() and getloclist()
functions by passing the "qfbufnr" item. For a functions by passing the "qfbufnr" item. For a
location list, this buffer is wiped out when the location list, this buffer is wiped out when the
location list is removed. location list is removed.
*:lop* *:lopen* *:lop* *:lopen*
:lop[en] [height] Open a window to show the location list for the :lop[en] [height] Open a window to show the location list for the
current window. Works only when the location list for current window. Works only when the location list for
the current window is present. You can have more than the current window is present. You can have more than
one location window opened at a time. Otherwise, it one location window opened at a time. Otherwise, it
acts the same as ":copen". acts the same as ":copen".
@ -714,7 +715,7 @@ The location list window displays the entries in a location list. When you
open a location list window, it is created below the current window and open a location list window, it is created below the current window and
displays the location list for the current window. The location list window displays the location list for the current window. The location list window
is similar to the quickfix window, except that you can have more than one is similar to the quickfix window, except that you can have more than one
location list window open at a time. When you use a location list command in location list window open at a time. When you use a location list command in
this window, the displayed location list is used. this window, the displayed location list is used.
When you select a file from the location list window, the following steps are When you select a file from the location list window, the following steps are
@ -743,7 +744,7 @@ present). Examples: >
< <
*getqflist-examples* *getqflist-examples*
The |getqflist()| and |getloclist()| functions can be used to get the various The |getqflist()| and |getloclist()| functions can be used to get the various
attributes of a quickfix and location list respectively. Some examples for attributes of a quickfix and location list respectively. Some examples for
using these functions are below: using these functions are below:
> >
" get the title of the current quickfix list " get the title of the current quickfix list
@ -809,7 +810,7 @@ using these functions are below:
< <
*setqflist-examples* *setqflist-examples*
The |setqflist()| and |setloclist()| functions can be used to set the various The |setqflist()| and |setloclist()| functions can be used to set the various
attributes of a quickfix and location list respectively. Some examples for attributes of a quickfix and location list respectively. Some examples for
using these functions are below: using these functions are below:
> >
" create an empty quickfix list with a title and a context " create an empty quickfix list with a title and a context
@ -893,7 +894,7 @@ existing error lists as the current one.
error list 3 of 3; 15 errors :grep ex_help *.c ~ error list 3 of 3; 15 errors :grep ex_help *.c ~
When [count] is given, then the count'th quickfix When [count] is given, then the count'th quickfix
list is made the current list. Example: > list is made the current list. Example: >
" Make the 4th quickfix list current " Make the 4th quickfix list current
:4chistory :4chistory
< <
@ -910,7 +911,7 @@ lists, use ":cnewer 99" first.
To get the number of lists in the quickfix and location list stack, you can To get the number of lists in the quickfix and location list stack, you can
use the |getqflist()| and |getloclist()| functions respectively with the list use the |getqflist()| and |getloclist()| functions respectively with the list
number set to the special value '$'. Examples: > number set to the special value '$'. Examples: >
echo getqflist({'nr' : '$'}).nr echo getqflist({'nr' : '$'}).nr
echo getloclist(3, {'nr' : '$'}).nr echo getloclist(3, {'nr' : '$'}).nr
To get the number of the current list in the stack: > To get the number of the current list in the stack: >
@ -1066,7 +1067,7 @@ commands can be combined to create a NewGrep command: >
buffer are abandoned. buffer are abandoned.
'f' When the 'f' flag is specified, fuzzy string 'f' When the 'f' flag is specified, fuzzy string
matching is used to find matching lines. In this matching is used to find matching lines. In this
case, {pattern} is treated as a literal string case, {pattern} is treated as a literal string
instead of a regular expression. See instead of a regular expression. See
|fuzzy-matching| for more information about fuzzy |fuzzy-matching| for more information about fuzzy
@ -1181,8 +1182,8 @@ arguments to :grep are passed straight to the "grep" program, so you can use
whatever options your "grep" supports. whatever options your "grep" supports.
By default, :grep invokes grep with the -n option (show file and line By default, :grep invokes grep with the -n option (show file and line
numbers). You can change this with the 'grepprg' option. You will need to set numbers). You can change this with the 'grepprg' option. You will need to
'grepprg' if: set 'grepprg' if:
a) You are using a program that isn't called "grep" a) You are using a program that isn't called "grep"
b) You have to call grep with a full path b) You have to call grep with a full path
@ -1282,7 +1283,7 @@ Use the |compiler-make| plugin to undo the effect of a compiler plugin.
CPPCHECK *quickfix-cppcheck* *compiler-cppcheck* CPPCHECK *quickfix-cppcheck* *compiler-cppcheck*
Use g/b:`c_cppcheck_params` to set cppcheck parameters. The global Use g/b:`c_cppcheck_params` to set cppcheck parameters. The global
settings by default include settings by default include
- `--verbose`: Enables verbose output. - `--verbose`: Enables verbose output.
@ -1297,10 +1298,10 @@ For C++ files (`filetype == 'cpp'`), the `--language=c++` option is added to
ensure Cppcheck treats the file as C++. ensure Cppcheck treats the file as C++.
If compile_commands.json is present in the current directory, it is added as a If compile_commands.json is present in the current directory, it is added as a
`--project` parameter to the command line. Otherwise, by default the `--project` parameter to the command line. Otherwise, by default the
directories in &path are passed as include directories. These can be set by directories in &path are passed as include directories. These can be set by
g/b:`c_cppcheck_includes` as a list of `-I` flags. Tim Pope's vim-apathy g/b:`c_cppcheck_includes` as a list of `-I` flags. Tim Pope's vim-apathy
plug-in [0] can expand &path. To also append the folders in a git repo use > plug-in [0] can expand &path. To also append the folders in a git repo use >
let &l:path = join(systemlist('git ls-tree -d --name-only -r HEAD'), ',') let &l:path = join(systemlist('git ls-tree -d --name-only -r HEAD'), ',')
@ -1308,12 +1309,13 @@ plug-in [0] can expand &path. To also append the folders in a git repo use >
DOTNET *compiler-dotnet* DOTNET *compiler-dotnet*
The .NET CLI compiler outputs both errors and warnings by default. The output The .NET CLI compiler outputs both errors and warnings by default. The output
may be limited to include only errors, by setting the g:dotnet_errors_only may be limited to include only errors, by setting the g:dotnet_errors_only
variable to |v:true|. variable to |v:true|.
The associated project name is included in each error and warning. To suppress The associated project name is included in each error and warning. To
the project name, set the g:dotnet_show_project_file variable to |v:false|. suppress the project name, set the g:dotnet_show_project_file variable to
|v:false|.
Example: limit output to only display errors, and suppress the project name: > Example: limit output to only display errors, and suppress the project name: >
let dotnet_errors_only = v:true let dotnet_errors_only = v:true
@ -1600,9 +1602,9 @@ manpage) as input and expects that the output file type extension is passed to
make, say :make html or :make pdf. make, say :make html or :make pdf.
Additional arguments can be passed to groff by setting them in Additional arguments can be passed to groff by setting them in
`b:groff_compiler_args` or `g:groff_compiler_args`. The `language` argument `b:groff_compiler_args` or `g:groff_compiler_args`. The `language` argument
passed to groff is set using 'spelllang'; it can be overridden by setting passed to groff is set using 'spelllang'; it can be overridden by setting
`b:groff_compiler_lang`. The default encoding is `UTF-8` and can be changed `b:groff_compiler_lang`. The default encoding is `UTF-8` and can be changed
by setting `b:groff_compiler_encoding` or `g:groff_compiler_encoding`. by setting `b:groff_compiler_encoding` or `g:groff_compiler_encoding`.
PANDOC *quickfix-pandoc* *compiler-pandoc* PANDOC *quickfix-pandoc* *compiler-pandoc*
@ -1690,8 +1692,8 @@ Included in the distribution compiler for TeX ($VIMRUNTIME/compiler/tex.vim)
uses make command if possible. If the compiler finds a file named "Makefile" uses make command if possible. If the compiler finds a file named "Makefile"
or "makefile" in the current directory, it supposes that you want to process or "makefile" in the current directory, it supposes that you want to process
your *TeX files with make, and the makefile does the right work. In this case your *TeX files with make, and the makefile does the right work. In this case
compiler sets 'errorformat' for *TeX output and leaves 'makeprg' untouched. If compiler sets 'errorformat' for *TeX output and leaves 'makeprg' untouched.
neither "Makefile" nor "makefile" is found, the compiler will not use make. If neither "Makefile" nor "makefile" is found, the compiler will not use make.
You can force the compiler to ignore makefiles by defining You can force the compiler to ignore makefiles by defining
b:tex_ignore_makefile or g:tex_ignore_makefile variable (they are checked for b:tex_ignore_makefile or g:tex_ignore_makefile variable (they are checked for
existence only). existence only).
@ -1731,13 +1733,13 @@ b/g:tsc_makeprg variable. For example: >
TYPST COMPILER *compiler-typst* TYPST COMPILER *compiler-typst*
Vim includes a compiler plugin for Typst files. This compiler is enabled Vim includes a compiler plugin for Typst files. This compiler is enabled
automatically in Typst buffers by the Typst filetype plugin |ft-typst-plugin|. automatically in Typst buffers by the Typst filetype plugin |ft-typst-plugin|.
Run |:make| to compile the current Typst file. Run |:make| to compile the current Typst file.
*g:typst_cmd* *g:typst_cmd*
By default Vim will use "typst" as the command to run the Typst compiler. This By default Vim will use "typst" as the command to run the Typst compiler.
can be changed by setting the |g:typst_cmd| variable: > This can be changed by setting the |g:typst_cmd| variable: >
let g:typst_cmd = "/path/to/other/command" let g:typst_cmd = "/path/to/other/command"
============================================================================= =============================================================================
@ -1824,11 +1826,11 @@ or >
to indicate the column of the error. This is to be used in a multi-line error to indicate the column of the error. This is to be used in a multi-line error
message. See |errorformat-javac| for a useful example. message. See |errorformat-javac| for a useful example.
The "%s" conversion specifies the text to search for, to locate the error line. The "%s" conversion specifies the text to search for, to locate the error
The text is used as a literal string. The anchors "^" and "$" are added to line. The text is used as a literal string. The anchors "^" and "$" are
the text to locate the error line exactly matching the search text and the added to the text to locate the error line exactly matching the search text
text is prefixed with the "\V" atom to make it "very nomagic". The "%s" and the text is prefixed with the "\V" atom to make it "very nomagic". The
conversion can be used to locate lines without a line number in the error "%s" conversion can be used to locate lines without a line number in the error
output. Like the output of the "grep" shell command. output. Like the output of the "grep" shell command.
When the pattern is present the line number will not be used. When the pattern is present the line number will not be used.
@ -2019,7 +2021,8 @@ be escaped), meta symbols have to be written with leading '%':
%~ The single '~' character. %~ The single '~' character.
When using character classes in expressions (see |/\i| for an overview), When using character classes in expressions (see |/\i| for an overview),
terms containing the "\+" quantifier can be written in the scanf() "%*" terms containing the "\+" quantifier can be written in the scanf() "%*"
notation. Example: "%\\d%\\+" ("\d\+", "any number") is equivalent to "%*\\d". notation. Example: "%\\d%\\+" ("\d\+", "any number") is equivalent to
"%*\\d".
Important note: The \(...\) grouping of sub-matches can not be used in format Important note: The \(...\) grouping of sub-matches can not be used in format
specifications because it is reserved for internal conversions. specifications because it is reserved for internal conversions.
@ -2227,7 +2230,7 @@ You need to put the following in "vim-javac-filter" somewhere in your path
In English, that sed script: In English, that sed script:
- Changes single tabs to single spaces and - Changes single tabs to single spaces and
- Moves the line with the filename, line number, error message to just after - Moves the line with the filename, line number, error message to just after
the pointer line. That way, the unused error text between doesn't break the pointer line. That way, the unused error text between doesn't break
vim's notion of a "multi-line message" and also doesn't force us to include vim's notion of a "multi-line message" and also doesn't force us to include
it as a "continuation of a multi-line message." it as a "continuation of a multi-line message."
@ -2356,40 +2359,40 @@ The values displayed in each line correspond to the "bufnr", "lnum", "col" and
For some quickfix/location lists, the displayed text needs to be customized. For some quickfix/location lists, the displayed text needs to be customized.
For example, if only the filename is present for a quickfix entry, then the For example, if only the filename is present for a quickfix entry, then the
two "|" field separator characters after the filename are not needed. Another two "|" field separator characters after the filename are not needed. Another
use case is to customize the path displayed for a filename. By default, the use case is to customize the path displayed for a filename. By default, the
complete path (which may be too long) is displayed for files which are not complete path (which may be too long) is displayed for files which are not
under the current directory tree. The file path may need to be simplified to a under the current directory tree. The file path may need to be simplified to
common parent directory. a common parent directory.
The displayed text can be customized by setting the 'quickfixtextfunc' option The displayed text can be customized by setting the 'quickfixtextfunc' option
to a Vim function. This function will be called with a dict argument and to a Vim function. This function will be called with a dict argument and
should return a List of strings to be displayed in the quickfix or location should return a List of strings to be displayed in the quickfix or location
list window. The dict argument will have the following fields: list window. The dict argument will have the following fields:
quickfix set to 1 when called for a quickfix list and 0 when called for quickfix set to 1 when called for a quickfix list and 0 when called for
a location list. a location list.
winid for a location list, set to the id of the window with the winid for a location list, set to the id of the window with the
location list. For a quickfix list, set to 0. Can be used in location list. For a quickfix list, set to 0. Can be used in
getloclist() to get the location list entry. getloclist() to get the location list entry.
id quickfix or location list identifier id quickfix or location list identifier
start_idx index of the first entry for which text should be returned start_idx index of the first entry for which text should be returned
end_idx index of the last entry for which text should be returned end_idx index of the last entry for which text should be returned
The function should return a single line of text to display in the quickfix The function should return a single line of text to display in the quickfix
window for each entry from start_idx to end_idx. The function can obtain window for each entry from start_idx to end_idx. The function can obtain
information about the entries using the |getqflist()| function and specifying information about the entries using the |getqflist()| function and specifying
the quickfix list identifier "id". For a location list, getloclist() function the quickfix list identifier "id". For a location list, getloclist() function
can be used with the "winid" argument. If an empty list is returned, then the can be used with the "winid" argument. If an empty list is returned, then the
default format is used to display all the entries. If an item in the returned default format is used to display all the entries. If an item in the returned
list is an empty string, then the default format is used to display the list is an empty string, then the default format is used to display the
corresponding entry. corresponding entry.
If a quickfix or location list specific customization is needed, then the If a quickfix or location list specific customization is needed, then the
'quickfixtextfunc' attribute of the list can be set using the |setqflist()| or 'quickfixtextfunc' attribute of the list can be set using the |setqflist()| or
|setloclist()| function. This overrides the global 'quickfixtextfunc' option. |setloclist()| function. This overrides the global 'quickfixtextfunc' option.
The example below displays the list of old files (|v:oldfiles|) in a quickfix The example below displays the list of old files (|v:oldfiles|) in a quickfix
window. As there is no line, column number and error text information window. As there is no line, column number and error text information
associated with each entry, the 'quickfixtextfunc' function returns only the associated with each entry, the 'quickfixtextfunc' function returns only the
filename. filename.
Example: > Example: >

4
runtime/doc/recover.txt
View File

@ -1,4 +1,4 @@
*recover.txt* For Vim version 9.1. Last change: 2023 Apr 22 *recover.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -88,7 +88,7 @@ The 'swapfile' option can be reset to avoid creating a swapfile. And the
|:noswapfile| modifier can be used to not create a swapfile for a new buffer. |:noswapfile| modifier can be used to not create a swapfile for a new buffer.
:nos[wapfile] {command} *:nos* *:noswapfile* :nos[wapfile] {command} *:nos* *:noswapfile*
Execute {command}. If it contains a command that loads a new Execute {command}. If it contains a command that loads a new
buffer, it will be loaded without creating a swapfile and the buffer, it will be loaded without creating a swapfile and the
'swapfile' option will be reset. If a buffer already had a 'swapfile' option will be reset. If a buffer already had a
swapfile it is not removed and 'swapfile' is not reset. swapfile it is not removed and 'swapfile' is not reset.

92
runtime/doc/repeat.txt
View File

@ -1,4 +1,4 @@
*repeat.txt* For Vim version 9.1. Last change: 2025 Jul 15 *repeat.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -86,7 +86,7 @@ line is aborted and the global command continues with the next marked or
unmarked line. unmarked line.
*E147* *E147*
When the command is used recursively, it only works on one line. Giving a When the command is used recursively, it only works on one line. Giving a
range is then not allowed. This is useful to find all lines that match a range is then not allowed. This is useful to find all lines that match a
pattern and do not match another pattern: > pattern and do not match another pattern: >
:g/found/v/notfound/{cmd} :g/found/v/notfound/{cmd}
This first finds all lines containing "found", but only executes {cmd} when This first finds all lines containing "found", but only executes {cmd} when
@ -157,18 +157,18 @@ q Stops recording. (Implementation note: The 'q' that
@@ Repeat the previous @{0-9a-z":*} [count] times. @@ Repeat the previous @{0-9a-z":*} [count] times.
*:@* *:@*
:[addr]@{0-9a-z".=*+} Execute the contents of register {0-9a-z".=*+} as an Ex :[addr]@{0-9a-z".=*+} Execute the contents of register {0-9a-z".=*+} as an
command. First set cursor at line [addr] (default is Ex command. First set cursor at line [addr] (default
current line). When the last line in the register does is current line). When the last line in the register
not have a <CR> it will be added automatically when does not have a <CR> it will be added automatically
the 'e' flag is present in 'cpoptions'. when the 'e' flag is present in 'cpoptions'.
For ":@=" the last used expression is used. The For ":@=" the last used expression is used. The
result of evaluating the expression is executed as an result of evaluating the expression is executed as an
Ex command. Ex command.
Mappings are not recognized in these commands. Mappings are not recognized in these commands.
When the |line-continuation| character (\) is present When the |line-continuation| character (\) is present
at the beginning of a line in a linewise register, at the beginning of a line in a linewise register,
then it is combined with the previous line. This is then it is combined with the previous line. This is
useful for yanking and executing parts of a Vim useful for yanking and executing parts of a Vim
script. script.
Future: Will execute the register for each line in the Future: Will execute the register for each line in the
@ -206,7 +206,7 @@ For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
When sourcing commands from the current buffer, the When sourcing commands from the current buffer, the
same script-ID |<SID>| is used even if the buffer is same script-ID |<SID>| is used even if the buffer is
sourced multiple times. If a buffer is sourced more sourced multiple times. If a buffer is sourced more
than once, then the functions in the buffer are than once, then the functions in the buffer are
defined again. defined again.
@ -226,9 +226,9 @@ For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
This works like the range started with the This works like the range started with the
":vim9script noclear" command. The "++clear" argument ":vim9script noclear" command. The "++clear" argument
can be used to clear the script-local variables and can be used to clear the script-local variables and
functions before sourcing the script. This works like functions before sourcing the script. This works like
the range started with the `:vim9script` command the range started with the `:vim9script` command
without the "noclear" argument. See |vim9-reload| for without the "noclear" argument. See |vim9-reload| for
more information. more information.
Examples: > Examples: >
:4,5source :4,5source
@ -390,7 +390,7 @@ For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
to use ":scriptencoding utf-8" then. to use ":scriptencoding utf-8" then.
If you set the 'encoding' option in your |.vimrc|, If you set the 'encoding' option in your |.vimrc|,
`:scriptencoding` must be placed after that. E.g.: > `:scriptencoding` must be placed after that. E.g.: >
set encoding=utf-8 set encoding=utf-8
scriptencoding utf-8 scriptencoding utf-8
< <
@ -615,8 +615,8 @@ advantages over normal plugins:
Using a package and loading automatically ~ Using a package and loading automatically ~
Let's assume your Vim files are in the "~/.vim" directory and you want to add a Let's assume your Vim files are in the "~/.vim" directory and you want to add
package from a zip archive "/tmp/foopack.zip": > a package from a zip archive "/tmp/foopack.zip": >
% mkdir -p ~/.vim/pack/foo % mkdir -p ~/.vim/pack/foo
% cd ~/.vim/pack/foo % cd ~/.vim/pack/foo
% unzip /tmp/foopack.zip % unzip /tmp/foopack.zip
@ -647,9 +647,9 @@ find the syntax/some.vim file, because its directory is in 'runtimepath'.
Vim will also load ftdetect files, if there are any. Vim will also load ftdetect files, if there are any.
Note that the files under "pack/foo/opt" are not loaded automatically, only the Note that the files under "pack/foo/opt" are not loaded automatically, only
ones under "pack/foo/start". See |pack-add| below for how the "opt" directory the ones under "pack/foo/start". See |pack-add| below for how the "opt"
is used. directory is used.
Loading packages automatically will not happen if loading plugins is disabled, Loading packages automatically will not happen if loading plugins is disabled,
see |load-plugins|. see |load-plugins|.
@ -725,8 +725,8 @@ This assumes you write one or more plugins that you distribute as a package.
If you have two unrelated plugins you would use two packages, so that Vim If you have two unrelated plugins you would use two packages, so that Vim
users can choose what they include or not. Or you can decide to use one users can choose what they include or not. Or you can decide to use one
package with optional plugins, and tell the user to add the preferred ones with package with optional plugins, and tell the user to add the preferred ones
`:packadd`. with `:packadd`.
Decide how you want to distribute the package. You can create an archive or Decide how you want to distribute the package. You can create an archive or
you could use a repository. An archive can be used by more users, but is a you could use a repository. An archive can be used by more users, but is a
@ -790,7 +790,7 @@ Where:
The directory structure where the message translation files should be placed The directory structure where the message translation files should be placed
is (from the top-level directory of the package): is (from the top-level directory of the package):
"lang/<lang_id>/LC_MESSAGES". For the format of <lang_id> see |multi-lang|. "lang/<lang_id>/LC_MESSAGES". For the format of <lang_id> see |multi-lang|.
This function needs to be called only once during the initialization of the This function needs to be called only once during the initialization of the
plugin. plugin.
Once this is done, the |gettext()| function can be used to retrieve translated Once this is done, the |gettext()| function can be used to retrieve translated
@ -818,27 +818,28 @@ PLUGPACKAGE A variable containing the name of the package that we
|gettext()| functions, for example, "foobar". |gettext()| functions, for example, "foobar".
PO_PLUG_INPUTLIST A variable containing scripts that have strings PO_PLUG_INPUTLIST A variable containing scripts that have strings
to translate, i.e. where we specified the |gettext()| to translate, i.e. where we specified the |gettext()|
function. Scripts are specified with an absolute function. Scripts are specified with an absolute
or relative path. Example: start/foobar/plugin/bar.vim or relative path. Example:
start/foobar/plugin/bar.vim
use blanks to separate scripts. use blanks to separate scripts.
POT_PLUGPACKAGE_PATH A variable containing the directory where the prepared POT_PLUGPACKAGE_PATH A variable containing the directory where the prepared
POT file will be saved. This is not a required variable, POT file will be saved. This is not a required
if no directory is specified, then the POT file will variable, if no directory is specified, then the POT
be placed in the "src/po" directory. file will be placed in the "src/po" directory.
VIMPROG A variable containing a directory with a working Vim. VIMPROG A variable containing a directory with a working Vim.
If the Vim editor is already built and installed, and If the Vim editor is already built and installed, and
is contained in the $PATH environment variable, is contained in the $PATH environment variable,
then you can specify just the name of the vim then you can specify just the name of the vim
executable. executable.
{package}.pot This is the Target. It is specified as the name of {package}.pot This is the Target. It is specified as the name of
the package, for example, "foobar" with the addition the package, for example, "foobar" with the addition
of the .pot extension. of the .pot extension.
Once a POT file is created, its contents are copied into separate PO files for Once a POT file is created, its contents are copied into separate PO files for
each language for which the translation will be prepared. each language for which the translation will be prepared.
When the translation is finished, it is necessary to convert the PO files into When the translation is finished, it is necessary to convert the PO files into
binary MO-files format and place these MO-files into the "lang/" directory, the binary MO-files format and place these MO-files into the "lang/" directory,
structure of which we created earlier. the structure of which we created earlier.
To do this, run the following commands: To do this, run the following commands:
> >
cd ~/forkvim/src/po cd ~/forkvim/src/po
@ -851,15 +852,16 @@ Where:
PLUGPACKAGE A variable containing the name of the package that we PLUGPACKAGE A variable containing the name of the package that we
specified in the |bindtextdomain()| and |gettext()| specified in the |bindtextdomain()| and |gettext()|
functions, for example, "foobar". functions, for example, "foobar".
PO_PLUGPACKAGE A variable containing a PO file. The file is specified PO_PLUGPACKAGE A variable containing a PO file. The file is
with an absolute or relative path. For example, specified with an absolute or relative path. For
"~/myproject/translate/en.po" example, "~/myproject/translate/en.po"
MO_PLUGPACKAGE_PATH A variable containing the structure of the "lang/" MO_PLUGPACKAGE_PATH A variable containing the structure of the "lang/"
directory, where the file with translations will be directory, where the file with translations will be
placed, for example, "foobar.mo". This is not placed, for example, "foobar.mo". This is not
a required variable, if the directory is not specified, a required variable, if the directory is not
the MO file will be saved in the "src/po" directory. specified, the MO file will be saved in the "src/po"
{package}.mo This is the Target. It is specified as the name of directory.
{package}.mo This is the Target. It is specified as the name of
the package, for example, "foobar" with the addition the package, for example, "foobar" with the addition
of the .mo extension. of the .mo extension.
@ -978,7 +980,7 @@ And the PO file in German:
msgstr "Alle Dateien (*)\t*\n"~ msgstr "Alle Dateien (*)\t*\n"~
Now convert these files into MO files so that |gettext()| can display message Now convert these files into MO files so that |gettext()| can display message
translations. Note that since this is not a specialized plugin package, we translations. Note that since this is not a specialized plugin package, we
will put the MO files in the "lang/" directory of the Vim editor. will put the MO files in the "lang/" directory of the Vim editor.
Type the following commands: Type the following commands:
> >
@ -998,7 +1000,7 @@ Type the following commands:
That's it, the translations are ready and you can see the plugin's messages That's it, the translations are ready and you can see the plugin's messages
in your native language. in your native language.
Let's also try to translate a plugin package. For example, when a package Let's also try to translate a plugin package. For example, when a package
contains several scripts containing strings that need to be translated. contains several scripts containing strings that need to be translated.
For example, let's translate the "netrw" package into Japanese. For example, let's translate the "netrw" package into Japanese.
For this example, we will translate only a few lines from this package. For this example, we will translate only a few lines from this package.
@ -1096,7 +1098,7 @@ plug-in packages.
Dependencies between plugins ~ Dependencies between plugins ~
*packload-two-steps* *packload-two-steps*
Suppose you have two plugins that depend on the same functionality. You can Suppose you have two plugins that depend on the same functionality. You can
put the common functionality in an autoload directory, so that it will be put the common functionality in an autoload directory, so that it will be
found automatically. Your package would have these files: found automatically. Your package would have these files:
@ -1284,7 +1286,7 @@ DEFINING BREAKPOINTS
:breaka[dd] expr {expression} :breaka[dd] expr {expression}
Sets a breakpoint, that will break whenever the {expression} Sets a breakpoint, that will break whenever the {expression}
evaluates to a different value. Example: > evaluates to a different value. Example: >
:breakadd expr g:lnum :breakadd expr g:lnum
< Will break, whenever the global variable lnum changes. < Will break, whenever the global variable lnum changes.
@ -1399,7 +1401,7 @@ For example, to profile the one_script.vim script file: >
:prof[ile] stop :prof[ile] stop
Write the collected profiling information to the logfile and Write the collected profiling information to the logfile and
stop profiling. You can use the `:profile start` command to stop profiling. You can use the `:profile start` command to
clear the profiling statistics and start profiling again. clear the profiling statistics and start profiling again.
:prof[ile] pause :prof[ile] pause
@ -1431,8 +1433,8 @@ For example, to profile the one_script.vim script file: >
collect the profiling statistics. collect the profiling statistics.
:profd[el] ... *:profd* *:profdel* :profd[el] ... *:profd* *:profdel*
Stop profiling for the arguments specified. See |:breakdel| Stop profiling for the arguments specified. See |:breakdel|
for the arguments. Examples: > for the arguments. Examples: >
profdel func MyFunc profdel func MyFunc
profdel file MyScript.vim profdel file MyScript.vim
profdel here profdel here
@ -1480,9 +1482,9 @@ Profiling should give a good indication of where time is spent, but keep in
mind there are various things that may clobber the results: mind there are various things that may clobber the results:
- The accuracy of the time measured depends on the gettimeofday(), or - The accuracy of the time measured depends on the gettimeofday(), or
clock_gettime() if available, system function. The accuracy ranges from clock_gettime() if available, system function. The accuracy ranges from
1/100 second to nanoseconds. With clock_gettime() the times are displayed in 1/100 second to nanoseconds. With clock_gettime() the times are displayed
nanoseconds, otherwise microseconds. You can use `has("prof_nsec")`. in nanoseconds, otherwise microseconds. You can use `has("prof_nsec")`.
- Real elapsed time is measured, if other processes are busy they may cause - Real elapsed time is measured, if other processes are busy they may cause
delays at unpredictable moments. You may want to run the profiling several delays at unpredictable moments. You may want to run the profiling several

105
runtime/doc/sign.txt
View File

@ -1,4 +1,4 @@
*sign.txt* For Vim version 9.1. Last change: 2025 Oct 05 *sign.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Gordon Prieur VIM REFERENCE MANUAL by Gordon Prieur
@ -56,20 +56,20 @@ The color of the column is set with the SignColumn highlight group
If 'cursorline' is enabled, then the CursorLineSign highlight group is used If 'cursorline' is enabled, then the CursorLineSign highlight group is used
|hl-CursorLineSign|. |hl-CursorLineSign|.
*sign-identifier* *sign-identifier*
Each placed sign is identified by a number called the sign identifier. This Each placed sign is identified by a number called the sign identifier. This
identifier is used to jump to the sign or to remove the sign. The identifier identifier is used to jump to the sign or to remove the sign. The identifier
is assigned when placing the sign using the |:sign-place| command or the is assigned when placing the sign using the |:sign-place| command or the
|sign_place()| function. Each sign identifier should be a unique number. If |sign_place()| function. Each sign identifier should be a unique number. If
multiple placed signs use the same identifier, then jumping to or removing a multiple placed signs use the same identifier, then jumping to or removing a
sign becomes unpredictable. To avoid overlapping identifiers, sign groups can sign becomes unpredictable. To avoid overlapping identifiers, sign groups can
be used. The |sign_place()| function can be called with a zero sign identifier be used. The |sign_place()| function can be called with a zero sign identifier
to allocate the next available identifier. to allocate the next available identifier.
*sign-group* *sign-group*
Each placed sign can be assigned to either the global group or a named group. Each placed sign can be assigned to either the global group or a named group.
When placing a sign, if a group name is not supplied, or an empty string is When placing a sign, if a group name is not supplied, or an empty string is
used, then the sign is placed in the global group. Otherwise the sign is used, then the sign is placed in the global group. Otherwise the sign is
placed in the named group. The sign identifier is unique within a group. The placed in the named group. The sign identifier is unique within a group. The
sign group allows Vim plugins to use unique signs without interfering with sign group allows Vim plugins to use unique signs without interfering with
other plugins using signs. other plugins using signs.
@ -78,9 +78,9 @@ Other signs will not show in a popup window. The group name "PopUpMenu" is
used by popup windows where 'cursorline' is set. used by popup windows where 'cursorline' is set.
*sign-priority* *sign-priority*
Each placed sign is assigned a priority value. When multiple signs are placed Each placed sign is assigned a priority value. When multiple signs are placed
on the same line, the attributes of the sign with the highest priority is used on the same line, the attributes of the sign with the highest priority is used
independently of the sign group. The default priority for a sign is 10, this independently of the sign group. The default priority for a sign is 10, this
value can be changed for different signs by specifying a different value at value can be changed for different signs by specifying a different value at
definition time. The priority is assigned at the time of placing a sign. definition time. The priority is assigned at the time of placing a sign.
@ -213,8 +213,8 @@ See |sign_place()| for the equivalent Vim script function.
By default, the sign is placed in the global sign group. By default, the sign is placed in the global sign group.
By default, the sign is assigned a default priority of 10, By default, the sign is assigned a default priority of 10,
unless specified otherwise by the sign definition. To assign a unless specified otherwise by the sign definition. To assign
different priority value, use "priority={prio}" to specify a a different priority value, use "priority={prio}" to specify a
value. The priority is used to determine the sign that is value. The priority is used to determine the sign that is
displayed when multiple signs are placed on the same line. displayed when multiple signs are placed on the same line.
@ -312,7 +312,8 @@ See |sign_unplace()| for the equivalent Vim script function.
all the files it appears in. all the files it appears in.
:sig[n] unplace * :sig[n] unplace *
Remove all placed signs in the global group from all the files. Remove all placed signs in the global group from all the
files.
:sig[n] unplace * group={group} :sig[n] unplace * group={group}
Remove all placed signs in group {group} from all the files. Remove all placed signs in group {group} from all the files.
@ -321,8 +322,8 @@ See |sign_unplace()| for the equivalent Vim script function.
Remove all placed signs in all the groups from all the files. Remove all placed signs in all the groups from all the files.
:sig[n] unplace :sig[n] unplace
Remove a placed sign at the cursor position. If multiple signs Remove a placed sign at the cursor position. If multiple
are placed in the line, then only one is removed. signs are placed in the line, then only one is removed.
:sig[n] unplace group={group} :sig[n] unplace group={group}
Remove a placed sign in group {group} at the cursor Remove a placed sign in group {group} at the cursor
@ -380,7 +381,7 @@ See |sign_jump()| for the equivalent Vim script function.
:sig[n] jump {id} [buffer={nr}] *E934* :sig[n] jump {id} [buffer={nr}] *E934*
Same, but use buffer {nr}. This fails if buffer {nr} does not Same, but use buffer {nr}. This fails if buffer {nr} does not
have a name. If the buffer argument is not given, use the have a name. If the buffer argument is not given, use the
current buffer. current buffer.
:sig[n] jump {id} group={group} [buffer={nr}] :sig[n] jump {id} group={group} [buffer={nr}]
@ -448,7 +449,7 @@ sign_getdefined([{name}]) *sign_getdefined()*
This is similar to the |:sign-list| command. This is similar to the |:sign-list| command.
If the {name} is not supplied, then a list of all the defined If the {name} is not supplied, then a list of all the defined
signs is returned. Otherwise the attribute of the specified signs is returned. Otherwise the attribute of the specified
sign is returned. sign is returned.
Each list item in the returned value is a dictionary with the Each list item in the returned value is a dictionary with the
@ -491,15 +492,15 @@ sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
If the optional buffer name {buf} is specified, then only the If the optional buffer name {buf} is specified, then only the
list of signs placed in that buffer is returned. For the use list of signs placed in that buffer is returned. For the use
of {buf}, see |bufname()|. The optional {dict} can contain of {buf}, see |bufname()|. The optional {dict} can contain
the following entries: the following entries:
group select only signs in this group group select only signs in this group
id select sign with this identifier id select sign with this identifier
lnum select signs placed in this line. For the use lnum select signs placed in this line. For the use
of {lnum}, see |line()|. of {lnum}, see |line()|.
If {group} is '*', then signs in all the groups including the If {group} is '*', then signs in all the groups including the
global group are returned. If {group} is not supplied or is an global group are returned. If {group} is not supplied or is
empty string, then only signs in the global group are an empty string, then only signs in the global group are
returned. If no arguments are supplied, then signs in the returned. If no arguments are supplied, then signs in the
global group placed in all the buffers are returned. global group placed in all the buffers are returned.
See |sign-group|. See |sign-group|.
@ -507,12 +508,12 @@ sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
Each list item in the returned value is a dictionary with the Each list item in the returned value is a dictionary with the
following entries: following entries:
bufnr number of the buffer with the sign bufnr number of the buffer with the sign
signs list of signs placed in {bufnr}. Each list signs list of signs placed in {bufnr}. Each list
item is a dictionary with the below listed item is a dictionary with the below listed
entries entries
The dictionary for each sign contains the following entries: The dictionary for each sign contains the following entries:
group sign group. Set to '' for the global group. group sign group. Set to '' for the global group.
id identifier of the sign id identifier of the sign
lnum line number where the sign is placed lnum line number where the sign is placed
name name of the defined sign name name of the defined sign
@ -559,7 +560,7 @@ sign_jump({id}, {group}, {buf}) *sign_jump()*
If {group} is an empty string, then the global group is used. If {group} is an empty string, then the global group is used.
For the use of {buf}, see |bufname()|. For the use of {buf}, see |bufname()|.
Returns the line number of the sign. Returns -1 if the Returns the line number of the sign. Returns -1 if the
arguments are invalid. arguments are invalid.
Example: > Example: >
@ -579,21 +580,21 @@ sign_place({id}, {group}, {name}, {buf} [, {dict}])
similar to the |:sign-place| command. similar to the |:sign-place| command.
If the sign identifier {id} is zero, then a new identifier is If the sign identifier {id} is zero, then a new identifier is
allocated. Otherwise the specified number is used. {group} is allocated. Otherwise the specified number is used. {group}
the sign group name. To use the global sign group, use an is the sign group name. To use the global sign group, use an
empty string. {group} functions as a namespace for {id}, thus empty string. {group} functions as a namespace for {id}, thus
two groups can use the same IDs. Refer to |sign-identifier| two groups can use the same IDs. Refer to |sign-identifier|
and |sign-group| for more information. and |sign-group| for more information.
{name} refers to a defined sign. {name} refers to a defined sign.
{buf} refers to a buffer name or number. For the accepted {buf} refers to a buffer name or number. For the accepted
values, see |bufname()|. values, see |bufname()|.
The optional {dict} argument supports the following entries: The optional {dict} argument supports the following entries:
lnum line number in the file or buffer lnum line number in the file or buffer
{buf} where the sign is to be placed. {buf} where the sign is to be placed.
For the accepted values, see |line()|. For the accepted values, see |line()|.
priority priority of the sign. See priority priority of the sign. See
|sign-priority| for more information. |sign-priority| for more information.
If the optional {dict} is not specified, then it modifies the If the optional {dict} is not specified, then it modifies the
@ -630,35 +631,35 @@ sign_place({id}, {group}, {name}, {buf} [, {dict}])
sign_placelist({list}) *sign_placelist()* sign_placelist({list}) *sign_placelist()*
Place one or more signs. This is similar to the Place one or more signs. This is similar to the
|sign_place()| function. The {list} argument specifies the |sign_place()| function. The {list} argument specifies the
List of signs to place. Each list item is a dict with the List of signs to place. Each list item is a dict with the
following sign attributes: following sign attributes:
buffer Buffer name or number. For the accepted buffer Buffer name or number. For the accepted
values, see |bufname()|. values, see |bufname()|.
group Sign group. {group} functions as a namespace group Sign group. {group} functions as a namespace
for {id}, thus two groups can use the same for {id}, thus two groups can use the same
IDs. If not specified or set to an empty IDs. If not specified or set to an empty
string, then the global group is used. See string, then the global group is used. See
|sign-group| for more information. |sign-group| for more information.
id Sign identifier. If not specified or zero, id Sign identifier. If not specified or zero,
then a new unique identifier is allocated. then a new unique identifier is allocated.
Otherwise the specified number is used. See Otherwise the specified number is used. See
|sign-identifier| for more information. |sign-identifier| for more information.
lnum Line number in the buffer where the sign is to lnum Line number in the buffer where the sign is to
be placed. For the accepted values, see be placed. For the accepted values, see
|line()|. |line()|.
name Name of the sign to place. See |sign_define()| name Name of the sign to place. See |sign_define()|
for more information. for more information.
priority Priority of the sign. When multiple signs are priority Priority of the sign. When multiple signs are
placed on a line, the sign with the highest placed on a line, the sign with the highest
priority is used. If not specified, the priority is used. If not specified, the
default value of 10 is used, unless specified default value of 10 is used, unless specified
otherwise by the sign definition. See otherwise by the sign definition. See
|sign-priority| for more information. |sign-priority| for more information.
If {id} refers to an existing sign, then the existing sign is If {id} refers to an existing sign, then the existing sign is
modified to use the specified {name} and/or {priority}. modified to use the specified {name} and/or {priority}.
Returns a List of sign identifiers. If failed to place a Returns a List of sign identifiers. If failed to place a
sign, the corresponding list item is set to -1. sign, the corresponding list item is set to -1.
Examples: > Examples: >
@ -694,12 +695,12 @@ sign_placelist({list}) *sign_placelist()*
sign_undefine([{name}]) *sign_undefine()* sign_undefine([{name}]) *sign_undefine()*
sign_undefine({list}) sign_undefine({list})
Deletes a previously defined sign {name}. This is similar to Deletes a previously defined sign {name}. This is similar to
the |:sign-undefine| command. If {name} is not supplied, then the |:sign-undefine| command. If {name} is not supplied, then
deletes all the defined signs. deletes all the defined signs.
The one argument {list} can be used to undefine a list of The one argument {list} can be used to undefine a list of
signs. Each list item is the name of a sign. signs. Each list item is the name of a sign.
Returns 0 on success and -1 on failure. For the one argument Returns 0 on success and -1 on failure. For the one argument
{list} call, returns a list of values one for each undefined {list} call, returns a list of values one for each undefined
@ -725,13 +726,13 @@ sign_unplace({group} [, {dict}]) *sign_unplace()*
Remove a previously placed sign in one or more buffers. This Remove a previously placed sign in one or more buffers. This
is similar to the |:sign-unplace| command. is similar to the |:sign-unplace| command.
{group} is the sign group name. To use the global sign group, {group} is the sign group name. To use the global sign group,
use an empty string. If {group} is set to '*', then all the use an empty string. If {group} is set to '*', then all the
groups including the global group are used. groups including the global group are used.
The signs in {group} are selected based on the entries in The signs in {group} are selected based on the entries in
{dict}. The following optional entries in {dict} are {dict}. The following optional entries in {dict} are
supported: supported:
buffer buffer name or number. See |bufname()|. buffer buffer name or number. See |bufname()|.
id sign identifier id sign identifier
If {dict} is not supplied, then all the signs in {group} are If {dict} is not supplied, then all the signs in {group} are
removed. removed.
@ -775,15 +776,15 @@ sign_unplacelist({list}) *sign_unplacelist()*
The {list} argument specifies the List of signs to remove. The {list} argument specifies the List of signs to remove.
Each list item is a dict with the following sign attributes: Each list item is a dict with the following sign attributes:
buffer buffer name or number. For the accepted buffer buffer name or number. For the accepted
values, see |bufname()|. If not specified, values, see |bufname()|. If not specified,
then the specified sign is removed from all then the specified sign is removed from all
the buffers. the buffers.
group sign group name. If not specified or set to an group sign group name. If not specified or set to
empty string, then the global sign group is an empty string, then the global sign group is
used. If set to '*', then all the groups used. If set to '*', then all the groups
including the global group are used. including the global group are used.
id sign identifier. If not specified, then all id sign identifier. If not specified, then all
the signs in the specified group are removed. the signs in the specified group are removed.
Returns a List where an entry is set to 0 if the corresponding Returns a List where an entry is set to 0 if the corresponding

21
runtime/doc/spell.txt
View File

@ -140,7 +140,7 @@ zuG Undo |zW| and |zG|, remove the word from the internal
There are no normal mode commands to mark words as There are no normal mode commands to mark words as
rare as this is a fairly uncommon command and all rare as this is a fairly uncommon command and all
intuitive commands for this are already taken. If you intuitive commands for this are already taken. If you
want you can add mappings with e.g.: > want you can add mappings with e.g.: >
nnoremap z? :exe ':spellrare ' .. expand('<cWORD>')<CR> nnoremap z? :exe ':spellrare ' .. expand('<cWORD>')<CR>
nnoremap z/ :exe ':spellrare! ' .. expand('<cWORD>')<CR> nnoremap z/ :exe ':spellrare! ' .. expand('<cWORD>')<CR>
@ -300,7 +300,7 @@ In a table:
*spell-cjk* *spell-cjk*
Chinese, Japanese and other East Asian characters are normally marked as Chinese, Japanese and other East Asian characters are normally marked as
errors, because spell checking of these characters is not supported. If errors, because spell checking of these characters is not supported. If
'spelllang' includes "cjk", these characters are not marked as errors. This 'spelllang' includes "cjk", these characters are not marked as errors. This
is useful when editing text with spell checking while some Asian words are is useful when editing text with spell checking while some Asian words are
present. present.
@ -507,8 +507,8 @@ Vim uses a binary file format for spelling. This greatly speeds up loading
the word list and keeps it small. the word list and keeps it small.
*.aff* *.dic* *Myspell* *.aff* *.dic* *Myspell*
You can create a Vim spell file from the .aff and .dic files that Myspell You can create a Vim spell file from the .aff and .dic files that Myspell
uses. Myspell is used by OpenOffice.org and Mozilla. The OpenOffice .oxt uses. Myspell is used by OpenOffice.org and Mozilla. The OpenOffice .oxt
files are zip files which contain the .aff and .dic files. You should be able files are zip files which contain the .aff and .dic files. You should be able
to find them here: to find them here:
https://extensions.openoffice.org/en/search@f[0]=field_project_application%253A1&f[1]=field_project_tags%253A94.html https://extensions.openoffice.org/en/search@f[0]=field_project_application%253A1&f[1]=field_project_tags%253A94.html
The older, OpenOffice 2 files may be used if this doesn't work: The older, OpenOffice 2 files may be used if this doesn't work:
@ -842,8 +842,8 @@ starting with an upper-case letter.
When the word includes an upper-case letter, this means the upper-case letter When the word includes an upper-case letter, this means the upper-case letter
is required at this position. The same word with a lower-case letter at this is required at this position. The same word with a lower-case letter at this
position will not match. When some of the other letters are upper-case it will position will not match. When some of the other letters are upper-case it
not match either. will not match either.
The word with all upper-case characters will always be OK, The word with all upper-case characters will always be OK,
@ -1182,9 +1182,10 @@ WORDS WITH A SLASH *spell-SLASH*
The slash is used in the .dic file to separate the basic word from the affix The slash is used in the .dic file to separate the basic word from the affix
letters and other flags. Unfortunately, this means you cannot use a slash in letters and other flags. Unfortunately, this means you cannot use a slash in
a word. Thus "TCP/IP" is not a word but "TCP" with the flags "IP". To include a word. Thus "TCP/IP" is not a word but "TCP" with the flags "IP". To
a slash in the word put a backslash before it: "TCP\/IP". In the rare case include a slash in the word put a backslash before it: "TCP\/IP". In the rare
you want to use a backslash inside a word you need to use two backslashes. case you want to use a backslash inside a word you need to use two
backslashes.
Any other use of the backslash is reserved for future expansion. Any other use of the backslash is reserved for future expansion.
@ -1614,7 +1615,7 @@ CHECKCOMPOUNDTRIPLE (Hunspell) *spell-CHECKCOMPOUNDTRIPLE*
CHECKSHARPS (Hunspell) *spell-CHECKSHARPS* CHECKSHARPS (Hunspell) *spell-CHECKSHARPS*
SS letter pair in uppercased (German) words may be upper case SS letter pair in uppercased (German) words may be upper case
sharp s (ß). Not supported. sharp s (ß). Not supported.
COMPLEXPREFIXES (Hunspell) *spell-COMPLEXPREFIXES* COMPLEXPREFIXES (Hunspell) *spell-COMPLEXPREFIXES*
Enables using two prefixes. Not supported. Enables using two prefixes. Not supported.

4
runtime/doc/sponsor.txt
View File

@ -1,4 +1,4 @@
*sponsor.txt* For Vim version 9.1. Last change: 2025 Aug 10 *sponsor.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -35,7 +35,7 @@ More explanations can be found in the |register-faq|.
VOTE FOR FEATURES *vote-for-features* VOTE FOR FEATURES *vote-for-features*
Note: Voting for features has been discontinued since the passing of |Bram| in Note: Voting for features has been discontinued since the passing of |Bram| in
2023. The following two links still work, but they are no longer updated. So 2023. The following two links still work, but they are no longer updated. So
they now only provide a historic view as of summer 2023. they now only provide a historic view as of summer 2023.
The voting results appear on the results page, which is visible for everybody: The voting results appear on the results page, which is visible for everybody:

30
runtime/doc/starting.txt
View File

@ -1,4 +1,4 @@
*starting.txt* For Vim version 9.1. Last change: 2025 Aug 06 *starting.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -43,8 +43,8 @@ filename One or more file names. The first one will be the current
To avoid a file name starting with a '-' being interpreted as To avoid a file name starting with a '-' being interpreted as
an option, precede the arglist with "--", e.g.: > an option, precede the arglist with "--", e.g.: >
vim -- -filename vim -- -filename
< All arguments after the "--" will be interpreted as file names, < All arguments after the "--" will be interpreted as file
no other options or "+command" argument can follow. names, no other options or "+command" argument can follow.
For behavior of quotes on MS-Windows, see |win32-quotes|. For behavior of quotes on MS-Windows, see |win32-quotes|.
*--* *--*
@ -174,7 +174,7 @@ a slash. Thus "-R" means recovery and "-/R" readonly.
"pat" in the first file being edited (see |pattern| for the "pat" in the first file being edited (see |pattern| for the
available search patterns). The search starts at the cursor available search patterns). The search starts at the cursor
position, which can be the first line or the cursor position position, which can be the first line or the cursor position
last used from |viminfo|. To force a search from the first last used from |viminfo|. To force a search from the first
line use "+1 +/pat". line use "+1 +/pat".
+{command} *-+c* *-c* +{command} *-+c* *-c*
@ -262,7 +262,7 @@ a slash. Thus "-R" means recovery and "-/R" readonly.
shell command, it has only been made difficult. shell command, it has only been made difficult.
*-g* *-g*
-g Start Vim in GUI mode. See |gui|. For the opposite see |-v|. -g Start Vim in GUI mode. See |gui|. For the opposite see |-v|.
*-v* *-v*
-v Start Ex in Vi mode. Only makes a difference when the -v Start Ex in Vi mode. Only makes a difference when the
@ -585,7 +585,7 @@ a slash. Thus "-R" means recovery and "-/R" readonly.
characters are appended. See also |complex-repeat|. characters are appended. See also |complex-repeat|.
{scriptout} cannot start with a digit. {scriptout} cannot start with a digit.
If you want to record what is typed in a human readable form, If you want to record what is typed in a human readable form,
you can use |ch_logfile()|. It adds "raw key input" lines. you can use |ch_logfile()|. It adds "raw key input" lines.
Also see |--log|. Also see |--log|.
*-W* *-W*
@ -830,7 +830,7 @@ accordingly. Vim proceeds in this order:
one that is found is read. one that is found is read.
RECOMMENDATION: Put all your Vim configuration stuff in the RECOMMENDATION: Put all your Vim configuration stuff in the
$HOME/.vim/ directory ($HOME/vimfiles/ for MS-Windows). That makes it $HOME/.vim/ directory ($HOME/vimfiles/ for MS-Windows). That makes it
easy to copy it to another system. easy to copy it to another system.
If Vim was started with "-u filename", the file "filename" is used. If Vim was started with "-u filename", the file "filename" is used.
@ -1089,7 +1089,7 @@ recommended to add these lines somewhere near the top: >
source $VIMRUNTIME/defaults.vim source $VIMRUNTIME/defaults.vim
Then Vim works like before you had a .vimrc. Then Vim works like before you had a .vimrc.
Copying $VIMRUNTIME/vimrc_example.vim to your .vimrc is another way to do Copying $VIMRUNTIME/vimrc_example.vim to your .vimrc is another way to do
this. Alternatively, you can copy defaults.vim to your .vimrc and modify it this. Alternatively, you can copy defaults.vim to your .vimrc and modify it
(but then you won't get updates when it changes). (but then you won't get updates when it changes).
If you don't like some of the defaults, you can still source defaults.vim and If you don't like some of the defaults, you can still source defaults.vim and
@ -1112,8 +1112,8 @@ The specification can be found online at
https://specifications.freedesktop.org/basedir-spec/latest/ https://specifications.freedesktop.org/basedir-spec/latest/
The location of this standard configuration directory is configurable by the The location of this standard configuration directory is configurable by the
user, using an environment variable but should also give fallback in case those user, using an environment variable but should also give fallback in case
variables weren't set. those variables weren't set.
This is not an exhaustive list of those directories: This is not an exhaustive list of those directories:
Environment var Default location Description ~ Environment var Default location Description ~
@ -1129,7 +1129,7 @@ Vim will only use the `$XDG_CONFIG_HOME` directory, the others are not
Vim, on Unix systems, will look at `$XDG_CONFIG_HOME/vim/vimrc` for its Vim, on Unix systems, will look at `$XDG_CONFIG_HOME/vim/vimrc` for its
configuration (see |vimrc|) but it will source it only if no other configuration (see |vimrc|) but it will source it only if no other
initialization file is found in `$HOME` or `$HOME/.vim` (thus making this initialization file is found in `$HOME` or `$HOME/.vim` (thus making this
feature backward compatible). However, if you want to migrate to use feature backward compatible). However, if you want to migrate to use
`$XDG_CONFIG_HOME/vim/` directory, you will have to move away your `~/.vimrc` `$XDG_CONFIG_HOME/vim/` directory, you will have to move away your `~/.vimrc`
and `~/.vim/vimrc` file. and `~/.vim/vimrc` file.
@ -1637,8 +1637,8 @@ has marks for.
*viminfo-file-marks* *viminfo-file-marks*
Uppercase marks ('A to 'Z) are stored when writing the viminfo file. The Uppercase marks ('A to 'Z) are stored when writing the viminfo file. The
numbered marks ('0 to '9) are a bit special. When the viminfo file is written numbered marks ('0 to '9) are a bit special. When the viminfo file is written
(when exiting or with the ":wviminfo" command), '0 is set to the current cursor (when exiting or with the ":wviminfo" command), '0 is set to the current
position and file. The old '0 is moved to '1, '1 to '2, etc. This cursor position and file. The old '0 is moved to '1, '1 to '2, etc. This
resembles what happens with the "1 to "9 delete registers. If the current resembles what happens with the "1 to "9 delete registers. If the current
cursor position is already present in '0 to '9, it is moved to '0, to avoid cursor position is already present in '0 to '9, it is moved to '0, to avoid
having the same position twice. The result is that with "'0", you can jump having the same position twice. The result is that with "'0", you can jump
@ -1738,8 +1738,8 @@ most of the information will be restored).
The information in the file is first read in to make The information in the file is first read in to make
a merge between old and new info. When [!] is used, a merge between old and new info. When [!] is used,
the old information is not read first, only the the old information is not read first, only the
internal info is written. If 'viminfo' is empty, marks internal info is written. If 'viminfo' is empty,
for up to 100 files will be written. marks for up to 100 files will be written.
When you get error "E929: Too many viminfo temp When you get error "E929: Too many viminfo temp
files", check that no old temp files were left behind files", check that no old temp files were left behind
(e.g. ~/.viminf*) and that you can write in the (e.g. ~/.viminf*) and that you can write in the

317
runtime/doc/syntax.txt
View File

@ -380,12 +380,12 @@ Upon loading a file, Vim finds the relevant syntax file as follows:
4. Conversion to HTML *2html.vim* *convert-to-HTML* 4. Conversion to HTML *2html.vim* *convert-to-HTML*
2html is not a syntax file itself, but a script that converts the current 2html is not a syntax file itself, but a script that converts the current
window into HTML. Vim opens a new window in which it builds the HTML file. window into HTML. Vim opens a new window in which it builds the HTML file.
After you save the resulting file, you can view it with any browser. The After you save the resulting file, you can view it with any browser. The
colors should be exactly the same as you see them in Vim. With colors should be exactly the same as you see them in Vim. With
|g:html_line_ids| you can jump to specific lines by adding (for example) #L123 |g:html_line_ids| you can jump to specific lines by adding (for example) #L123
or #123 to the end of the URL in your browser's address bar. And with or #123 to the end of the URL in your browser's address bar. And with
|g:html_dynamic_folds| enabled, you can show or hide the text that is folded |g:html_dynamic_folds| enabled, you can show or hide the text that is folded
in Vim. in Vim.
@ -394,7 +394,7 @@ Source the script to convert the current file: >
:runtime! syntax/2html.vim :runtime! syntax/2html.vim
< <
Many variables affect the output of 2html.vim; see below. Any of the on/off Many variables affect the output of 2html.vim; see below. Any of the on/off
options listed below can be enabled or disabled by setting them explicitly to options listed below can be enabled or disabled by setting them explicitly to
the desired value, or restored to their default by removing the variable using the desired value, or restored to their default by removing the variable using
|:unlet|. |:unlet|.
@ -421,17 +421,17 @@ and last line to be converted. Example, using the last set Visual area: >
< <
*:TOhtml* *:TOhtml*
:[range]TOhtml The ":TOhtml" command is defined in a standard plugin. :[range]TOhtml The ":TOhtml" command is defined in a standard plugin.
This command will source |2html.vim| for you. When a This command will source |2html.vim| for you. When a
range is given, this command sets |g:html_start_line| range is given, this command sets |g:html_start_line|
and |g:html_end_line| to the start and end of the and |g:html_end_line| to the start and end of the
range, respectively. Default range is the entire range, respectively. Default range is the entire
buffer. buffer.
If the current window is part of a |diff|, unless If the current window is part of a |diff|, unless
|g:html_diff_one_file| is set, :TOhtml will convert |g:html_diff_one_file| is set, :TOhtml will convert
all windows which are part of the diff in the current all windows which are part of the diff in the current
tab and place them side-by-side in a <table> element tab and place them side-by-side in a <table> element
in the generated HTML. With |g:html_line_ids| you can in the generated HTML. With |g:html_line_ids| you can
jump to lines in specific windows with (for example) jump to lines in specific windows with (for example)
#W1L42 for line 42 in the first diffed window, or #W1L42 for line 42 in the first diffed window, or
#W3L87 for line 87 in the third. #W3L87 for line 87 in the third.
@ -445,7 +445,7 @@ and last line to be converted. Example, using the last set Visual area: >
*g:html_diff_one_file* *g:html_diff_one_file*
Default: 0. Default: 0.
When 0, and using |:TOhtml| all windows involved in a |diff| in the current tab When 0, and using |:TOhtml| all windows involved in a |diff| in the current tab
page are converted to HTML and placed side-by-side in a <table> element. When page are converted to HTML and placed side-by-side in a <table> element. When
1, only the current buffer is converted. 1, only the current buffer is converted.
Example: > Example: >
@ -465,9 +465,9 @@ not set.
Default: 0. Default: 0.
When 0, display a progress bar in the statusline for each major step in the When 0, display a progress bar in the statusline for each major step in the
2html.vim conversion process. 2html.vim conversion process.
When 1, do not display the progress bar. This offers a minor speed improvement When 1, do not display the progress bar. This offers a minor speed
but you won't have any idea how much longer the conversion might take; for big improvement but you won't have any idea how much longer the conversion might
files it can take a long time! take; for big files it can take a long time!
Example: > Example: >
let g:html_no_progress = 1 let g:html_no_progress = 1
@ -480,17 +480,17 @@ moves through the buffer, switches windows, and the like: >
< <
Note that the -s flag prevents loading your .vimrc and any plugins, so you Note that the -s flag prevents loading your .vimrc and any plugins, so you
need to explicitly source/enable anything that will affect the HTML need to explicitly source/enable anything that will affect the HTML
conversion. See |-E| and |-s-ex| for details. It is probably best to create a conversion. See |-E| and |-s-ex| for details. It is probably best to create a
script to replace all the -c commands and use it with the -u flag instead of script to replace all the -c commands and use it with the -u flag instead of
specifying each command separately. specifying each command separately.
*hl-TOhtmlProgress* *TOhtml-progress-color* *hl-TOhtmlProgress* *TOhtml-progress-color*
When displayed, the progress bar will show colored boxes along the statusline When displayed, the progress bar will show colored boxes along the statusline
as the HTML conversion proceeds. By default, the background color as the as the HTML conversion proceeds. By default, the background color as the
current "DiffDelete" highlight group is used. If "DiffDelete" and "StatusLine" current "DiffDelete" highlight group is used. If "DiffDelete" and "StatusLine"
have the same background color, TOhtml will automatically adjust the color to have the same background color, TOhtml will automatically adjust the color to
differ. If you do not like the automatically selected colors, you can define differ. If you do not like the automatically selected colors, you can define
your own highlight colors for the progress bar. Example: > your own highlight colors for the progress bar. Example: >
hi TOhtmlProgress guifg=#c0ffee ctermbg=7 hi TOhtmlProgress guifg=#c0ffee ctermbg=7
< <
@ -509,11 +509,11 @@ Go back to the default to use 'number' by deleting the variable: >
*g:html_line_ids* *g:html_line_ids*
Default: 1 if |g:html_number_lines| is set, 0 otherwise. Default: 1 if |g:html_number_lines| is set, 0 otherwise.
When 1, adds an HTML id attribute to each line number, or to an empty <span> When 1, adds an HTML id attribute to each line number, or to an empty <span>
inserted for that purpose if no line numbers are shown. This ID attribute inserted for that purpose if no line numbers are shown. This ID attribute
takes the form of L123 for single-buffer HTML pages, or W2L123 for diff-view takes the form of L123 for single-buffer HTML pages, or W2L123 for diff-view
pages, and is used to jump to a specific line (in a specific window of a diff pages, and is used to jump to a specific line (in a specific window of a diff
view). Javascript is inserted to open any closed dynamic folds view). Javascript is inserted to open any closed dynamic folds
(|g:html_dynamic_folds|) containing the specified line before jumping. The (|g:html_dynamic_folds|) containing the specified line before jumping. The
javascript also allows omitting the window ID in the url, and the leading L. javascript also allows omitting the window ID in the url, and the leading L.
For example: > For example: >
@ -527,7 +527,7 @@ For example: >
Default: 1. Default: 1.
When 1, generate valid HTML 5 markup with CSS styling, supported in all modern When 1, generate valid HTML 5 markup with CSS styling, supported in all modern
browsers and many old browsers. browsers and many old browsers.
When 0, generate <font> tags and similar outdated markup. This is not When 0, generate <font> tags and similar outdated markup. This is not
recommended but it may work better in really old browsers, email clients, recommended but it may work better in really old browsers, email clients,
forum posts, and similar situations where basic CSS support is unavailable. forum posts, and similar situations where basic CSS support is unavailable.
Example: > Example: >
@ -549,10 +549,10 @@ included in the generated HTML (unless it is folded): >
*g:html_ignore_folding* *g:html_ignore_folding*
Default: 0. Default: 0.
When 0, text in a closed fold is replaced by the text shown for the fold in When 0, text in a closed fold is replaced by the text shown for the fold in
Vim (|fold-foldtext|). See |g:html_dynamic_folds| if you also want to allow Vim (|fold-foldtext|). See |g:html_dynamic_folds| if you also want to allow
the user to expand the fold as in Vim to see the text inside. the user to expand the fold as in Vim to see the text inside.
When 1, include all text from the buffer in the generated HTML; whether the When 1, include all text from the buffer in the generated HTML; whether the
text is in a fold has no impact at all. |g:html_dynamic_folds| has no effect. text is in a fold has no impact at all. |g:html_dynamic_folds| has no effect.
Either of these commands will ensure that all text in the buffer is included Either of these commands will ensure that all text in the buffer is included
in the generated HTML (unless it is concealed): > in the generated HTML (unless it is concealed): >
@ -576,7 +576,7 @@ This variable is ignored when |g:html_ignore_folding| is set.
Default: 0. Default: 0.
When 0, if |g:html_dynamic_folds| is 1, generate a column of text similar to When 0, if |g:html_dynamic_folds| is 1, generate a column of text similar to
Vim's foldcolumn (|fold-foldcolumn|) the user can click on to toggle folds Vim's foldcolumn (|fold-foldcolumn|) the user can click on to toggle folds
open or closed. The minimum width of the generated text column is the current open or closed. The minimum width of the generated text column is the current
'foldcolumn' setting. 'foldcolumn' setting.
When 1, do not generate this column; instead, hovering the mouse cursor over When 1, do not generate this column; instead, hovering the mouse cursor over
folded text will open the fold as if |g:html_hover_unfold| were set. folded text will open the fold as if |g:html_hover_unfold| were set.
@ -586,10 +586,10 @@ folded text will open the fold as if |g:html_hover_unfold| were set.
*TOhtml-uncopyable-text* *g:html_prevent_copy* *TOhtml-uncopyable-text* *g:html_prevent_copy*
Default: Empty string. Default: Empty string.
This option prevents certain regions of the generated HTML from being copied, This option prevents certain regions of the generated HTML from being copied,
when you select all text in document rendered in a browser and copy it. Useful when you select all text in document rendered in a browser and copy it.
for allowing users to copy-paste only the source text even if a fold column or Useful for allowing users to copy-paste only the source text even if a fold
line numbers are shown in the generated content. Specify regions to be column or line numbers are shown in the generated content. Specify regions to
affected in this way as follows: be affected in this way as follows:
f: fold column f: fold column
n: line numbers (also within fold text) n: line numbers (also within fold text)
t: fold text t: fold text
@ -606,9 +606,9 @@ Default: "none"
If |g:html_prevent_copy| is non-empty, then: If |g:html_prevent_copy| is non-empty, then:
When "all", read-only <input> elements are used in place of normal text for When "all", read-only <input> elements are used in place of normal text for
uncopyable regions. In some browsers, especially older browsers, after uncopyable regions. In some browsers, especially older browsers, after
selecting an entire page and copying the selection, the <input> tags are not selecting an entire page and copying the selection, the <input> tags are not
pasted with the page text. If |g:html_no_invalid| is 0, the <input> tags have pasted with the page text. If |g:html_no_invalid| is 0, the <input> tags have
invalid type; this works in more browsers, but the page will not validate. invalid type; this works in more browsers, but the page will not validate.
Note: This method does NOT work in recent versions of Chrome and equivalent Note: This method does NOT work in recent versions of Chrome and equivalent
browsers; the <input> tags get pasted with the text. browsers; the <input> tags get pasted with the text.
@ -616,23 +616,23 @@ browsers; the <input> tags get pasted with the text.
When "fallback" (default value), the same <input> elements are generated for When "fallback" (default value), the same <input> elements are generated for
older browsers, but newer browsers (detected by CSS feature query) hide the older browsers, but newer browsers (detected by CSS feature query) hide the
<input> elements and instead use generated content in an ::before pseudoelement <input> elements and instead use generated content in an ::before pseudoelement
to display the uncopyable text. This method should work with the largest to display the uncopyable text. This method should work with the largest
number of browsers, both old and new. number of browsers, both old and new.
When "none", the <input> elements are not generated at all. Only the When "none", the <input> elements are not generated at all. Only the
generated-content method is used. This means that old browsers, notably generated-content method is used. This means that old browsers, notably
Internet Explorer, will either copy the text intended not to be copyable, or Internet Explorer, will either copy the text intended not to be copyable, or
the non-copyable text may not appear at all. However, this is the most the non-copyable text may not appear at all. However, this is the most
standards-based method, and there will be much less markup. standards-based method, and there will be much less markup.
*g:html_no_invalid* *g:html_no_invalid*
Default: 0. Default: 0.
When 0, if |g:html_prevent_copy| is non-empty and |g:html_use_input_for_pc| is When 0, if |g:html_prevent_copy| is non-empty and |g:html_use_input_for_pc| is
not "none", an invalid attribute is intentionally inserted into the <input> not "none", an invalid attribute is intentionally inserted into the <input>
element for the uncopyable areas. This prevents pasting the <input> elements element for the uncopyable areas. This prevents pasting the <input> elements
in some applications. Specifically, some versions of Microsoft Word will not in some applications. Specifically, some versions of Microsoft Word will not
paste the <input> elements if they contain this invalid attribute. When 1, no paste the <input> elements if they contain this invalid attribute. When 1, no
invalid markup is inserted, and the generated page should validate. However, invalid markup is inserted, and the generated page should validate. However,
<input> elements may be pasted into some applications and can be difficult to <input> elements may be pasted into some applications and can be difficult to
remove afterward. remove afterward.
@ -641,7 +641,7 @@ Default: 0.
When 0, the only way to open a fold generated by 2html.vim with When 0, the only way to open a fold generated by 2html.vim with
|g:html_dynamic_folds| set, is to click on the generated fold column. |g:html_dynamic_folds| set, is to click on the generated fold column.
When 1, use CSS 2.0 to allow the user to open a fold by moving the mouse When 1, use CSS 2.0 to allow the user to open a fold by moving the mouse
cursor over the displayed fold text. This is useful to allow users with cursor over the displayed fold text. This is useful to allow users with
disabled javascript to view the folded text. disabled javascript to view the folded text.
Note that old browsers (notably Internet Explorer 6) will not support this Note that old browsers (notably Internet Explorer 6) will not support this
@ -654,11 +654,11 @@ they will not be openable without a foldcolumn.
*g:html_id_expr* *g:html_id_expr*
Default: "" Default: ""
Dynamic folding and jumping to line IDs rely on unique IDs within the document Dynamic folding and jumping to line IDs rely on unique IDs within the document
to work. If generated HTML is copied into a larger document, these IDs are no to work. If generated HTML is copied into a larger document, these IDs are no
longer guaranteed to be unique. Set g:html_id_expr to an expression Vim can longer guaranteed to be unique. Set g:html_id_expr to an expression Vim can
evaluate to get a unique string to append to each ID used in a given document, evaluate to get a unique string to append to each ID used in a given document,
so that the full IDs will be unique even when combined with other content in a so that the full IDs will be unique even when combined with other content in a
larger HTML document. Example, to append _ and the buffer number to each ID: > larger HTML document. Example, to append _ and the buffer number to each ID: >
:let g:html_id_expr = '"_" .. bufnr("%")' :let g:html_id_expr = '"_" .. bufnr("%")'
< <
@ -687,11 +687,11 @@ Go back to default, determine wrapping from 'wrap' setting: >
*g:html_no_pre* *g:html_no_pre*
Default: 0. Default: 0.
When 0, buffer text in the generated HTML is surrounded by <pre>...</pre> When 0, buffer text in the generated HTML is surrounded by <pre>...</pre>
tags. Series of whitespace is shown as in Vim without special markup, and tab tags. Series of whitespace is shown as in Vim without special markup, and tab
characters can be included literally (see |g:html_expand_tabs|). characters can be included literally (see |g:html_expand_tabs|).
When 1 (not recommended), the <pre> tags are omitted, and a plain <div> is When 1 (not recommended), the <pre> tags are omitted, and a plain <div> is
used instead. Whitespace is replaced by a series of &nbsp; character used instead. Whitespace is replaced by a series of &nbsp; character
references, and <br> is used to end each line. This is another way to allow references, and <br> is used to end each line. This is another way to allow
text in the generated HTML is wrap (see |g:html_pre_wrap|) which also works in text in the generated HTML is wrap (see |g:html_pre_wrap|) which also works in
old browsers, but may cause noticeable differences between Vim's display and old browsers, but may cause noticeable differences between Vim's display and
the rendered page generated by 2html.vim. the rendered page generated by 2html.vim.
@ -701,8 +701,8 @@ the rendered page generated by 2html.vim.
*g:html_no_doc* *g:html_no_doc*
Default: 0. Default: 0.
When 1 it doesn't generate a full HTML document with a DOCTYPE, <head>, When 1 it doesn't generate a full HTML document with a DOCTYPE, <head>,
<body>, etc. If |g:html_use_css| is enabled (the default) you'll have to <body>, etc. If |g:html_use_css| is enabled (the default) you'll have to
define the CSS manually. The |g:html_dynamic_folds| and |g:html_line_ids| define the CSS manually. The |g:html_dynamic_folds| and |g:html_line_ids|
settings (off by default) also insert some JavaScript. settings (off by default) also insert some JavaScript.
@ -721,9 +721,9 @@ Default: 0 if 'tabstop' is 8, 'expandtab' is 0, 'vartabstop' is not in use,
When 1, <Tab> characters in the buffer text are replaced with an appropriate When 1, <Tab> characters in the buffer text are replaced with an appropriate
number of space characters, or &nbsp; references if |g:html_no_pre| is 1. number of space characters, or &nbsp; references if |g:html_no_pre| is 1.
When 0, if |g:html_no_pre| is 0 or unset, <Tab> characters in the buffer text When 0, if |g:html_no_pre| is 0 or unset, <Tab> characters in the buffer text
are included as-is in the generated HTML. This is useful for when you want to are included as-is in the generated HTML. This is useful for when you want to
allow copy and paste from a browser without losing the actual whitespace in allow copy and paste from a browser without losing the actual whitespace in
the source document. Note that this can easily break text alignment and the source document. Note that this can easily break text alignment and
indentation in the HTML, unless set by default. indentation in the HTML, unless set by default.
Force |2html.vim| to keep <Tab> characters: > Force |2html.vim| to keep <Tab> characters: >
@ -738,14 +738,15 @@ It is highly recommended to set your desired encoding with
If you do not specify an encoding, |2html.vim| uses the preferred IANA name If you do not specify an encoding, |2html.vim| uses the preferred IANA name
for the current value of 'fileencoding' if set, or 'encoding' if not. for the current value of 'fileencoding' if set, or 'encoding' if not.
'encoding' is always used for certain 'buftype' values. 'fileencoding' will be 'encoding' is always used for certain 'buftype' values. 'fileencoding' will
set to match the chosen document encoding. be set to match the chosen document encoding.
Automatic detection works for the encodings mentioned specifically by name in Automatic detection works for the encodings mentioned specifically by name in
|encoding-names|, but TOhtml will only automatically use those encodings with |encoding-names|, but TOhtml will only automatically use those encodings with
wide browser support. However, you can override this to support specific wide browser support. However, you can override this to support specific
encodings that may not be automatically detected by default (see options encodings that may not be automatically detected by default (see options
below). See http://www.iana.org/assignments/character-sets for the IANA names. below). See http://www.iana.org/assignments/character-sets for the IANA
names.
Note: By default all Unicode encodings are converted to UTF-8 with no BOM in Note: By default all Unicode encodings are converted to UTF-8 with no BOM in
the generated HTML, as recommended by W3C: the generated HTML, as recommended by W3C:
@ -756,7 +757,7 @@ the generated HTML, as recommended by W3C:
*g:html_use_encoding* *g:html_use_encoding*
Default: none, uses IANA name for current 'fileencoding' as above. Default: none, uses IANA name for current 'fileencoding' as above.
To overrule all automatic charset detection, set g:html_use_encoding to the To overrule all automatic charset detection, set g:html_use_encoding to the
name of the charset to be used. It is recommended to set this variable to name of the charset to be used. It is recommended to set this variable to
something widely supported, like UTF-8, for anything you will be hosting on a something widely supported, like UTF-8, for anything you will be hosting on a
webserver: > webserver: >
:let g:html_use_encoding = "UTF-8" :let g:html_use_encoding = "UTF-8"
@ -785,10 +786,10 @@ Default: none, autoload/tohtml.vim contains default conversions for encodings
mentioned by name at |encoding-names| and which have wide mentioned by name at |encoding-names| and which have wide
browser support. browser support.
This option allows |2html.vim| to detect the HTML charset for any This option allows |2html.vim| to detect the HTML charset for any
'fileencoding' or 'encoding' which is not detected automatically. You can also 'fileencoding' or 'encoding' which is not detected automatically. You can
use it to override specific existing encoding-charset pairs. For example, also use it to override specific existing encoding-charset pairs. For
TOhtml will by default use UTF-8 for all Unicode/UCS encodings. To use UTF-16 example, TOhtml will by default use UTF-8 for all Unicode/UCS encodings. To
and UTF-32 instead, use: > use UTF-16 and UTF-32 instead, use: >
:let g:html_charset_override = {'ucs-4': 'UTF-32', 'utf-16': 'UTF-16'} :let g:html_charset_override = {'ucs-4': 'UTF-32', 'utf-16': 'UTF-16'}
Note that documents encoded in either UTF-32 or UTF-16 have known Note that documents encoded in either UTF-32 or UTF-16 have known
@ -797,12 +798,12 @@ compatibility problems with some major browsers.
*g:html_font* *g:html_font*
Default: "monospace" Default: "monospace"
You can specify the font or fonts used in the converted document using You can specify the font or fonts used in the converted document using
g:html_font. If this option is set to a string, then the value will be g:html_font. If this option is set to a string, then the value will be
surrounded with single quotes. If this option is set to a list then each list surrounded with single quotes. If this option is set to a list then each list
item is surrounded by single quotes and the list is joined with commas. Either item is surrounded by single quotes and the list is joined with commas.
way, "monospace" is added as the fallback generic family name and the entire Either way, "monospace" is added as the fallback generic family name and the
result used as the font family (using CSS) or font face (if not using CSS). entire result used as the font family (using CSS) or font face (if not using
Examples: > CSS). Examples: >
" font-family: 'Consolas', monospace; " font-family: 'Consolas', monospace;
:let g:html_font = "Consolas" :let g:html_font = "Consolas"
@ -876,9 +877,9 @@ version 2.2.3.
ASSEMBLY *ft-asm-syntax* *ft-asmh8300-syntax* *ft-nasm-syntax* ASSEMBLY *ft-asm-syntax* *ft-asmh8300-syntax* *ft-nasm-syntax*
*ft-masm-syntax* *ft-asm68k-syntax* *fasm.vim* *ft-masm-syntax* *ft-asm68k-syntax* *fasm.vim*
Files matching "*.i" could be Progress or Assembly. If the automatic detection Files matching "*.i" could be Progress or Assembly. If the automatic
doesn't work for you, or you don't edit Progress at all, use this in your detection doesn't work for you, or you don't edit Progress at all, use this in
startup vimrc: > your startup vimrc: >
:let filetype_i = "asm" :let filetype_i = "asm"
Replace "asm" with the type of assembly you use. Replace "asm" with the type of assembly you use.
@ -893,7 +894,7 @@ files are included:
ia64 Intel Itanium 64 ia64 Intel Itanium 64
fasm Flat assembly (http://flatassembler.net) fasm Flat assembly (http://flatassembler.net)
masm Microsoft assembly (.masm files are compiled with masm Microsoft assembly (.masm files are compiled with
Microsoft's Macro Assembler. This is only supported Microsoft's Macro Assembler. This is only supported
for x86, x86_64, ARM and AARCH64 CPU families) for x86, x86_64, ARM and AARCH64 CPU families)
nasm Netwide assembly nasm Netwide assembly
tasm Turbo Assembly (with opcodes 80x86 up to Pentium, and tasm Turbo Assembly (with opcodes 80x86 up to Pentium, and
@ -965,7 +966,7 @@ For Visual Basic use: >
ASYMPTOTE *asy.vim* *ft-asy-syntax* ASYMPTOTE *asy.vim* *ft-asy-syntax*
By default, only basic Asymptote keywords are highlighted. To highlight By default, only basic Asymptote keywords are highlighted. To highlight
extended geometry keywords: > extended geometry keywords: >
:let g:asy_syn_plain = 1 :let g:asy_syn_plain = 1
@ -974,7 +975,7 @@ and for highlighting keywords related to 3D constructions: >
:let g:asy_syn_three = 1 :let g:asy_syn_three = 1
By default, Asymptote-defined colors (e.g: lightblue) are highlighted. To By default, Asymptote-defined colors (e.g: lightblue) are highlighted. To
highlight TeX-defined colors (e.g: BlueViolet) use: > highlight TeX-defined colors (e.g: BlueViolet) use: >
:let g:asy_syn_texcolors = 1 :let g:asy_syn_texcolors = 1
@ -986,8 +987,8 @@ or for Xorg colors (e.g: AliceBlue): >
BAAN *baan.vim* *baan-syntax* BAAN *baan.vim* *baan-syntax*
The baan.vim gives syntax support for BaanC of release BaanIV up to SSA ERP LN The baan.vim gives syntax support for BaanC of release BaanIV up to SSA ERP LN
for both 3 GL and 4 GL programming. Large number of standard defines/constants for both 3 GL and 4 GL programming. Large number of standard
are supported. defines/constants are supported.
Some special violation of coding standards will be signalled when one specify Some special violation of coding standards will be signalled when one specify
in ones |.vimrc|: > in ones |.vimrc|: >
@ -996,7 +997,7 @@ in ones |.vimrc|: >
*baan-folding* *baan-folding*
Syntax folding can be enabled at various levels through the variables Syntax folding can be enabled at various levels through the variables
mentioned below (Set those in your |.vimrc|). The more complex folding on mentioned below (Set those in your |.vimrc|). The more complex folding on
source blocks and SQL can be CPU intensive. source blocks and SQL can be CPU intensive.
To allow any folding and enable folding at function level use: > To allow any folding and enable folding at function level use: >
@ -1009,9 +1010,9 @@ Folding can be enabled for embedded SQL blocks as SELECT, SELECTDO,
SELECTEMPTY, ... The indentation preceding the begin/end keywords has to SELECTEMPTY, ... The indentation preceding the begin/end keywords has to
match (spaces are not considered equal to a tab). > match (spaces are not considered equal to a tab). >
let baan_fold_sql=1 let baan_fold_sql=1
Note: Block folding can result in many small folds. It is suggested to |:set| Note: Block folding can result in many small folds. It is suggested to |:set|
the options 'foldminlines' and 'foldnestmax' in |.vimrc| or use |:setlocal| in the options 'foldminlines' and 'foldnestmax' in |.vimrc| or use |:setlocal| in
.../after/syntax/baan.vim (see |after-directory|). Eg: > .../after/syntax/baan.vim (see |after-directory|). Eg: >
set foldminlines=5 set foldminlines=5
set foldnestmax=6 set foldnestmax=6
@ -1062,7 +1063,7 @@ Variable Highlight ~
*c_syntax_for_h* use C syntax for *.h files instead of C++/ObjC/ObjC++ *c_syntax_for_h* use C syntax for *.h files instead of C++/ObjC/ObjC++
(NOTE: This variable is deprecated and no longer (NOTE: This variable is deprecated and no longer
necessary, as *.h files now default to C, unless the necessary, as *.h files now default to C, unless the
file contains C++ or Objective-C syntax. If the file contains C++ or Objective-C syntax. If the
automated detection fails, the default filetype can automated detection fails, the default filetype can
be adjusted using `g:filetype_h`.) be adjusted using `g:filetype_h`.)
*c_no_if0* don't highlight "#if 0" blocks as comments *c_no_if0* don't highlight "#if 0" blocks as comments
@ -1273,7 +1274,7 @@ variable.
CSV *ft-csv-syntax* CSV *ft-csv-syntax*
If you change the delimiter of a CSV file, its syntax highlighting will no If you change the delimiter of a CSV file, its syntax highlighting will no
longer match the changed file content. You will need to unlet the following longer match the changed file content. You will need to unlet the following
variable: > variable: >
:unlet b:csv_delimiter :unlet b:csv_delimiter
@ -1289,10 +1290,10 @@ Now the syntax engine should determine the newly changed CSV delimiter.
CYNLIB *cynlib.vim* *ft-cynlib-syntax* CYNLIB *cynlib.vim* *ft-cynlib-syntax*
Cynlib files are C++ files that use the Cynlib class library to enable Cynlib files are C++ files that use the Cynlib class library to enable
hardware modelling and simulation using C++. Typically Cynlib files have a .cc hardware modelling and simulation using C++. Typically Cynlib files have a
or a .cpp extension, which makes it very difficult to distinguish them from a .cc or a .cpp extension, which makes it very difficult to distinguish them
normal C++ file. Thus, to enable Cynlib highlighting for .cc files, add this from a normal C++ file. Thus, to enable Cynlib highlighting for .cc files,
line to your .vimrc file: > add this line to your .vimrc file: >
:let cynlib_cyntax_for_cc=1 :let cynlib_cyntax_for_cc=1
@ -1332,9 +1333,9 @@ following variables:
DART *dart.vim* *ft-dart-syntax* DART *dart.vim* *ft-dart-syntax*
Dart is an object-oriented, typed, class defined, garbage collected language Dart is an object-oriented, typed, class defined, garbage collected language
used for developing mobile, desktop, web, and back-end applications. Dart uses used for developing mobile, desktop, web, and back-end applications. Dart
a C-like syntax derived from C, Java, and JavaScript, with features adopted uses a C-like syntax derived from C, Java, and JavaScript, with features
from Smalltalk, Python, Ruby, and others. adopted from Smalltalk, Python, Ruby, and others.
More information about the language and its development environment at the More information about the language and its development environment at the
official Dart language website at https://dart.dev official Dart language website at https://dart.dev
@ -1450,7 +1451,7 @@ Doxygen generates code documentation using a special documentation format
(similar to Javadoc). This syntax script adds doxygen highlighting to c, cpp, (similar to Javadoc). This syntax script adds doxygen highlighting to c, cpp,
idl and php files, and should also work with java. idl and php files, and should also work with java.
There are a few of ways to turn on doxygen formatting. It can be done There are a few of ways to turn on doxygen formatting. It can be done
explicitly or in a modeline by appending '.doxygen' to the syntax of the file. explicitly or in a modeline by appending '.doxygen' to the syntax of the file.
Example: > Example: >
:set syntax=c.doxygen :set syntax=c.doxygen
@ -1558,7 +1559,7 @@ to your startup file.
EUPHORIA *euphoria3.vim* *euphoria4.vim* *ft-euphoria-syntax* EUPHORIA *euphoria3.vim* *euphoria4.vim* *ft-euphoria-syntax*
Two syntax highlighting files exist for Euphoria. One for Euphoria Two syntax highlighting files exist for Euphoria. One for Euphoria
version 3.1.1, which is the default syntax highlighting file, and one for version 3.1.1, which is the default syntax highlighting file, and one for
Euphoria version 4.0.5 or later. Euphoria version 4.0.5 or later.
@ -1584,7 +1585,7 @@ add the following line to your startup file: >
Elixir and Euphoria share the *.ex file extension. If the filetype is Elixir and Euphoria share the *.ex file extension. If the filetype is
specifically set as Euphoria with the g:filetype_euphoria variable, or the specifically set as Euphoria with the g:filetype_euphoria variable, or the
file is determined to be Euphoria based on keywords in the file, then the file is determined to be Euphoria based on keywords in the file, then the
filetype will be set as Euphoria. Otherwise, the filetype will default to filetype will be set as Euphoria. Otherwise, the filetype will default to
Elixir. Elixir.
@ -1644,10 +1645,10 @@ The following file extensions are auto-detected as Elixir file types:
*.ex, *.exs, *.eex, *.leex, *.lock *.ex, *.exs, *.eex, *.leex, *.lock
Elixir and Euphoria share the *.ex file extension. If the filetype is Elixir and Euphoria share the *.ex file extension. If the filetype is
specifically set as Euphoria with the g:filetype_euphoria variable, or the specifically set as Euphoria with the g:filetype_euphoria variable, or the
file is determined to be Euphoria based on keywords in the file, then the file is determined to be Euphoria based on keywords in the file, then the
filetype will be set as Euphoria. Otherwise, the filetype will default to filetype will be set as Euphoria. Otherwise, the filetype will default to
Elixir. Elixir.
@ -1659,12 +1660,12 @@ NOTE: This site currently doesn't work, on Wikipedia is mentioned that
development stopped in 2009. development stopped in 2009.
Syntax highlighting is available for the most common elements of FlexWiki Syntax highlighting is available for the most common elements of FlexWiki
syntax. The associated ftplugin script sets some buffer-local options to make syntax. The associated ftplugin script sets some buffer-local options to make
editing FlexWiki pages more convenient. FlexWiki considers a newline as the editing FlexWiki pages more convenient. FlexWiki considers a newline as the
start of a new paragraph, so the ftplugin sets 'tw'=0 (unlimited line length), start of a new paragraph, so the ftplugin sets 'tw'=0 (unlimited line length),
'wrap' (wrap long lines instead of using horizontal scrolling), 'linebreak' 'wrap' (wrap long lines instead of using horizontal scrolling), 'linebreak'
(to wrap at a character in 'breakat' instead of at the last char on screen), (to wrap at a character in 'breakat' instead of at the last char on screen),
and so on. It also includes some keymaps that are disabled by default. and so on. It also includes some keymaps that are disabled by default.
If you want to enable the keymaps that make "j" and "k" and the cursor keys If you want to enable the keymaps that make "j" and "k" and the cursor keys
move up and down by display lines, add this to your .vimrc: > move up and down by display lines, add this to your .vimrc: >
@ -1725,7 +1726,7 @@ edit F# or Fortran at all, use this in your startup vimrc: >
FORTRAN *fortran.vim* *ft-fortran-syntax* FORTRAN *fortran.vim* *ft-fortran-syntax*
Default highlighting and dialect ~ Default highlighting and dialect ~
Vim highlights according to Fortran 2023 (the most recent standard). This Vim highlights according to Fortran 2023 (the most recent standard). This
choice should be appropriate for most users most of the time because Fortran choice should be appropriate for most users most of the time because Fortran
2023 is almost a superset of previous versions (Fortran 2018, 2008, 2003, 95, 2023 is almost a superset of previous versions (Fortran 2018, 2008, 2003, 95,
90, 77, and 66). A few legacy constructs deleted or declared obsolescent, 90, 77, and 66). A few legacy constructs deleted or declared obsolescent,
@ -1750,21 +1751,21 @@ in your .vimrc prior to the :syntax on command.
If the form of the source code depends, in a non-standard way, upon the file If the form of the source code depends, in a non-standard way, upon the file
extension, then it is most convenient to set fortran_free_source in a ftplugin extension, then it is most convenient to set fortran_free_source in a ftplugin
file. For more information on ftplugin files, see |ftplugin|. Note that this file. For more information on ftplugin files, see |ftplugin|. Note that this
will work only if the "filetype plugin indent on" command precedes the "syntax will work only if the "filetype plugin indent on" command precedes the "syntax
on" command in your .vimrc file. on" command in your .vimrc file.
When you edit an existing Fortran file, the syntax script will assume free When you edit an existing Fortran file, the syntax script will assume free
source form if the fortran_free_source variable has been set, and assumes source form if the fortran_free_source variable has been set, and assumes
fixed source form if the fortran_fixed_source variable has been set. Suppose fixed source form if the fortran_fixed_source variable has been set. Suppose
neither of these variables have been set. In that case, the syntax script neither of these variables have been set. In that case, the syntax script
attempts to determine which source form has been used by examining the file attempts to determine which source form has been used by examining the file
extension using conventions common to the ifort, gfortran, Cray, NAG, and extension using conventions common to the ifort, gfortran, Cray, NAG, and
PathScale compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08 PathScale compilers (.f, .for, .f77 for fixed-source, .f90, .f95, .f03, .f08
for free-source). No default is used for the .fpp and .ftn file extensions for free-source). No default is used for the .fpp and .ftn file extensions
because different compilers treat them differently. If none of this works, because different compilers treat them differently. If none of this works,
then the script examines the first five columns of the first 500 lines of your then the script examines the first five columns of the first 500 lines of your
file. If no signs of free source form are detected, then the file is assumed file. If no signs of free source form are detected, then the file is assumed
to be in fixed source form. The algorithm should work in the vast majority of to be in fixed source form. The algorithm should work in the vast majority of
cases. In some cases, such as a file that begins with 500 or more full-line cases. In some cases, such as a file that begins with 500 or more full-line
comments, the script may incorrectly decide that the code is in fixed form. comments, the script may incorrectly decide that the code is in fixed form.
@ -1809,8 +1810,8 @@ fortran_fold in your .vimrc with a command such as >
to instruct the syntax script to define fold regions for program units, that to instruct the syntax script to define fold regions for program units, that
is main programs starting with a program statement, subroutines, function is main programs starting with a program statement, subroutines, function
subprograms, modules, submodules, blocks of comment lines, and block data subprograms, modules, submodules, blocks of comment lines, and block data
units. Block, interface, associate, critical, type definition, and change team units. Block, interface, associate, critical, type definition, and change
constructs will also be folded. If you also set the variable team constructs will also be folded. If you also set the variable
fortran_fold_conditionals with a command such as > fortran_fold_conditionals with a command such as >
:let fortran_fold_conditionals=1 :let fortran_fold_conditionals=1
then fold regions will also be defined for do loops, if blocks, select case, then fold regions will also be defined for do loops, if blocks, select case,
@ -2291,7 +2292,7 @@ JSON *json.vim* *ft-json-syntax* *g:vim_json_conceal*
*g:vim_json_warnings* *g:vim_json_warnings*
The json syntax file provides syntax highlighting with conceal support by The json syntax file provides syntax highlighting with conceal support by
default. To disable concealment: > default. To disable concealment: >
let g:vim_json_conceal = 0 let g:vim_json_conceal = 0
To disable syntax highlighting of errors: > To disable syntax highlighting of errors: >
@ -2447,7 +2448,7 @@ instead, and the name of your source file should be *.pike
LUA *lua.vim* *ft-lua-syntax* LUA *lua.vim* *ft-lua-syntax*
The Lua syntax file can be used for versions 4.0, 5.0+. You can select one of The Lua syntax file can be used for versions 4.0, 5.0+. You can select one of
these versions using the global variables |g:lua_version| and these versions using the global variables |g:lua_version| and
|g:lua_subversion|. |g:lua_subversion|.
@ -2455,9 +2456,9 @@ these versions using the global variables |g:lua_version| and
MAIL *mail.vim* *ft-mail.vim* MAIL *mail.vim* *ft-mail.vim*
Vim highlights all the standard elements of an email (headers, signatures, Vim highlights all the standard elements of an email (headers, signatures,
quoted text and URLs / email addresses). In keeping with standard conventions, quoted text and URLs / email addresses). In keeping with standard
signatures begin in a line containing only "--" followed optionally by conventions, signatures begin in a line containing only "--" followed
whitespaces and end with a newline. optionally by whitespaces and end with a newline.
Vim treats lines beginning with ']', '}', '|', '>' or a word followed by '>' Vim treats lines beginning with ']', '}', '|', '>' or a word followed by '>'
as quoted text. However Vim highlights headers and signatures in quoted text as quoted text. However Vim highlights headers and signatures in quoted text
@ -2498,8 +2499,9 @@ MAPLE *maple.vim* *ft-maple-syntax*
Maple V, by Waterloo Maple Inc, supports symbolic algebra. The language Maple V, by Waterloo Maple Inc, supports symbolic algebra. The language
supports many packages of functions which are selectively loaded by the user. supports many packages of functions which are selectively loaded by the user.
The standard set of packages' functions as supplied in Maple V release 4 may be The standard set of packages' functions as supplied in Maple V release 4 may
highlighted at the user's discretion. Users may place in their .vimrc file: > be highlighted at the user's discretion. Users may place in their .vimrc
file: >
:let mvpkg_all= 1 :let mvpkg_all= 1
@ -2553,13 +2555,13 @@ have the following in your .vimrc: >
MBSYNC *mbsync.vim* *ft-mbsync-syntax* MBSYNC *mbsync.vim* *ft-mbsync-syntax*
The mbsync application uses a configuration file to setup mailboxes names, The mbsync application uses a configuration file to setup mailboxes names,
user and password. All files ending with `.mbsyncrc` or with the name user and password. All files ending with `.mbsyncrc` or with the name
`isyncrc` will be recognized as mbsync configuration files. `isyncrc` will be recognized as mbsync configuration files.
MEDIAWIKI *ft-mediawiki-syntax* MEDIAWIKI *ft-mediawiki-syntax*
By default, syntax highlighting includes basic HTML tags like style and By default, syntax highlighting includes basic HTML tags like style and
headers |html.vim|. For strict Mediawiki syntax highlighting: > headers |html.vim|. For strict Mediawiki syntax highlighting: >
let g:html_no_rendering = 1 let g:html_no_rendering = 1
@ -2587,7 +2589,7 @@ The syntax for a dialect tag comment is: >
m2pim = 'm2pim', m2iso = 'm2iso', m2r10 = 'm2r10' m2pim = 'm2pim', m2iso = 'm2iso', m2r10 = 'm2r10'
A dialect tag comment is recognised by Vim if it occurs within the first 200 A dialect tag comment is recognised by Vim if it occurs within the first 200
lines of the source file. Only the very first such comment is recognised, any lines of the source file. Only the very first such comment is recognised, any
additional dialect tag comments are ignored. additional dialect tag comments are ignored.
Example: > Example: >
@ -2792,7 +2794,7 @@ To do so, set the *g:filetype_md* var: >
:let g:filetype_md = 'pandoc' :let g:filetype_md = 'pandoc'
The pandoc syntax plugin uses |conceal| for pretty highlighting. Default is 1 > The pandoc syntax plugin uses |conceal| for pretty highlighting. Default is 1 >
:let g:pandoc#syntax#conceal#use = 1 :let g:pandoc#syntax#conceal#use = 1
@ -2821,8 +2823,8 @@ This is a list of the rules which can be used here:
- inlinecode - inlinecode
- inlinemath - inlinemath
You can customize the way concealing works. For example, if you prefer to mark You can customize the way concealing works. For example, if you prefer to
footnotes with the `*` symbol: > mark footnotes with the `*` symbol: >
:let g:pandoc#syntax#conceal#cchar_overrides = {"footnote" : "*"} :let g:pandoc#syntax#conceal#cchar_overrides = {"footnote" : "*"}
@ -2842,8 +2844,8 @@ specified. Default = 1 >
:let g:pandoc#syntax#codeblocks#embeds#use = 1 :let g:pandoc#syntax#codeblocks#embeds#use = 1
For specify what languages and using what syntax files to highlight embeds. For specify what languages and using what syntax files to highlight embeds.
This is a list of language names. When the language pandoc and vim use don't This is a list of language names. When the language pandoc and vim use don't
match, you can use the "PANDOC=VIM" syntax. For example: > match, you can use the "PANDOC=VIM" syntax. For example: >
:let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"] :let g:pandoc#syntax#codeblocks#embeds#langs = ["ruby", "bash=sh"]
@ -2858,8 +2860,8 @@ To add underline subscript, superscript and strikeout text styles. Default = 1 >
:let g:pandoc#syntax#style#underline_special = 1 :let g:pandoc#syntax#style#underline_special = 1
Detect and highlight definition lists. Disabling this can improve performance. Detect and highlight definition lists. Disabling this can improve
Default = 1 (i.e., enabled by default) > performance. Default = 1 (i.e., enabled by default) >
:let g:pandoc#syntax#style#use_definition_lists = 1 :let g:pandoc#syntax#style#use_definition_lists = 1
@ -2867,7 +2869,7 @@ The pandoc syntax script also comes with the following commands: >
:PandocHighlight LANG :PandocHighlight LANG
Enables embedded highlighting for language LANG in codeblocks. Uses the Enables embedded highlighting for language LANG in codeblocks. Uses the
syntax for items in g:pandoc#syntax#codeblocks#embeds#langs. > syntax for items in g:pandoc#syntax#codeblocks#embeds#langs. >
:PandocUnhighlight LANG :PandocUnhighlight LANG
@ -3280,7 +3282,7 @@ commands than are actually available to you by the game.
R *r.vim* *ft-r-syntax* R *r.vim* *ft-r-syntax*
The parsing of R code for syntax highlight starts 40 lines backwards, but you The parsing of R code for syntax highlight starts 40 lines backwards, but you
can set a different value in your |vimrc|. Example: > can set a different value in your |vimrc|. Example: >
let r_syntax_minlines = 60 let r_syntax_minlines = 60
You can also turn off syntax highlighting of ROxygen: > You can also turn off syntax highlighting of ROxygen: >
@ -3306,9 +3308,9 @@ To highlight R code in knitr chunk headers: >
let rmd_syn_hl_chunk = 1 let rmd_syn_hl_chunk = 1
By default, chunks of R code will be highlighted following the rules of R By default, chunks of R code will be highlighted following the rules of R
language. Moreover, whenever the buffer is saved, Vim scans the buffer and language. Moreover, whenever the buffer is saved, Vim scans the buffer and
highlights other languages if they are present in new chunks. LaTeX code also highlights other languages if they are present in new chunks. LaTeX code also
is automatically recognized and highlighted when the buffer is saved. This is automatically recognized and highlighted when the buffer is saved. This
behavior can be controlled with the variables `rmd_dynamic_fenced_languages`, behavior can be controlled with the variables `rmd_dynamic_fenced_languages`,
and `rmd_include_latex` whose valid values are: > and `rmd_include_latex` whose valid values are: >
let rmd_dynamic_fenced_languages = 0 " No autodetection of languages let rmd_dynamic_fenced_languages = 0 " No autodetection of languages
@ -3331,10 +3333,10 @@ To highlight R code in knitr chunk headers, add to your |vimrc|: >
RASI *rasi.vim* *ft-rasi-syntax* RASI *rasi.vim* *ft-rasi-syntax*
Rasi stands for Rofi Advanced Style Information. It is used by the program Rasi stands for Rofi Advanced Style Information. It is used by the program
rofi to style the rendering of the search window. The language is heavily rofi to style the rendering of the search window. The language is heavily
inspired by CSS stylesheet. Files with the following extensions are recognized inspired by CSS stylesheet. Files with the following extensions are
as rasi files: .rasi. recognized as rasi files: .rasi.
READLINE *readline.vim* *ft-readline-syntax* READLINE *readline.vim* *ft-readline-syntax*
@ -3686,7 +3688,7 @@ the following line in your .vimrc: >
Sh: EMBEDDING LANGUAGES~ Sh: EMBEDDING LANGUAGES~
You may wish to embed languages into sh. I'll give an example courtesy of You may wish to embed languages into sh. I'll give an example courtesy of
Lorance Stinson on how to do this with awk as an example. Put the following Lorance Stinson on how to do this with awk as an example. Put the following
file into $HOME/.vim/after/syntax/sh/awkembed.vim: > file into $HOME/.vim/after/syntax/sh/awkembed.vim: >
" AWK Embedding: " AWK Embedding:
@ -3783,7 +3785,7 @@ to a larger number: >
This will make the syntax synchronization start 1000 lines before the first This will make the syntax synchronization start 1000 lines before the first
displayed line. If you set "tcsh_minlines" to "fromstart", then displayed line. If you set "tcsh_minlines" to "fromstart", then
synchronization is done from the start of the file. The default value for synchronization is done from the start of the file. The default value for
tcsh_minlines is 100. The disadvantage of using a larger number is that tcsh_minlines is 100. The disadvantage of using a larger number is that
redrawing can become slow. redrawing can become slow.
@ -3992,7 +3994,7 @@ substitution will not be made.
*g:tex_isk* *g:tex_stylish* *g:tex_isk* *g:tex_stylish*
Tex: Controlling iskeyword~ Tex: Controlling iskeyword~
Normally, LaTeX keywords support 0-9, a-z, A-z, and 192-255 only. Latex Normally, LaTeX keywords support 0-9, a-z, A-z, and 192-255 only. Latex
keywords don't support the underscore - except when in *.sty files. The keywords don't support the underscore - except when in *.sty files. The
syntax highlighting script handles this with the following logic: syntax highlighting script handles this with the following logic:
@ -4045,7 +4047,8 @@ syntax highlighting script handles this with the following logic:
< If you don't want matching to occur inside bold and italicized < If you don't want matching to occur inside bold and italicized
regions, > regions, >
let g:tex_excludematcher= 1 let g:tex_excludematcher= 1
< will prevent the texMatcher group from being included in those regions. < will prevent the texMatcher group from being included in those
regions.
TF *tf.vim* *ft-tf-syntax* TF *tf.vim* *ft-tf-syntax*
@ -4063,7 +4066,7 @@ There is one option to control the TypeScript syntax highlighting.
*g:typescript_host_keyword* *g:typescript_host_keyword*
When this variable is set to 1, host-specific APIs such as `addEventListener` When this variable is set to 1, host-specific APIs such as `addEventListener`
are highlighted. To disable set it to zero in your .vimrc: > are highlighted. To disable set it to zero in your .vimrc: >
let g:typescript_host_keyword = 0 let g:typescript_host_keyword = 0
< <
@ -4073,8 +4076,8 @@ TYPST *ft-typst-syntax*
*g:typst_embedded_languages* *g:typst_embedded_languages*
Typst files can embed syntax highlighting for other languages by setting the Typst files can embed syntax highlighting for other languages by setting the
|g:typst_embedded_languages| variable. This variable is a list of language |g:typst_embedded_languages| variable. This variable is a list of language
names whose syntax definitions will be included in Typst files. Example: > names whose syntax definitions will be included in Typst files. Example: >
let g:typst_embedded_languages = ['python', 'r'] let g:typst_embedded_languages = ['python', 'r']
@ -4167,8 +4170,8 @@ using Neovim), set >
WDL *wdl.vim* *wdl-syntax* WDL *wdl.vim* *wdl-syntax*
The Workflow Description Language is a way to specify data processing workflows The Workflow Description Language is a way to specify data processing
with a human-readable and writeable syntax. This is used a lot in workflows with a human-readable and writeable syntax. This is used a lot in
bioinformatics. More info on the spec can be found here: bioinformatics. More info on the spec can be found here:
https://github.com/openwdl/wdl https://github.com/openwdl/wdl
@ -4236,11 +4239,11 @@ YAML *yaml.vim* *ft-yaml-syntax*
*g:yaml_schema* *b:yaml_schema* *g:yaml_schema* *b:yaml_schema*
A YAML schema is a combination of a set of tags and a mechanism for resolving A YAML schema is a combination of a set of tags and a mechanism for resolving
non-specific tags. For user this means that YAML parser may, depending on non-specific tags. For user this means that YAML parser may, depending on
plain scalar contents, treat plain scalar (which can actually be only string plain scalar contents, treat plain scalar (which can actually be only string
and nothing else) as a value of the other type: null, boolean, floating-point, and nothing else) as a value of the other type: null, boolean, floating-point,
integer. `g:yaml_schema` option determines according to which schema values integer. `g:yaml_schema` option determines according to which schema values
will be highlighted specially. Supported schemas are will be highlighted specially. Supported schemas are
Schema Description ~ Schema Description ~
failsafe No additional highlighting. failsafe No additional highlighting.
@ -4690,7 +4693,7 @@ concealends *:syn-concealends*
When the "concealends" argument is given, the start and end matches of When the "concealends" argument is given, the start and end matches of
the region, but not the contents of the region, are marked as concealable. the region, but not the contents of the region, are marked as concealable.
Whether or not they are actually concealed depends on the setting on the Whether or not they are actually concealed depends on the setting on the
'conceallevel' option. The ends of a region can only be concealed separately 'conceallevel' option. The ends of a region can only be concealed separately
in this way when they have their own highlighting via "matchgroup". The in this way when they have their own highlighting via "matchgroup". The
|synconcealed()| function can be used to retrieve information about conealed |synconcealed()| function can be used to retrieve information about conealed
items. items.
@ -4974,7 +4977,7 @@ IMPLICIT CONCEAL *:syn-conceal-implicit*
:sy[ntax] conceal [on|off] :sy[ntax] conceal [on|off]
This defines if the following ":syntax" commands will define keywords, This defines if the following ":syntax" commands will define keywords,
matches or regions with the "conceal" flag set. After ":syn conceal matches or regions with the "conceal" flag set. After ":syn conceal
on", all subsequent ":syn keyword", ":syn match" or ":syn region" on", all subsequent ":syn keyword", ":syn match" or ":syn region"
defined will have the "conceal" flag set implicitly. ":syn conceal defined will have the "conceal" flag set implicitly. ":syn conceal
off" returns to the normal state where the "conceal" flag must be off" returns to the normal state where the "conceal" flag must be
@ -5476,8 +5479,9 @@ of colors by using the `:colorscheme` command, for example: >
< In case g:colors_name has not been defined :colo will < In case g:colors_name has not been defined :colo will
output "default". Its palette is defined in the file output "default". Its palette is defined in the file
"$VIMRUNTIME/syntax/syncolor.vim" and is based on "$VIMRUNTIME/syntax/syncolor.vim" and is based on
legacy versions of peachpuff and desert. When compiled legacy versions of peachpuff and desert. When
without the |+eval| feature it will output "unknown". compiled without the |+eval| feature it will output
"unknown".
:colo[rscheme] {name} Load color scheme {name}. This searches 'runtimepath' :colo[rscheme] {name} Load color scheme {name}. This searches 'runtimepath'
for the file "colors/{name}.vim". The first one that for the file "colors/{name}.vim". The first one that
@ -5575,7 +5579,7 @@ in their own color.
:hi[ghlight] [default] {group-name} {key}={arg} ... :hi[ghlight] [default] {group-name} {key}={arg} ...
Add a highlight group, or change the highlighting for Add a highlight group, or change the highlighting for
an existing group. If a given color name is not an existing group. If a given color name is not
recognized, each `colors/lists/default.vim` found on recognized, each `colors/lists/default.vim` found on
'runtimepath' will be loaded. 'runtimepath' will be loaded.
See |highlight-args| for the {key}={arg} arguments. See |highlight-args| for the {key}={arg} arguments.
@ -5610,7 +5614,7 @@ also tell where it was last set. Example: >
Last set from /home/mool/vim/vim7/runtime/syntax/syncolor.vim ~ Last set from /home/mool/vim/vim7/runtime/syntax/syncolor.vim ~
When ":hi clear" is used then the script where this command is used will be When ":hi clear" is used then the script where this command is used will be
mentioned for the default values. See |:verbose-cmd| for more information. mentioned for the default values. See |:verbose-cmd| for more information.
*highlight-args* *E416* *E417* *E423* *highlight-args* *E416* *E417* *E423*
There are three types of terminals for highlighting: There are three types of terminals for highlighting:
@ -5811,9 +5815,9 @@ ctermul={color-nr} *highlight-ctermul*
"fg" and "bg" colors will not be adjusted. "fg" and "bg" colors will not be adjusted.
ctermfont={font-nr} *highlight-ctermfont* ctermfont={font-nr} *highlight-ctermfont*
This gives the alternative font number to use in the terminal. The This gives the alternative font number to use in the terminal. The
available fonts depend on the terminal, and if the terminal is not set available fonts depend on the terminal, and if the terminal is not set
up for alternative fonts this simply won't do anything. The range of up for alternative fonts this simply won't do anything. The range of
{font-nr} is 0-10 where 0 resets the font to the default font, 1-9 {font-nr} is 0-10 where 0 resets the font to the default font, 1-9
selects one of the 9 alternate fonts, and 10 selects the Fraktur font. selects one of the 9 alternate fonts, and 10 selects the Fraktur font.
For more information see your terminal's handling of SGR parameters For more information see your terminal's handling of SGR parameters
@ -5907,10 +5911,10 @@ guisp={color-name} *highlight-guisp*
colorscheme alt colorscheme alt
< <
If you want to develop a color list that can be relied on by others, If you want to develop a color list that can be relied on by others,
it is best to prefix your color names. By convention these color lists it is best to prefix your color names. By convention these color
are placed in the colors/lists directory. You can see an example in lists are placed in the colors/lists directory. You can see an
'$VIMRUNTIME/colors/lists/csscolors.vim'. This list would be sourced example in '$VIMRUNTIME/colors/lists/csscolors.vim'. This list would
by a color scheme using: > be sourced by a color scheme using: >
:runtime colors/lists/csscolors.vim :runtime colors/lists/csscolors.vim
:highlight Comment guifg=css_turquoise :highlight Comment guifg=css_turquoise
@ -5936,7 +5940,8 @@ lCursor Character under the cursor when |language-mapping|
*hl-CursorIM* *hl-CursorIM*
CursorIM Like Cursor, but used when in IME mode. |CursorIM| CursorIM Like Cursor, but used when in IME mode. |CursorIM|
*hl-CursorColumn* *hl-CursorColumn*
CursorColumn Screen column that the cursor is in when 'cursorcolumn' is set. CursorColumn Screen column that the cursor is in when 'cursorcolumn' is
set.
*hl-CursorLine* *hl-CursorLine*
CursorLine Screen line that the cursor is in when 'cursorline' is set. CursorLine Screen line that the cursor is in when 'cursorline' is set.
*hl-Directory* *hl-Directory*
@ -6022,10 +6027,10 @@ PmenuSbar Popup menu: Scrollbar.
*hl-PmenuThumb* *hl-PmenuThumb*
PmenuThumb Popup menu: Thumb of the scrollbar. PmenuThumb Popup menu: Thumb of the scrollbar.
*hl-PmenuMatch* *hl-PmenuMatch*
PmenuMatch Popup menu: Matched text in normal item. Applied in PmenuMatch Popup menu: Matched text in normal item. Applied in
combination with |hl-Pmenu|. combination with |hl-Pmenu|.
*hl-PmenuMatchSel* *hl-PmenuMatchSel*
PmenuMatchSel Popup menu: Matched text in selected item. Applied in PmenuMatchSel Popup menu: Matched text in selected item. Applied in
combination with |hl-PmenuSel|. combination with |hl-PmenuSel|.
*hl-PmenuBorder* *hl-PmenuBorder*
PmenuBorder Popup menu: Border characters. PmenuBorder Popup menu: Border characters.
@ -6328,12 +6333,12 @@ And put these lines in your .vimrc: >
============================================================================== ==============================================================================
18. Window-local syntax *:ownsyntax* 18. Window-local syntax *:ownsyntax*
Normally all windows on a buffer share the same syntax settings. It is Normally all windows on a buffer share the same syntax settings. It is
possible, however, to set a particular window on a file to have its own possible, however, to set a particular window on a file to have its own
private syntax setting. A possible example would be to edit LaTeX source private syntax setting. A possible example would be to edit LaTeX source
with conventional highlighting in one window, while seeing the same source with conventional highlighting in one window, while seeing the same source
highlighted differently (so as to hide control sequences and indicate bold, highlighted differently (so as to hide control sequences and indicate bold,
italic etc regions) in another. The 'scrollbind' option is useful here. italic etc regions) in another. The 'scrollbind' option is useful here.
To set the current window to have the syntax "foo", separately from all other To set the current window to have the syntax "foo", separately from all other
windows on the buffer: > windows on the buffer: >
@ -6348,7 +6353,7 @@ Note: This resets the 'spell', 'spellcapcheck', 'spellfile' and 'spelloptions'
options. options.
Once a window has its own syntax, syntax commands executed from other windows Once a window has its own syntax, syntax commands executed from other windows
on the same buffer (including :syntax clear) have no effect. Conversely, on the same buffer (including :syntax clear) have no effect. Conversely,
syntax commands executed from that window do not affect other windows on the syntax commands executed from that window do not affect other windows on the
same buffer. same buffer.
@ -6533,7 +6538,7 @@ it took to match them against the text.
current window. Use a wider display to see more of current window. Use a wider display to see more of
the output. the output.
The list is sorted by total time. The columns are: The list is sorted by total time. The columns are:
TOTAL Total time in seconds spent on TOTAL Total time in seconds spent on
matching this pattern. matching this pattern.
COUNT Number of times the pattern was used. COUNT Number of times the pattern was used.

6
runtime/doc/tabpage.txt
View File

@ -1,4 +1,4 @@
*tabpage.txt* For Vim version 9.1. Last change: 2025 Aug 06 *tabpage.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -145,7 +145,7 @@ something else.
:tabclose $ " close the last tab page :tabclose $ " close the last tab page
:tabclose # " close the last accessed tab page :tabclose # " close the last accessed tab page
When a tab page is closed the next tab page will become the current one. This When a tab page is closed the next tab page will become the current one. This
behaviour can be customized using the 'tabclose' option. behaviour can be customized using the 'tabclose' option.
*:tabo* *:tabonly* *:tabo* *:tabonly*
@ -277,7 +277,7 @@ REORDERING TAB PAGES:
Note that although it is possible to move a tab page behind the N-th one by Note that although it is possible to move a tab page behind the N-th one by
using :Ntabmove. And move it by N places by using :+Ntabmove. For using :Ntabmove. And move it by N places by using :+Ntabmove. For
clarification what +N means in this context see |[range]|. clarification what +N means in this context see |[range]|.

27
runtime/doc/tagsrch.txt
View File

@ -1,4 +1,4 @@
*tagsrch.txt* For Vim version 9.1. Last change: 2025 May 01 *tagsrch.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -44,7 +44,7 @@ below.
{name} can be a regexp pattern, see |tag-regexp|. {name} can be a regexp pattern, see |tag-regexp|.
When there are several matching tags for {name}, jump When there are several matching tags for {name}, jump
to the [count] one. When [count] is omitted the to the [count] one. When [count] is omitted the
first one is jumped to. See |tag-matchlist| for first one is jumped to. See |tag-matchlist| for
jumping to other matching tags. jumping to other matching tags.
g<LeftMouse> *g<LeftMouse>* g<LeftMouse> *g<LeftMouse>*
@ -54,7 +54,7 @@ CTRL-] Jump to the definition of the keyword under the
keyword under or after cursor. keyword under or after cursor.
When there are several matching tags for {name}, jump When there are several matching tags for {name}, jump
to the [count] one. When no [count] is given the to the [count] one. When no [count] is given the
first one is jumped to. See |tag-matchlist| for first one is jumped to. See |tag-matchlist| for
jumping to other matching tags. jumping to other matching tags.
*v_CTRL-]* *v_CTRL-]*
@ -103,7 +103,7 @@ The ignore-case matches are found when:
Note that using ignore-case tag searching disables binary searching in the Note that using ignore-case tag searching disables binary searching in the
tags file, which causes a slowdown. This can be avoided by fold-case sorting tags file, which causes a slowdown. This can be avoided by fold-case sorting
the tag file. See the 'tagbsearch' option for an explanation. the tag file. See the 'tagbsearch' option for an explanation.
============================================================================== ==============================================================================
2. Tag stack *tag-stack* *tagstack* *E425* 2. Tag stack *tag-stack* *tagstack* *E425*
@ -182,7 +182,7 @@ commands explained above the tag stack will look like this:
1 1 main 1 harddisk2:text/vim/test 1 1 main 1 harddisk2:text/vim/test
2 1 FuncB 59 harddisk2:text/vim/src/main.c 2 1 FuncB 59 harddisk2:text/vim/src/main.c
The |gettagstack()| function returns the tag stack of a specified window. The The |gettagstack()| function returns the tag stack of a specified window. The
|settagstack()| function modifies the tag stack of a window. |settagstack()| function modifies the tag stack of a window.
*tagstack-examples* *tagstack-examples*
@ -308,7 +308,7 @@ g CTRL-] Like CTRL-], but use ":tjump" instead of ":tag".
not given, the last tag name from the tag stack is not given, the last tag name from the tag stack is
used. The search pattern to locate the tag line is used. The search pattern to locate the tag line is
prefixed with "\V" to escape all the special prefixed with "\V" to escape all the special
characters (very nomagic). The location list showing characters (very nomagic). The location list showing
the matching tags is independent of the tag stack. the matching tags is independent of the tag stack.
See |tag-!| for [!]. See |tag-!| for [!].
@ -441,7 +441,7 @@ current file changed ! option option action ~
This works because the tag is put on the stack anyway. If you want to lose This works because the tag is put on the stack anyway. If you want to lose
the changes you can use the ":tag!" command. the changes you can use the ":tag!" command.
- If the tag is in another file and the window includes 'winfixbuf', the - If the tag is in another file and the window includes 'winfixbuf', the
command will fail. If the tag is in the same file then it may succeed. command will fail. If the tag is in the same file then it may succeed.
*tag-security* *tag-security*
Note that Vim forbids some commands, for security reasons. This works like Note that Vim forbids some commands, for security reasons. This works like
@ -455,8 +455,8 @@ would otherwise go unnoticed. Example: >
:$d|/tag-function-name/ :$d|/tag-function-name/
In Vi the ":tag" command sets the last search pattern when the tag is searched In Vi the ":tag" command sets the last search pattern when the tag is searched
for. In Vim this is not done, the previous search pattern is still remembered, for. In Vim this is not done, the previous search pattern is still
unless the 't' flag is present in 'cpoptions'. remembered, unless the 't' flag is present in 'cpoptions'.
*emacs-tags* *emacs_tags* *E430* *emacs-tags* *emacs_tags* *E430*
Emacs style tag files are only supported if Vim was compiled with the Emacs style tag files are only supported if Vim was compiled with the
@ -465,7 +465,7 @@ files here, it is only supported for backwards compatibility :-).
Lines in Emacs tags files can be very long. Vim only deals with lines of up Lines in Emacs tags files can be very long. Vim only deals with lines of up
to about 510 bytes. To see whether lines are ignored set 'verbose' to 5 or to about 510 bytes. To see whether lines are ignored set 'verbose' to 5 or
higher. Non-Emacs tags file lines can be any length. higher. Non-Emacs tags file lines can be any length.
*tags-option* *tags-option*
The 'tags' option is a list of file names. Each of these files is searched The 'tags' option is a list of file names. Each of these files is searched
@ -535,7 +535,7 @@ Some programs that generate tags files:
ctags As found on most Unix systems. Only supports C. Only ctags As found on most Unix systems. Only supports C. Only
does the basic work. does the basic work.
universal ctags A maintained version of ctags based on exuberant universal ctags A maintained version of ctags based on exuberant
ctags. See https://ctags.io. ctags. See https://ctags.io.
*Exuberant_ctags* *Exuberant_ctags*
exuberant ctags This is a very good one. It works for C, C++, Java, exuberant ctags This is a very good one. It works for C, C++, Java,
Fortran, Eiffel and others. It can generate tags for Fortran, Eiffel and others. It can generate tags for
@ -586,7 +586,7 @@ ctags).
{term} ;" The two characters semicolon and double quote. This is {term} ;" The two characters semicolon and double quote. This is
interpreted by Vi as the start of a comment, which makes the interpreted by Vi as the start of a comment, which makes the
following be ignored. This is for backwards compatibility following be ignored. This is for backwards compatibility
with Vi, it ignores the following fields. Example: > with Vi, it ignores the following fields. Example: >
APP file /^static int APP;$/;" v APP file /^static int APP;$/;" v
< When {tagaddress} is not a line number or search pattern, then < When {tagaddress} is not a line number or search pattern, then
{term} must be |;". Here the bar ends the command (excluding {term} must be |;". Here the bar ends the command (excluding
@ -928,7 +928,8 @@ The function should return a List of Dict entries. Each Dict must at least
include the following entries and each value must be a string: include the following entries and each value must be a string:
name Name of the tag. name Name of the tag.
filename Name of the file where the tag is defined. It is filename Name of the file where the tag is defined. It is
either relative to the current directory or a full path. either relative to the current directory or a full
path.
cmd Ex command used to locate the tag in the file. This cmd Ex command used to locate the tag in the file. This
can be either an Ex search pattern or a line number. can be either an Ex search pattern or a line number.
Note that the format is similar to that of |taglist()|, which makes it possible Note that the format is similar to that of |taglist()|, which makes it possible

19
runtime/doc/term.txt
View File

@ -1,4 +1,4 @@
*term.txt* For Vim version 9.1. Last change: 2025 Sep 02 *term.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -676,7 +676,7 @@ anymore.
*xterm-true-color* *xterm-true-color*
Vim supports using true colors in the terminal (taken from |highlight-guifg| Vim supports using true colors in the terminal (taken from |highlight-guifg|
and |highlight-guibg|), given that the terminal supports this. To make this and |highlight-guibg|), given that the terminal supports this. To make this
work the 'termguicolors' option needs to be set. work the 'termguicolors' option needs to be set.
See https://github.com/termstandard/colors for a list of terminals that See https://github.com/termstandard/colors for a list of terminals that
support true colors. support true colors.
@ -746,8 +746,8 @@ Note: When 't_EI' is not set then 't_SI' and 't_SR' will not be sent. And
when 't_SI' or 't_SR' is not set then 't_EI' is sent only once. when 't_SI' or 't_SR' is not set then 't_EI' is sent only once.
This can be used to change the shape or color of the cursor in Insert or This can be used to change the shape or color of the cursor in Insert or
Replace mode. These are not standard termcap/terminfo entries, you need to set Replace mode. These are not standard termcap/terminfo entries, you need to
them yourself. set them yourself.
Example for an xterm, this changes the color of the cursor: > Example for an xterm, this changes the color of the cursor: >
if &term =~ "xterm" if &term =~ "xterm"
let &t_SI = "\<Esc>]12;purple\x7" let &t_SI = "\<Esc>]12;purple\x7"
@ -1111,7 +1111,8 @@ which characters are included in a word. A double click on a character
that has a match selects until that match (like using "v%"). If the match is that has a match selects until that match (like using "v%"). If the match is
an #if/#else/#endif block, the selection becomes linewise. an #if/#else/#endif block, the selection becomes linewise.
For MS-Windows and xterm the time for double clicking can be set with the For MS-Windows and xterm the time for double clicking can be set with the
'mousetime' option. For the other systems this time is defined outside of Vim. 'mousetime' option. For the other systems this time is defined outside of
Vim.
An example, for using a double click to jump to the tag under the cursor: > An example, for using a double click to jump to the tag under the cursor: >
:map <2-LeftMouse> :exe "tag " .. expand("<cword>")<CR> :map <2-LeftMouse> :exe "tag " .. expand("<cword>")<CR>
@ -1140,10 +1141,10 @@ modifiers.
When working with several windows, the size of the windows can be changed by When working with several windows, the size of the windows can be changed by
dragging the status line with the mouse. Point the mouse at a status line, dragging the status line with the mouse. Point the mouse at a status line,
press the left button, move the mouse to the new position of the status line, press the left button, move the mouse to the new position of the status line,
release the button. Just clicking the mouse in a status line makes that window release the button. Just clicking the mouse in a status line makes that
the current window, without moving the cursor. If by selecting a window it window the current window, without moving the cursor. If by selecting a
will change position or size, the dragging of the status line will look window it will change position or size, the dragging of the status line will
confusing, but it will work (just try it). look confusing, but it will work (just try it).
*<MiddleRelease>* *<MiddleDrag>* *<MiddleRelease>* *<MiddleDrag>*
Mouse clicks can be mapped. The codes for mouse clicks are: Mouse clicks can be mapped. The codes for mouse clicks are:

91
runtime/doc/terminal.txt
View File

@ -1,4 +1,4 @@
*terminal.txt* For Vim version 9.1. Last change: 2025 Oct 08 *terminal.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -54,7 +54,7 @@ The terminal feature requires the |+job| and |+channel| features.
1. Basic use *terminal-use* 1. Basic use *terminal-use*
This feature is for running a terminal emulator in a Vim window. A job can be This feature is for running a terminal emulator in a Vim window. A job can be
started connected to the terminal emulator. For example, to run a shell: > started connected to the terminal emulator. For example, to run a shell: >
:term bash :term bash
Or to run build command: > Or to run build command: >
@ -71,7 +71,8 @@ the job. This uses a pty when possible. You can click outside of the
terminal window to move keyboard focus elsewhere. terminal window to move keyboard focus elsewhere.
*t_CTRL-W_CTRL-W* *t_CTRL-W_:* *t_CTRL-W_CTRL-W* *t_CTRL-W_:*
CTRL-W can be used to navigate between windows and other CTRL-W commands, e.g.: CTRL-W can be used to navigate between windows and other CTRL-W commands,
e.g.:
CTRL-W CTRL-W move focus to the next window CTRL-W CTRL-W move focus to the next window
CTRL-W : enter an Ex command CTRL-W : enter an Ex command
See |CTRL-W| for more commands. See |CTRL-W| for more commands.
@ -271,12 +272,12 @@ Command syntax ~
the terminal window) the command line the terminal window) the command line
height will be reduced as needed. height will be reduced as needed.
++cols={width} Use {width} for the terminal window ++cols={width} Use {width} for the terminal window
width. If the terminal uses the full width. If the terminal uses the full
Vim width (no window left or right of Vim width (no window left or right of
the terminal window) this value is the terminal window) this value is
ignored. ignored.
++eof={text} When using [range]: text to send after ++eof={text} When using [range]: text to send after
the last line was written. Cannot the last line was written. Cannot
contain white space. A CR is contain white space. A CR is
appended. For MS-Windows the default appended. For MS-Windows the default
is to send CTRL-D. is to send CTRL-D.
@ -322,13 +323,13 @@ fails, use ! to force, as usual.
*terminal-close* *terminal-close*
When the terminal job finishes and no [command] was given (e.g. the 'shell' When the terminal job finishes and no [command] was given (e.g. the 'shell'
command was executed), the terminal window will be closed by default (unless command was executed), the terminal window will be closed by default (unless
the buffer in next window receiving the space has the 'nobuflisted' option set, the buffer in next window receiving the space has the 'nobuflisted' option
in which case the terminal window would not be closed automatically, but a new set, in which case the terminal window would not be closed automatically, but
empty buffer would be opened in that window). a new empty buffer would be opened in that window).
When the terminal window is closed, e.g. when the shell exits and "++close" When the terminal window is closed, e.g. when the shell exits and "++close"
argument was used, and this is the last normal Vim window, then Vim will exit. argument was used, and this is the last normal Vim window, then Vim will exit.
This is like using |:quit| in a normal window. Help and preview windows are This is like using |:quit| in a normal window. Help and preview windows are
not counted. not counted.
To have a background job run without a window, and open the window when it's To have a background job run without a window, and open the window when it's
@ -384,7 +385,7 @@ Use CTRL-W N (or 'termwinkey' N) to switch to Terminal-Normal mode. Now the
contents of the terminal window is under control of Vim, the job output is contents of the terminal window is under control of Vim, the job output is
suspended. CTRL-\ CTRL-N does the same. suspended. CTRL-\ CTRL-N does the same.
Terminal-Job mode is where |:tmap| mappings are applied. Keys sent by Terminal-Job mode is where |:tmap| mappings are applied. Keys sent by
|term_sendkeys()| are not subject to tmap, but keys from |feedkeys()| are. |term_sendkeys()| are not subject to tmap, but keys from |feedkeys()| are.
It is not possible to enter Insert mode from Terminal-Job mode. It is not possible to enter Insert mode from Terminal-Job mode.
@ -394,7 +395,7 @@ In Terminal-Normal mode you can move the cursor around with the usual Vim
commands, Visually mark text, yank text, etc. But you cannot change the commands, Visually mark text, yank text, etc. But you cannot change the
contents of the buffer. The commands that would start insert mode, such as contents of the buffer. The commands that would start insert mode, such as
'i' and 'a', return to Terminal-Job mode. The window will be updated to show 'i' and 'a', return to Terminal-Job mode. The window will be updated to show
the contents of the terminal. |:startinsert| is ineffective. the contents of the terminal. |:startinsert| is ineffective.
In Terminal-Normal mode the statusline and window title show "(Terminal)". If In Terminal-Normal mode the statusline and window title show "(Terminal)". If
the job ends while in Terminal-Normal mode this changes to the job ends while in Terminal-Normal mode this changes to
@ -402,7 +403,7 @@ the job ends while in Terminal-Normal mode this changes to
When the job outputs lines in the terminal, such that the contents scrolls off When the job outputs lines in the terminal, such that the contents scrolls off
the top, those lines are remembered and can be seen in Terminal-Normal mode. the top, those lines are remembered and can be seen in Terminal-Normal mode.
The number of lines is limited by the 'termwinscroll' option. When going over The number of lines is limited by the 'termwinscroll' option. When going over
this limit, the first 10% of the scrolled lines are deleted and are lost. this limit, the first 10% of the scrolled lines are deleted and are lost.
@ -486,10 +487,10 @@ version, rename to winpty32.dll and winpty64.dll to match the way Vim was
build. build.
*ConPTY* *E982* *ConPTY* *E982*
On more recent versions of MS-Windows 10 (beginning with the "October 2018 On more recent versions of MS-Windows 10 (beginning with the "October 2018
Update"), winpty is no longer required. On those versions, |:terminal| will use Update"), winpty is no longer required. On those versions, |:terminal| will use
Windows' built-in support for hosting terminal applications, "ConPTY". When Windows' built-in support for hosting terminal applications, "ConPTY". When
ConPTY is in use, there may be rendering artifacts regarding ambiguous-width ConPTY is in use, there may be rendering artifacts regarding ambiguous-width
characters. If you encounter any such issues, install "winpty". Until the characters. If you encounter any such issues, install "winpty". Until the
ConPTY problems have been fixed "winpty" will be preferred. ConPTY problems have been fixed "winpty" will be preferred.
Environment variables are used to pass information to the running job: Environment variables are used to pass information to the running job:
@ -540,7 +541,7 @@ term_dumpdiff({filename}, {filename} [, {options}])
"norestore" do not add the terminal window to a "norestore" do not add the terminal window to a
session file session file
Each character in the middle part indicates a difference. If Each character in the middle part indicates a difference. If
there are multiple differences only the first in this list is there are multiple differences only the first in this list is
used: used:
X different character X different character
@ -641,8 +642,8 @@ term_getattr({attr}, {what}) *term_getattr()*
term_getcursor({buf}) *term_getcursor()* term_getcursor({buf}) *term_getcursor()*
Get the cursor position of terminal {buf}. Returns a list with Get the cursor position of terminal {buf}. Returns a list
two numbers and a dictionary: [row, col, dict]. with two numbers and a dictionary: [row, col, dict].
"row" and "col" are one based, the first screen cell is row "row" and "col" are one based, the first screen cell is row
1, column 1. This is the cursor position of the terminal 1, column 1. This is the cursor position of the terminal
@ -657,7 +658,7 @@ term_getcursor({buf}) *term_getcursor()*
for a vertical bar. for a vertical bar.
"color" color of the cursor, e.g. "green" "color" color of the cursor, e.g. "green"
{buf} must be the buffer number of a terminal window. If the {buf} must be the buffer number of a terminal window. If the
buffer does not exist or is not a terminal window, an empty buffer does not exist or is not a terminal window, an empty
list is returned. list is returned.
@ -670,7 +671,7 @@ term_getcursor({buf}) *term_getcursor()*
term_getjob({buf}) *term_getjob()* term_getjob({buf}) *term_getjob()*
Get the Job associated with terminal window {buf}. Get the Job associated with terminal window {buf}.
{buf} is used as with |term_getsize()|. {buf} is used as with |term_getsize()|.
Returns |v:null| when there is no job. In Vim9 script, return Returns |v:null| when there is no job. In Vim9 script, return
|null_job| when there is no job. |null_job| when there is no job.
Can also be used as a |method|: > Can also be used as a |method|: >
@ -713,7 +714,7 @@ term_getscrolled({buf}) *term_getscrolled()*
term_getsize({buf}) *term_getsize()* term_getsize({buf}) *term_getsize()*
Get the size of terminal {buf}. Returns a list with two Get the size of terminal {buf}. Returns a list with two
numbers: [rows, cols]. This is the size of the terminal, not numbers: [rows, cols]. This is the size of the terminal, not
the window containing the terminal. the window containing the terminal.
@ -728,14 +729,14 @@ term_getsize({buf}) *term_getsize()*
term_getstatus({buf}) *term_getstatus()* term_getstatus({buf}) *term_getstatus()*
Get the status of terminal {buf}. This returns a String with Get the status of terminal {buf}. This returns a String with
a comma-separated list of these items: a comma-separated list of these items:
running job is running running job is running
finished job has finished finished job has finished
normal in Terminal-Normal mode normal in Terminal-Normal mode
One of "running" or "finished" is always present. One of "running" or "finished" is always present.
{buf} must be the buffer number of a terminal window. If the {buf} must be the buffer number of a terminal window. If the
buffer does not exist or is not a terminal window, an empty buffer does not exist or is not a terminal window, an empty
string is returned. string is returned.
@ -746,10 +747,10 @@ term_getstatus({buf}) *term_getstatus()*
term_gettitle({buf}) *term_gettitle()* term_gettitle({buf}) *term_gettitle()*
Get the title of terminal {buf}. This is the title that the Get the title of terminal {buf}. This is the title that the
job in the terminal has set. job in the terminal has set.
{buf} must be the buffer number of a terminal window. If the {buf} must be the buffer number of a terminal window. If the
buffer does not exist or is not a terminal window, an empty buffer does not exist or is not a terminal window, an empty
string is returned. string is returned.
@ -764,8 +765,8 @@ term_gettty({buf} [, {input}]) *term_gettty()*
terminal window {buf}. {buf} is used as with |term_getsize()|. terminal window {buf}. {buf} is used as with |term_getsize()|.
When {input} is omitted or 0, return the name for writing When {input} is omitted or 0, return the name for writing
(stdout). When {input} is 1 return the name for reading (stdout). When {input} is 1 return the name for reading
(stdin). On UNIX, both return same name. (stdin). On UNIX, both return same name.
Can also be used as a |method|: > Can also be used as a |method|: >
GetBufnr()->term_gettty() GetBufnr()->term_gettty()
@ -808,7 +809,7 @@ term_sendkeys({buf}, {keys}) *term_sendkeys()*
Send keystrokes {keys} to terminal {buf}. Send keystrokes {keys} to terminal {buf}.
{buf} is used as with |term_getsize()|. {buf} is used as with |term_getsize()|.
{keys} are translated as key sequences. For example, "\<c-x>" {keys} are translated as key sequences. For example, "\<c-x>"
means the character CTRL-X. means the character CTRL-X.
Can also be used as a |method|: > Can also be used as a |method|: >
@ -904,7 +905,7 @@ term_setrestore({buf}, {command}) *term_setrestore()*
term_setsize({buf}, {rows}, {cols}) *term_setsize()* *E955* term_setsize({buf}, {rows}, {cols}) *term_setsize()* *E955*
Set the size of terminal {buf}. The size of the window Set the size of terminal {buf}. The size of the window
containing the terminal will also be adjusted, if possible. containing the terminal will also be adjusted, if possible.
If {rows} or {cols} is zero or negative, that dimension is not If {rows} or {cols} is zero or negative, that dimension is not
changed. changed.
@ -922,7 +923,7 @@ term_setsize({buf}, {rows}, {cols}) *term_setsize()* *E955*
term_start({cmd} [, {options}]) *term_start()* term_start({cmd} [, {options}]) *term_start()*
Open a terminal window and run {cmd} in it. Open a terminal window and run {cmd} in it.
{cmd} can be a string or a List, like with |job_start()|. The {cmd} can be a string or a List, like with |job_start()|. The
string "NONE" can be used to open a terminal window without string "NONE" can be used to open a terminal window without
starting a job, the pty of the terminal can be used by a starting a job, the pty of the terminal can be used by a
command like gdb. command like gdb.
@ -969,17 +970,17 @@ term_start({cmd} [, {options}]) *term_start()*
"open": open window if needed "open": open window if needed
Note that "open" can be interruptive. Note that "open" can be interruptive.
See |term++close| and |term++open|. See |term++close| and |term++open|.
"term_opencmd" command to use for opening the window when "term_opencmd" command to use for opening the window
"open" is used for "term_finish"; must when "open" is used for "term_finish";
have "%d" where the buffer number goes, must have "%d" where the buffer number
e.g. "10split|buffer %d"; when not goes, e.g. "10split|buffer %d"; when not
specified "botright sbuf %d" is used specified "botright sbuf %d" is used
"term_highlight" highlight group to use instead of "term_highlight" highlight group to use instead of
"Terminal" "Terminal"
"eof_chars" Text to send after all buffer lines were "eof_chars" Text to send after all buffer lines were
written to the terminal. When not set written to the terminal. When not set
CTRL-D is used on MS-Windows. For Python CTRL-D is used on MS-Windows. For Python
use CTRL-Z or "exit()". For a shell use use CTRL-Z or "exit()". For a shell use
"exit". A CR is always added. "exit". A CR is always added.
"ansi_colors" A list of 16 color names or hex codes "ansi_colors" A list of 16 color names or hex codes
defining the ANSI palette used in GUI defining the ANSI palette used in GUI
@ -1014,7 +1015,7 @@ term_wait({buf} [, {time}]) *term_wait()*
There are several ways to communicate with the job running in a terminal: There are several ways to communicate with the job running in a terminal:
- Use |term_sendkeys()| to send text and escape sequences from Vim to the job. - Use |term_sendkeys()| to send text and escape sequences from Vim to the job.
- Use the JSON API to send encoded commands from the job to Vim. - Use the JSON API to send encoded commands from the job to Vim.
- Use the |client-server| mechanism. This works on machines with an X server - Use the |client-server| mechanism. This works on machines with an X server
and on MS-Windows. and on MS-Windows.
@ -1180,7 +1181,7 @@ Writing a screen dump test for Vim ~
*terminal-dumptest* *terminal-dumptest*
For an example see the Test_syntax_c() function in For an example see the Test_syntax_c() function in
src/testdir/test_syntax.vim. The main parts are: src/testdir/test_syntax.vim. The main parts are:
- Write a file you want to test with. This is useful for testing syntax - Write a file you want to test with. This is useful for testing syntax
highlighting. You can also start Vim with an empty buffer. highlighting. You can also start Vim with an empty buffer.
- Run Vim in a terminal with a specific size. The default is 20 lines of 75 - Run Vim in a terminal with a specific size. The default is 20 lines of 75
characters. This makes sure the dump is always this size. The function characters. This makes sure the dump is always this size. The function
@ -1258,7 +1259,7 @@ kind of difference:
+ character missing in first + character missing in first
- character missing in second - character missing in second
Alternatively, press "s" to swap the first and second dump. Do this several Alternatively, press "s" to swap the first and second dump. Do this several
times so that you can spot the difference in the context of the text. times so that you can spot the difference in the context of the text.
============================================================================== ==============================================================================
@ -1313,7 +1314,7 @@ Only one debugger can be active at a time.
*termdebug-timeout* *termdebug-timeout*
Depending on how gdb is launched, termdebug startup time may vary. Depending on how gdb is launched, termdebug startup time may vary.
To avoid termdebug to get stuck if the startup process of gdb takes too long, To avoid termdebug to get stuck if the startup process of gdb takes too long,
a configurable timeout is included. Such time out is configurable in terms of a configurable timeout is included. Such time out is configurable in terms of
multiple of 10ms: > multiple of 10ms: >
let g:termdebug_config['timeout'] = 500 # 500 * 10ms = 5 seconds. let g:termdebug_config['timeout'] = 500 # 500 * 10ms = 5 seconds.
@ -1360,7 +1361,7 @@ You can use CTRL-W CTRL-W or the mouse to move focus between windows.
Put focus on the gdb window and type: > Put focus on the gdb window and type: >
break ex_help break ex_help
run run
Vim will start running in the program window. Put focus there and type: > Vim will start running in the program window. Put focus there and type: >
:help gui :help gui
Gdb will run into the ex_help breakpoint. The source window now shows the Gdb will run into the ex_help breakpoint. The source window now shows the
ex_cmds.c file. A red "1 " marker will appear in the signcolumn where the ex_cmds.c file. A red "1 " marker will appear in the signcolumn where the
@ -1388,7 +1389,7 @@ executed.
You can type more advanced commands in the gdb window. For example, type: > You can type more advanced commands in the gdb window. For example, type: >
watch curbuf watch curbuf
Now click "Cont" in the toolbar (or type "cont" in the gdb window). Execution Now click "Cont" in the toolbar (or type "cont" in the gdb window). Execution
will now continue until the value of "curbuf" changes, which is in do_ecmd(). will now continue until the value of "curbuf" changes, which is in do_ecmd().
To remove this watchpoint again type in the gdb window: > To remove this watchpoint again type in the gdb window: >
delete 3 delete 3
@ -1500,7 +1501,7 @@ Other commands ~
*:Asm* jump to the window with the disassembly, create it if there *:Asm* jump to the window with the disassembly, create it if there
isn't one isn't one
*:Var* jump to the window with the local and argument variables, *:Var* jump to the window with the local and argument variables,
create it if there isn't one. This window updates whenever the create it if there isn't one. This window updates whenever the
program is stopped program is stopped
Events ~ Events ~
@ -1809,8 +1810,8 @@ However, the latter form will be deprecated in future releases.
Change default signs ~ Change default signs ~
*termdebug_signs* *termdebug_signs*
Termdebug uses the hex number of the breakpoint ID in the signcolumn to Termdebug uses the hex number of the breakpoint ID in the signcolumn to
represent breakpoints. If it is greater than "0xFF", then it will be displayed represent breakpoints. If it is greater than "0xFF", then it will be
as "F+", due to we really only have two screen cells for the sign. displayed as "F+", due to we really only have two screen cells for the sign.
You may also use decimal breakpoint signs instead, in which case IDs greater You may also use decimal breakpoint signs instead, in which case IDs greater
than 99 will be displayed as "9+". than 99 will be displayed as "9+".
@ -1857,7 +1858,7 @@ Set the wide value to 1 to use a vertical split without ever changing
Evaluate in Popup Window at Cursor ~ Evaluate in Popup Window at Cursor ~
*termdebug_evaluate_in_popup* *termdebug_evaluate_in_popup*
By default |:Evaluate| will simply echo its output. For larger entities this By default |:Evaluate| will simply echo its output. For larger entities this
might become difficult to read or even truncated. might become difficult to read or even truncated.
Alternatively, the evaluation result may be output into a popup window at the Alternatively, the evaluation result may be output into a popup window at the
current cursor position: > current cursor position: >

66
runtime/doc/testing.txt
View File

@ -1,4 +1,4 @@
*testing.txt* For Vim version 9.1. Last change: 2025 Mar 25 *testing.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -26,7 +26,7 @@ There are two types of tests added over time:
*new-style-testing* *new-style-testing*
New tests should be added as new style tests. The test scripts are named New tests should be added as new style tests. The test scripts are named
test_<feature>.vim (replace <feature> with the feature under test). These use test_<feature>.vim (replace <feature> with the feature under test). These use
functions such as |assert_equal()| to keep the test commands and the expected functions such as |assert_equal()| to keep the test commands and the expected
result in one place. result in one place.
*old-style-testing* *old-style-testing*
@ -58,7 +58,7 @@ test_autochdir() *test_autochdir()*
test_feedinput({string}) *test_feedinput()* test_feedinput({string}) *test_feedinput()*
Characters in {string} are queued for processing as if they Characters in {string} are queued for processing as if they
were typed by the user. This uses a low level input buffer. were typed by the user. This uses a low level input buffer.
This function works only when with |+unix| or GUI is running. This function works only when with |+unix| or GUI is running.
Can also be used as a |method|: > Can also be used as a |method|: >
@ -96,7 +96,7 @@ test_getvalue({name}) *test_getvalue()*
*test_gui_event()* *test_gui_event()*
test_gui_event({event}, {args}) test_gui_event({event}, {args})
Generate a GUI {event} with arguments {args} for testing Vim Generate a GUI {event} with arguments {args} for testing Vim
functionality. This function works only when the GUI is functionality. This function works only when the GUI is
running. running.
{event} is a String and the supported values are: {event} is a String and the supported values are:
@ -116,7 +116,7 @@ test_gui_event({event}, {args})
files: List of file names files: List of file names
row: window row number row: window row number
col: window column number col: window column number
modifiers: key modifiers. The supported values are: modifiers: key modifiers. The supported values are:
0x4 Shift 0x4 Shift
0x8 Alt 0x8 Alt
0x10 Ctrl 0x10 Ctrl
@ -131,7 +131,7 @@ test_gui_event({event}, {args})
in {args} are: in {args} are:
find_text: string to find. find_text: string to find.
repl_text: replacement string. repl_text: replacement string.
flags: flags controlling the find/replace. Supported flags: flags controlling the find/replace. Supported
values are: values are:
1 search next string (find dialog) 1 search next string (find dialog)
2 search next string (replace dialog) 2 search next string (replace dialog)
@ -176,7 +176,7 @@ test_gui_event({event}, {args})
Set or drag the left, right or horizontal scrollbar. Only Set or drag the left, right or horizontal scrollbar. Only
works when the scrollbar actually exists. The supported works when the scrollbar actually exists. The supported
items in {args} are: items in {args} are:
which: Selects the scrollbar. The supported values which: Selects the scrollbar. The supported values
are: are:
left Left scrollbar of the current window left Left scrollbar of the current window
right Right scrollbar of the current window right Right scrollbar of the current window
@ -202,14 +202,14 @@ test_gui_event({event}, {args})
"tabline": "tabline":
Inject a mouse click event on the tabline to select a Inject a mouse click event on the tabline to select a
tabpage. The supported items in {args} are: tabpage. The supported items in {args} are:
tabnr: tab page number tabnr: tab page number
"tabmenu": "tabmenu":
Inject an event to select a tabline menu entry. The Inject an event to select a tabline menu entry. The
supported items in {args} are: supported items in {args} are:
tabnr: tab page number tabnr: tab page number
item: tab page menu item number. 1 for the first item: tab page menu item number. 1 for the first
menu item, 2 for the second item and so on. menu item, 2 for the second item and so on.
After injecting the GUI events you probably should call After injecting the GUI events you probably should call
@ -299,7 +299,7 @@ test_mswin_event({event}, {args}) *test_mswin_event()*
8 alt is pressed 8 alt is pressed
Note: These values are different from the Note: These values are different from the
mouse modifiers. mouse modifiers.
execute: Optional. Similar to |feedkeys()| mode x. execute: Optional. Similar to |feedkeys()| mode x.
When this is included and set to true When this is included and set to true
(non-zero) then Vim will process any buffered (non-zero) then Vim will process any buffered
unprocessed key events. All other {args} unprocessed key events. All other {args}
@ -307,8 +307,8 @@ test_mswin_event({event}, {args}) *test_mswin_event()*
"set_keycode_trans_strategy": "set_keycode_trans_strategy":
|w32-experimental-keycode-trans-strategy| |w32-experimental-keycode-trans-strategy|
Switch the keycode translation method. The supported methods Switch the keycode translation method. The supported
are: methods are:
experimental: The method used after Patch v8.2.4807 experimental: The method used after Patch v8.2.4807
using ToUnicode() Win API call. using ToUnicode() Win API call.
classic: The method used pre Patch v8.2.4807 classic: The method used pre Patch v8.2.4807
@ -323,55 +323,55 @@ test_mswin_event({event}, {args}) *test_mswin_event()*
Return type: |vim9-boolean| Return type: |vim9-boolean|
test_null_blob() *test_null_blob()* test_null_blob() *test_null_blob()*
Return a |Blob| that is null. Only useful for testing. Return a |Blob| that is null. Only useful for testing.
Return type: |Blob| Return type: |Blob|
test_null_channel() *test_null_channel()* test_null_channel() *test_null_channel()*
Return a |Channel| that is null. Only useful for testing. Return a |Channel| that is null. Only useful for testing.
{only available when compiled with the +channel feature} {only available when compiled with the +channel feature}
Return type: |Channel| Return type: |Channel|
test_null_dict() *test_null_dict()* test_null_dict() *test_null_dict()*
Return a |Dict| that is null. Only useful for testing. Return a |Dict| that is null. Only useful for testing.
Return type: dict<any> Return type: dict<any>
test_null_function() *test_null_function()* test_null_function() *test_null_function()*
Return a |Funcref| that is null. Only useful for testing. Return a |Funcref| that is null. Only useful for testing.
Return type: func(...): unknown Return type: func(...): unknown
test_null_job() *test_null_job()* test_null_job() *test_null_job()*
Return a |Job| that is null. Only useful for testing. Return a |Job| that is null. Only useful for testing.
{only available when compiled with the +job feature} {only available when compiled with the +job feature}
Return type: |job| Return type: |job|
test_null_list() *test_null_list()* test_null_list() *test_null_list()*
Return a |List| that is null. Only useful for testing. Return a |List| that is null. Only useful for testing.
Return type: list<any> Return type: list<any>
test_null_partial() *test_null_partial()* test_null_partial() *test_null_partial()*
Return a |Partial| that is null. Only useful for testing. Return a |Partial| that is null. Only useful for testing.
Return type: func(...): unknown Return type: func(...): unknown
test_null_string() *test_null_string()* test_null_string() *test_null_string()*
Return a |String| that is null. Only useful for testing. Return a |String| that is null. Only useful for testing.
Return type: |String| Return type: |String|
test_null_tuple() *test_null_tuple()* test_null_tuple() *test_null_tuple()*
Return a |Tuple| that is null. Only useful for testing. Return a |Tuple| that is null. Only useful for testing.
Return type: |Tuple| Return type: |Tuple|
test_option_not_set({name}) *test_option_not_set()* test_option_not_set({name}) *test_option_not_set()*
Reset the flag that indicates option {name} was set. Thus it Reset the flag that indicates option {name} was set. Thus it
looks like it still has the default value. Use like this: > looks like it still has the default value. Use like this: >
set ambiwidth=double set ambiwidth=double
call test_option_not_set('ambiwidth') call test_option_not_set('ambiwidth')
< Now the 'ambiwidth' option behaves like it was never changed, < Now the 'ambiwidth' option behaves like it was never changed,
@ -384,8 +384,8 @@ test_option_not_set({name}) *test_option_not_set()*
Return type: |Number| Return type: |Number|
test_override({name}, {val}) *test_override()* test_override({name}, {val}) *test_override()*
Overrides certain parts of Vim's internal processing to be able Overrides certain parts of Vim's internal processing to be
to run tests. Only to be used for testing Vim! able to run tests. Only to be used for testing Vim!
The override is enabled when {val} is non-zero and removed The override is enabled when {val} is non-zero and removed
when {val} is zero. when {val} is zero.
Current supported values for {name} are: Current supported values for {name} are:
@ -422,7 +422,7 @@ test_override({name}, {val}) *test_override()*
"starting" is to be used when a test should behave like "starting" is to be used when a test should behave like
startup was done. Since the tests are run by sourcing a startup was done. Since the tests are run by sourcing a
script the "starting" variable is non-zero. This is usually a script the "starting" variable is non-zero. This is usually a
good thing (tests run faster), but sometimes this changes good thing (tests run faster), but sometimes this changes
behavior in a way that the test doesn't work properly. behavior in a way that the test doesn't work properly.
When using: > When using: >
@ -481,12 +481,12 @@ test_srand_seed([{seed}]) *test_srand_seed()*
Return type: |Number| Return type: |Number|
test_unknown() *test_unknown()* test_unknown() *test_unknown()*
Return a value with unknown type. Only useful for testing. Return a value with unknown type. Only useful for testing.
Return type: unknown Return type: unknown
test_void() *test_void()* test_void() *test_void()*
Return a value with void type. Only useful for testing. Return a value with void type. Only useful for testing.
Return type: void Return type: void
@ -565,7 +565,7 @@ assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
error message. Also see |assert-return|. error message. Also see |assert-return|.
*E856* *E856*
When {error} is a string it must be found literally in the When {error} is a string it must be found literally in the
first reported error. Most often this will be the error code, first reported error. Most often this will be the error code,
including the colon, e.g. "E123:". > including the colon, e.g. "E123:". >
call assert_fails('bad cmd', 'E987:') call assert_fails('bad cmd', 'E987:')
< <
@ -575,8 +575,8 @@ assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
call assert_fails('cmd', ['E987:.*expected bool']) call assert_fails('cmd', ['E987:.*expected bool'])
< The second pattern, if present, is matched against the last < The second pattern, if present, is matched against the last
reported error. reported error.
If there is only one error then both patterns must match. This If there is only one error then both patterns must match.
can be used to check that there is only one error. This can be used to check that there is only one error.
To only match the last error use an empty string for the first To only match the last error use an empty string for the first
error: > error: >
call assert_fails('cmd', ['', 'E987:']) call assert_fails('cmd', ['', 'E987:'])
@ -586,7 +586,7 @@ assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
*E1115* *E1115*
When {lnum} is present and not negative, and the {error} When {lnum} is present and not negative, and the {error}
argument is present and matches, then this is compared with argument is present and matches, then this is compared with
the line number at which the error was reported. That can be the line number at which the error was reported. That can be
the line number in a function or in a script. the line number in a function or in a script.
*E1116* *E1116*
When {context} is present it is used as a pattern and matched When {context} is present it is used as a pattern and matched
@ -609,7 +609,7 @@ assert_false({actual} [, {msg}]) *assert_false()*
location of the assert when run from a script. location of the assert when run from a script.
Also see |assert-return|. Also see |assert-return|.
A value is false when it is zero. When {actual} is not a A value is false when it is zero. When {actual} is not a
number the assert fails. number the assert fails.
Can also be used as a |method|: > Can also be used as a |method|: >

12
runtime/doc/textprop.txt
View File

@ -1,4 +1,4 @@
*textprop.txt* For Vim version 9.1. Last change: 2024 Sep 08 *textprop.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -194,7 +194,7 @@ prop_add({lnum}, {col}, {props})
the property type does not have "end_incl" set. the property type does not have "end_incl" set.
"type" will first be looked up in the buffer the property is "type" will first be looked up in the buffer the property is
added to. When not found, the global property types are used. added to. When not found, the global property types are used.
If not found an error is given. If not found an error is given.
*virtual-text* *virtual-text*
When "text" is used and the column is non-zero then this text When "text" is used and the column is non-zero then this text
@ -329,14 +329,14 @@ prop_list({lnum} [, {props}]) *prop_list()*
A negative value is used as an offset from the A negative value is used as an offset from the
last buffer line; -1 refers to the last buffer last buffer line; -1 refers to the last buffer
line. line.
types List of property type names. Return only text types List of property type names. Return only text
properties that match one of the type names. properties that match one of the type names.
ids List of property identifiers. Return only text ids List of property identifiers. Return only
properties with one of these identifiers. text properties with one of these identifiers.
The properties are ordered by starting column and priority. The properties are ordered by starting column and priority.
Each property is a Dict with these entries: Each property is a Dict with these entries:
lnum starting line number. Present only when lnum starting line number. Present only when
returning text properties between {lnum} and returning text properties between {lnum} and
{end_lnum}. {end_lnum}.
col starting column col starting column

10
runtime/doc/tips.txt
View File

@ -1,4 +1,4 @@
*tips.txt* For Vim version 9.1. Last change: 2023 Aug 10 *tips.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -183,10 +183,10 @@ To make this easier, you could use these mappings: >
You then lose the ability to copy text from the line above/below the cursor You then lose the ability to copy text from the line above/below the cursor
|i_CTRL-E|. |i_CTRL-E|.
Also consider setting 'scrolloff' to a larger value, so that you can always see Also consider setting 'scrolloff' to a larger value, so that you can always
some context around the cursor. If 'scrolloff' is bigger than half the window see some context around the cursor. If 'scrolloff' is bigger than half the
height, the cursor will always be in the middle and the text is scrolled when window height, the cursor will always be in the middle and the text is
the cursor is moved up/down. scrolled when the cursor is moved up/down.
============================================================================== ==============================================================================
Smooth scrolling *scroll-smooth* Smooth scrolling *scroll-smooth*

23
runtime/doc/undo.txt
View File

@ -1,4 +1,4 @@
*undo.txt* For Vim version 9.1. Last change: 2025 Oct 11 *undo.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -112,7 +112,7 @@ parts. E.g., for each sentence. |i_CTRL-G_u|
Setting the value of 'undolevels' also closes the undo block. Even when the Setting the value of 'undolevels' also closes the undo block. Even when the
new value is equal to the old value. Use `g:undolevels` to explicitly read new value is equal to the old value. Use `g:undolevels` to explicitly read
and write only the global value of 'undolevels'. In |Vim9| script: > and write only the global value of 'undolevels'. In |Vim9| script: >
&g:undolevels = &g:undolevels &g:undolevels = &g:undolevels
In legacy script: > In legacy script: >
let &g:undolevels = &g:undolevels let &g:undolevels = &g:undolevels
@ -156,7 +156,7 @@ This is explained in the user manual: |usr_32.txt|.
MM/DD HH:MM:SS idem, with month and day MM/DD HH:MM:SS idem, with month and day
YYYY/MM/DD HH:MM:SS idem, with year YYYY/MM/DD HH:MM:SS idem, with year
The "saved" column specifies, if this change was The "saved" column specifies, if this change was
written to disk and which file write it was. This can written to disk and which file write it was. This can
be used with the |:later| and |:earlier| commands. be used with the |:later| and |:earlier| commands.
For more details use the |undotree()| function. For more details use the |undotree()| function.
@ -256,7 +256,7 @@ for, you can use a BufWritePre autocommand: >
au BufWritePre /tmp/* setlocal noundofile au BufWritePre /tmp/* setlocal noundofile
Vim saves undo trees in a separate undo file, one for each edited file, using Vim saves undo trees in a separate undo file, one for each edited file, using
a simple scheme that maps filesystem paths directly to undo files. Vim will a simple scheme that maps filesystem paths directly to undo files. Vim will
detect if an undo file is no longer synchronized with the file it was written detect if an undo file is no longer synchronized with the file it was written
for (with a hash of the file contents) and ignore it when the file was changed for (with a hash of the file contents) and ignore it when the file was changed
after the undo file was written, to prevent corruption. An undo file is also after the undo file was written, to prevent corruption. An undo file is also
@ -285,11 +285,11 @@ respectively:
(the magic number at the start of the file is wrong), then (the magic number at the start of the file is wrong), then
this fails, unless the ! was added. this fails, unless the ! was added.
If it exists and does look like an undo file it is If it exists and does look like an undo file it is
overwritten. If there is no undo-history, nothing will be overwritten. If there is no undo-history, nothing will be
written. written.
Implementation detail: Overwriting happens by first deleting Implementation detail: Overwriting happens by first deleting
the existing file and then creating a new file with the same the existing file and then creating a new file with the same
name. So it is not possible to overwrite an existing undofile name. So it is not possible to overwrite an existing undofile
in a write-protected directory. in a write-protected directory.
*:rund* *:rundo* *:rund* *:rundo*
@ -385,11 +385,12 @@ information you can use these commands: >
Note use of `&l:undolevels` to explicitly read the local value of 'undolevels' Note use of `&l:undolevels` to explicitly read the local value of 'undolevels'
and the use of `:setlocal` to change only the local option (which takes and the use of `:setlocal` to change only the local option (which takes
precedence over the corresponding global option value). Saving the option value precedence over the corresponding global option value). Saving the option
via the use of `&undolevels` is unpredictable; it reads either the local value value via the use of `&undolevels` is unpredictable; it reads either the local
(if one has been set) or the global value (otherwise). Also, if a local value value (if one has been set) or the global value (otherwise). Also, if a local
has been set, changing the option via `:set undolevels` will change both the value has been set, changing the option via `:set undolevels` will change both
global and local values, requiring extra work to save and restore both values. the global and local values, requiring extra work to save and restore both
values.
Marks for the buffer ('a to 'z) are also saved and restored, together with the Marks for the buffer ('a to 'z) are also saved and restored, together with the
text. text.

4
runtime/doc/userfunc.txt
View File

@ -1,4 +1,4 @@
*userfunc.txt* For Vim version 9.1. Last change: 2025 Sep 12 *userfunc.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -65,7 +65,7 @@ define a global function.
< <
*:function-verbose* *:function-verbose*
When 'verbose' is non-zero, listing a function will also display where it was When 'verbose' is non-zero, listing a function will also display where it was
last defined. Example: > last defined. Example: >
:verbose function SetFileTypeSH :verbose function SetFileTypeSH
function SetFileTypeSH(name) function SetFileTypeSH(name)

31
runtime/doc/various.txt
View File

@ -1,4 +1,4 @@
*various.txt* For Vim version 9.1. Last change: 2025 Sep 22 *various.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -586,13 +586,13 @@ N *+X11* Unix only: can restore window title |X11|
:redi[r] @{a-z}>> Append messages to register {a-z}. :redi[r] @{a-z}>> Append messages to register {a-z}.
:redi[r] @*> :redi[r] @*>
:redi[r] @+> Redirect messages to the selection or clipboard. For :redi[r] @+> Redirect messages to the selection or clipboard. For
backward compatibility, the ">" after the register backward compatibility, the ">" after the register
name can be omitted. See |quotestar| and |quoteplus|. name can be omitted. See |quotestar| and |quoteplus|.
:redi[r] @*>> :redi[r] @*>>
:redi[r] @+>> Append messages to the selection or clipboard. :redi[r] @+>> Append messages to the selection or clipboard.
:redi[r] @"> Redirect messages to the unnamed register. For :redi[r] @"> Redirect messages to the unnamed register. For
backward compatibility, the ">" after the register backward compatibility, the ">" after the register
name can be omitted. name can be omitted.
:redi[r] @">> Append messages to the unnamed register. :redi[r] @">> Append messages to the unnamed register.
@ -628,16 +628,17 @@ N *+X11* Unix only: can restore window title |X11|
< If the [!] is given, restrict the output of {command} < If the [!] is given, restrict the output of {command}
to lines that do NOT match {pattern}. to lines that do NOT match {pattern}.
{pattern} is a Vim search pattern. Instead of enclosing {pattern} is a Vim search pattern. Instead of
it in / any non-ID character (see 'isident') can be enclosing it in / any non-ID character (see 'isident')
used, so long as it does not appear in {pattern}. can be used, so long as it does not appear in
{pattern}.
Without the enclosing character the pattern cannot Without the enclosing character the pattern cannot
include the bar character. 'ignorecase' is not used. include the bar character. 'ignorecase' is not used.
The pattern is matched against the relevant part of The pattern is matched against the relevant part of
the output, not necessarily the whole line. Only some the output, not necessarily the whole line. Only some
commands support filtering, try it out to check if it commands support filtering, try it out to check if it
works. Some of the commands that support filtering: works. Some of the commands that support filtering:
|:#| - filter whole line |:#| - filter whole line
|:clist| - filter by file name or module name |:clist| - filter by file name or module name
|:command| - filter by command name |:command| - filter by command name
@ -706,7 +707,7 @@ N *+X11* Unix only: can restore window title |X11|
*:verb* *:verbose* *:verb* *:verbose*
:[count]verb[ose] {command} :[count]verb[ose] {command}
Execute {command} with 'verbose' set to [count]. If Execute {command} with 'verbose' set to [count]. If
[count] is omitted one is used. ":0verbose" can be [count] is omitted one is used. ":0verbose" can be
used to set 'verbose' to zero. used to set 'verbose' to zero.
The additional use of ":silent" makes messages The additional use of ":silent" makes messages
generated but not displayed. generated but not displayed.
@ -787,10 +788,10 @@ K Run a program to lookup the keyword under the
:[N]sl[eep]! [N][m] Same as above, but hide the cursor. :[N]sl[eep]! [N][m] Same as above, but hide the cursor.
*:xrestore* *:xr* *:xrestore* *:xr*
:xr[estore] [display] Reinitializes the connection to the X11 server. Useful :xr[estore] [display] Reinitializes the connection to the X11 server.
after the X server restarts, e.g. when running Vim for Useful after the X server restarts, e.g. when running
long time inside screen/tmux and connecting from Vim for long time inside screen/tmux and connecting
different machines. from different machines.
[display] should be in the format of the $DISPLAY [display] should be in the format of the $DISPLAY
environment variable (e.g. "localhost:10.0") environment variable (e.g. "localhost:10.0")
If [display] is omitted, then it reinitializes the If [display] is omitted, then it reinitializes the

7
runtime/doc/vi_diff.txt
View File

@ -1,4 +1,4 @@
*vi_diff.txt* For Vim version 9.1. Last change: 2025 Sep 29 *vi_diff.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -174,7 +174,8 @@ Multiple windows and buffers. |windows.txt|
is called a hidden buffer. Many commands and options have been added is called a hidden buffer. Many commands and options have been added
for this facility. for this facility.
Vim can also use multiple tab pages, each with one or more windows. A Vim can also use multiple tab pages, each with one or more windows. A
line with tab labels can be used to quickly switch between these pages. line with tab labels can be used to quickly switch between these
pages.
|tab-page| |tab-page|
Terminal window. |:terminal| Terminal window. |:terminal|
@ -1373,7 +1374,7 @@ Vim tries to support some old operating systems, however support for older
operating systems might be dropped if maintenance becomes a burden or can no operating systems might be dropped if maintenance becomes a burden or can no
longer be verified. longer be verified.
Here is the status of some operating systems. Note fully supported means, Here is the status of some operating systems. Note fully supported means,
support is verified as part of the CI test suite. support is verified as part of the CI test suite.
System | Status:~ System | Status:~

14
runtime/doc/visual.txt
View File

@ -1,4 +1,4 @@
*visual.txt* For Vim version 9.1. Last change: 2025 Jun 28 *visual.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -128,8 +128,8 @@ gN Like |gn| but searches backward, like with `N`.
active it is stopped. Only when 'mouse' option active it is stopped. Only when 'mouse' option
contains 'n' or 'a'. If the position is within 'so' contains 'n' or 'a'. If the position is within 'so'
lines from the last line on the screen the text is lines from the last line on the screen the text is
scrolled up. If the position is within 'so' lines from scrolled up. If the position is within 'so' lines
the first line on the screen the text is scrolled from the first line on the screen the text is scrolled
down. down.
*<RightMouse>* *<RightMouse>*
@ -352,10 +352,10 @@ all lines.
*v_b_<* *v_b_<*
Visual-block Shift *v_b_>* Visual-block Shift *v_b_>*
The block is shifted by 'shiftwidth'. The RHS of the block is irrelevant. The The block is shifted by 'shiftwidth'. The RHS of the block is irrelevant.
LHS of the block determines the point from which to apply a right shift, and The LHS of the block determines the point from which to apply a right shift,
padding includes TABs optimally according to 'ts' and 'et'. The LHS of the and padding includes TABs optimally according to 'ts' and 'et'. The LHS of
block determines the point up to which to shift left. the block determines the point up to which to shift left.
See |v_b_>_example|. See |v_b_>_example|.
See |v_b_<_example|. See |v_b_<_example|.

7
runtime/doc/wayland.txt
View File

@ -1,4 +1,4 @@
*wayland.txt* For Vim version 9.1. Last change: 2025 Sep 22 *wayland.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -26,7 +26,8 @@ should equal to "gui" when running the GUI.
Wayland commands: Wayland commands:
*:wlrestore* *:wl* *:wlrestore* *:wl*
:wl[restore] [display] Reinitializes the connection to the Wayland compositor. :wl[restore] [display] Reinitializes the connection to the Wayland
compositor.
Useful when running Vim in a screen/tmux session that Useful when running Vim in a screen/tmux session that
continues running after the Wayland compositor continues running after the Wayland compositor
restarts. restarts.
@ -105,7 +106,7 @@ To solve this problem, Vim implements a way of gaining focus in order to
access the clipboard, by creating a temporary transparent top-level surface. access the clipboard, by creating a temporary transparent top-level surface.
This is by default disabled and can be enabled via the 'wlsteal' option. This is by default disabled and can be enabled via the 'wlsteal' option.
Moreover, a seat that has a keyboard is also required, see 'wlseat', and the Moreover, a seat that has a keyboard is also required, see 'wlseat', and the
xdg-shell protocol must be available. Additionally, Vim must be compiled with xdg-shell protocol must be available. Additionally, Vim must be compiled with
the |+wayland_focus_steal| feature. the |+wayland_focus_steal| feature.
Note that this method can have several side effects from the result of focus Note that this method can have several side effects from the result of focus

20
runtime/doc/windows.txt
View File

@ -1,4 +1,4 @@
*windows.txt* For Vim version 9.1. Last change: 2025 Oct 11 *windows.txt* For Vim version 9.1. Last change: 2025 Oct 12
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -72,7 +72,7 @@ Each buffer has a unique number and the number will not change within a Vim
session. The |bufnr()| and |bufname()| functions can be used to convert session. The |bufnr()| and |bufname()| functions can be used to convert
between a buffer name and the buffer number. There is one exception: if a new between a buffer name and the buffer number. There is one exception: if a new
empty buffer is created and it is not modified, the buffer will be re-used empty buffer is created and it is not modified, the buffer will be re-used
when loading another file into that buffer. This also means the buffer number when loading another file into that buffer. This also means the buffer number
will not change. will not change.
The main Vim window can hold several split windows. There are also tab pages The main Vim window can hold several split windows. There are also tab pages
@ -80,7 +80,7 @@ The main Vim window can hold several split windows. There are also tab pages
*window-ID* *winid* *windowid* *window-ID* *winid* *windowid*
Each window has a unique identifier called the window ID. This identifier Each window has a unique identifier called the window ID. This identifier
will not change within a Vim session. The |win_getid()| and |win_id2tabwin()| will not change within a Vim session. The |win_getid()| and |win_id2tabwin()|
functions can be used to convert between the window/tab number and the functions can be used to convert between the window/tab number and the
identifier. There is also the window number, which may change whenever identifier. There is also the window number, which may change whenever
windows are opened or closed, see |winnr()|. windows are opened or closed, see |winnr()|.
@ -142,9 +142,9 @@ that have termcap codes for italics.
*filler-lines* *filler-lines*
The lines after the last buffer line in a window are called filler lines. By The lines after the last buffer line in a window are called filler lines. By
default, these lines start with a tilde (~) character. The 'eob' item in the default, these lines start with a tilde (~) character. The 'eob' item in the
'fillchars' option can be used to change this character. By default, these 'fillchars' option can be used to change this character. By default, these
characters are highlighted as NonText (|hl-NonText|). The EndOfBuffer characters are highlighted as NonText (|hl-NonText|). The EndOfBuffer
highlight group (|hl-EndOfBuffer|) can be used to change the highlighting of highlight group (|hl-EndOfBuffer|) can be used to change the highlighting of
the filler characters. the filler characters.
@ -912,7 +912,7 @@ CTRL-W CTRL-F Split current window in two. Edit file name under cursor.
CTRL-W F *CTRL-W_F* CTRL-W F *CTRL-W_F*
Split current window in two. Edit file name under cursor and Split current window in two. Edit file name under cursor and
jump to the line number following the file name. See |gF| for jump to the line number following the file name. See |gF| for
details on how the line number is obtained. details on how the line number is obtained.
CTRL-W gf *CTRL-W_gf* CTRL-W gf *CTRL-W_gf*
@ -1217,7 +1217,7 @@ list of buffers. |unlisted-buffer|
Actually, the buffer isn't completely deleted, it is removed Actually, the buffer isn't completely deleted, it is removed
from the buffer list |unlisted-buffer| and option values, from the buffer list |unlisted-buffer| and option values,
variables and mappings/abbreviations for the buffer are variables and mappings/abbreviations for the buffer are
cleared. Examples: > cleared. Examples: >
:.,$-bdelete " delete buffers from the current one to :.,$-bdelete " delete buffers from the current one to
" last but one " last but one
:%bdelete " delete all buffers :%bdelete " delete all buffers
@ -1245,7 +1245,7 @@ list of buffers. |unlisted-buffer|
related to the buffer is lost. All marks in this buffer related to the buffer is lost. All marks in this buffer
become invalid, option settings are lost, the jumplist and become invalid, option settings are lost, the jumplist and
tagstack data will be purged, etc. Don't use this tagstack data will be purged, etc. Don't use this
unless you know what you are doing. Examples: > unless you know what you are doing. Examples: >
:.+,$bwipeout " wipe out all buffers after the current :.+,$bwipeout " wipe out all buffers after the current
" one " one
:%bwipeout " wipe out all buffers :%bwipeout " wipe out all buffers
@ -1430,7 +1430,7 @@ help Contains a help file. Will only be created with the |:help|
and can't be changed. The 'buflisted' option will be reset and can't be changed. The 'buflisted' option will be reset
for a help buffer. for a help buffer.
terminal A terminal window buffer, see |terminal|. The contents cannot terminal A terminal window buffer, see |terminal|. The contents cannot
be read or changed until the job ends. be read or changed until the job ends.
directory Displays directory contents. Can be used by a file explorer directory Displays directory contents. Can be used by a file explorer