Nvim :help
pages, generated
from source
using the tree-sitter-vimdoc parser.
sign-column
When signs are defined for a file, Vim will automatically add a column of two
characters to display them in. When the last sign is unplaced the column
disappears again. This behavior can be changed with the 'signcolumn' option.:highlight SignColumn guibg=darkgrey
sign-identifier
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
is assigned when placing the sign using the :sign-place command or the
sign_place() function. Each sign identifier should be a unique number (per
buffer). Placing the same identifier twice will move the previously placed
sign. The sign_place() function can be called with a zero sign identifier to
allocate the next available identifier.sign-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
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
sign group allows Vim plugins to use unique signs without interfering with
other plugins using signs.sign-priority
Each placed sign is assigned a priority value 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 definition time. When multiple signs
that each have an icon or text are placed on the same line, signs are ordered
with decreasing priority from left to right, up until the maximum width set in
'signcolumn'. Low priority signs that do not fit are hidden. Highest priority
signs with highlight attributes are always shown.:sign define piet text=>> texthl=Search :exe ":sign place 2 line=23 name=piet file=" .. expand("%:p")And here is the command to delete it again:
:sign unplace 2Note that the ":sign" command cannot be followed by another command or a comment. If you do need that, use the :execute command.
{name}
{argument}
...
Define a new sign or set attributes for an existing sign.
The {name}
can either be a number (all digits) or a name
starting with a non-digit. Leading zeros are ignored, thus
"0012", "012" and "12" are considered the same name.
About 120 different signs can be defined.E239
Define the text that is displayed when there is no icon or the
GUI is not being used. Only printable characters are allowed
and they must occupy one or two display cells.:sign define MySign text=>> texthl=Search linehl=DiffText
:sign-undefine
E155
{name}
Deletes a previously defined sign. If signs with this {name}
are still placed this will cause trouble.:sign undefine MySign
{name}
Lists one defined sign and its attributes.{id}
line={lnum} name={name} file={fname}
Place sign defined as {name}
at line {lnum}
in file {fname}
.
:sign-fname
The file {fname}
must already be loaded in a buffer. The
exact file name must be used, wildcards, $ENV and ~ are not
expanded, white space must not be escaped. Trailing white
space is ignored.{id}
, this can be used for
further manipulation. {id}
must be a number. Placing the
same {id}
multiple times will move the sign.{group}
priority={prio} Assign priority {prio}
to sign:sign place 5 line=3 name=sign1 file=a.py :sign place 6 group=g2 line=2 name=sign2 file=x.py :sign place 9 group=g2 priority=50 line=5 \ name=sign1 file=a.py
{id}
line={lnum} name={name} [buffer={nr}]
Same, but use buffer {nr}
. If the buffer argument is not
given, place the sign in the current buffer.:sign place 10 line=99 name=sign3 :sign place 10 line=99 name=sign3 buffer=3
E885
:sign place {id}
name={name} file={fname}
Change the placed sign {id}
in file {fname}
to use the defined
sign {name}
. See remark above about {fname}
:sign-fname.
This can be used to change the displayed sign without moving
it (e.g., when the debugger has stopped at a breakpoint).:sign place 23 name=sign1 file=/path/to/edit.py
{id}
name={name} [buffer={nr}]
Same, but use buffer {nr}
. If the buffer argument is not
given, use the current buffer.:sign place 23 name=sign1 :sign place 23 name=sign1 buffer=7
{id}
file={fname}
Remove the previously placed sign {id}
from file {fname}
.
See remark above about {fname}
:sign-fname.{id}
group={group} file={fname}
Same but remove the sign {id}
in sign group {group}
.{id}
group=* file={fname}
Same but remove the sign {id}
from all the sign groups.{fname}
.{group}
from file {fname}
.{fname}
.{id}
buffer={nr}
Remove the previously placed sign {id}
from buffer {nr}
.{id}
group={group} buffer={nr}
Remove the previously placed sign {id}
in group {group}
from
buffer {nr}
.{id}
group=* buffer={nr}
Remove the previously placed sign {id}
in all the groups from
buffer {nr}
.{nr}
.{group}
from buffer {nr}
.{nr}
.{id}
Remove the previously placed sign {id}
from all files it
appears in.{id}
group={group}
Remove the previously placed sign {id}
in group {group}
from
all files it appears in.{id}
group=*
Remove the previously placed sign {id}
in all the groups from
all the files it appears in.{group}
from all the files.{group}
at the cursor
position.{fname}
.
See remark above about {fname}
:sign-fname.{group}
placed in file {fname}
.{fname}
.{nr}
.{group}
placed in buffer {nr}
.{nr}
.{group}
in all files.:sign-jump
E157
{id}
file={fname}
Open the file {fname}
or jump to the window that contains
{fname}
and position the cursor at sign {id}
.
See remark above about {fname}
:sign-fname.
If the file isn't displayed in window and the current file can
not be abandoned this fails.{id}
group={group} file={fname}
Same but jump to the sign in group {group}
{id}
[buffer={nr}] E934
Same, but use buffer {nr}
. This fails if buffer {nr}
does not
have a name. If the buffer argument is not given, use the
current buffer.{id}
group={group} [buffer={nr}]
Same but jump to the sign in group {group}