vim: runtime/doc/sign.txt annotate

annotate runtime/doc/sign.txt @ 15209:3a99b2e6d136 v8.1.0614

patch 8.1.0614: placing signs can be complicated commit https://github.com/vim/vim/commit/162b71479bd4dcdb3a2ef9198a1444f6f99e6843 Author: Bram Moolenaar <Bram@vim.org> Date: Fri Dec 21 15:17:36 2018 +0100 patch 8.1.0614: placing signs can be complicated Problem: Placing signs can be complicated. Solution: Add functions for defining and placing signs. Introduce a group name to avoid different plugins using the same signs. (Yegappan Lakshmanan, closes #3652)

author	Bram Moolenaar <Bram@vim.org>
date	Fri, 21 Dec 2018 15:30:07 +0100
parents	2f7e67dd088c
children	97b40b4c6911

rev	line source
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	1 sign.txt For Vim version 8.1. Last change: 2018 Dec 21
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	2
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	3
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	4 VIM REFERENCE MANUAL by Gordon Prieur
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	5 and Bram Moolenaar
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	6
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	7
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	8 Sign Support Features sign-support
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	9
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	10 1. Introduction \|sign-intro\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	11 2. Commands \|sign-commands\|
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	12
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	13 {Vi does not have any of these features}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	14 {only available when compiled with the \|+signs\| feature}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	15
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	16 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	17 1. Introduction sign-intro signs
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	18
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	19 When a debugger or other IDE tool is driving an editor it needs to be able
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	20 to give specific highlights which quickly tell the user useful information
236 4707450c2b33 updated for version 7.0066 vimboss parents: 7 diff changeset	21 about the file. One example of this would be a debugger which had an icon
4707450c2b33 updated for version 7.0066 vimboss parents: 7 diff changeset	22 in the left-hand column denoting a breakpoint. Another example might be an
4707450c2b33 updated for version 7.0066 vimboss parents: 7 diff changeset	23 arrow representing the Program Counter (PC). The sign features allow both
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	24 placement of a sign, or icon, in the left-hand side of the window and
236 4707450c2b33 updated for version 7.0066 vimboss parents: 7 diff changeset	25 definition of a highlight which will be applied to that line. Displaying the
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	26 sign as an image is most likely only feasible in gvim (although Sun
236 4707450c2b33 updated for version 7.0066 vimboss parents: 7 diff changeset	27 Microsystem's dtterm does support this it's the only terminal emulator I know
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	28 of which does). A text sign and the highlight should be feasible in any color
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	29 terminal emulator.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	30
236 4707450c2b33 updated for version 7.0066 vimboss parents: 7 diff changeset	31 Signs and highlights are not useful just for debuggers. Sun's Visual
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	32 WorkShop uses signs and highlights to mark build errors and SourceBrowser
236 4707450c2b33 updated for version 7.0066 vimboss parents: 7 diff changeset	33 hits. Additionally, the debugger supports 8 to 10 different signs and
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	34 highlight colors. \|workshop\| Same for Netbeans \|netbeans\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	35
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	36 There are two steps in using signs:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	37
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	38 1. Define the sign. This specifies the image, text and highlighting. For
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	39 example, you can define a "break" sign with an image of a stop roadsign and
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	40 text "!!".
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	41
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	42 2. Place the sign. This specifies the file and line number where the sign is
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	43 displayed. A defined sign can be placed several times in different lines
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	44 and files.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	45
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	46 When signs are defined for a file, Vim will automatically add a column of two
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	47 characters to display them in. When the last sign is unplaced the column
9860 9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0 Christian Brabandt <cb@256bit.org> parents: 5908 diff changeset	48 disappears again. This behavior can be changed with the 'signcolumn' option.
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0 Christian Brabandt <cb@256bit.org> parents: 5908 diff changeset	49
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0 Christian Brabandt <cb@256bit.org> parents: 5908 diff changeset	50 The color of the column is set with the SignColumn group \|hl-SignColumn\|.
9eaf8ef656e9 commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0 Christian Brabandt <cb@256bit.org> parents: 5908 diff changeset	51 Example to set the color: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	52
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	53 :highlight SignColumn guibg=darkgrey
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	54 <
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	55 sign-group
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	56 Each sign can be assigned to either the global group or a named group. When
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	57 placing a sign, if a group name is not supplied, or an empty string is used,
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	58 then the sign is placed in the global group. Otherwise the sign is placed in
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	59 the named group. The sign identifier is unique within a group. The sign group
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	60 allows Vim plugins to use unique signs without interfering with other plugins
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	61 using signs.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	62
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	63 sign-priority
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	64 Each placed sign is assigned a priority value. When multiple signs are placed
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	65 on the same line, the attributes of the sign with the highest priority is used
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	66 independent of the sign group. The default priority for a sign is 10. The
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	67 priority is assigned at the time of placing a sign.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	68
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	69 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	70 2. Commands sign-commands :sig :sign
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	71
2152 b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 1702 diff changeset	72 Here is an example that places a sign "piet", displayed with the text ">>", in
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	73 line 23 of the current file: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	74 :sign define piet text=>> texthl=Search
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	75 :exe ":sign place 2 line=23 name=piet file=" . expand("%:p")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	76
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	77 And here is the command to delete it again: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	78 :sign unplace 2
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	79
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	80 Note that the ":sign" command cannot be followed by another command or a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	81 comment. If you do need that, use the \|:execute\| command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	82
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	83
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	84 DEFINING A SIGN. :sign-define E255 E160 E612
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	85
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	86 See \|sign_define()\| for the equivalent Vim script function.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	87
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	88 :sign define {name} {argument}...
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	89 Define a new sign or set attributes for an existing sign.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	90 The {name} can either be a number (all digits) or a name
2608 7d8af31066c8 Updated runtime files and translations. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	91 starting with a non-digit. Leading digits are ignored, thus
7d8af31066c8 Updated runtime files and translations. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	92 "0012", "012" and "12" are considered the same name.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	93 About 120 different signs can be defined.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	94
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	95 Accepted arguments:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	96
3256 ba708ee8d69d Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	97 icon={bitmap}
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	98 Define the file name where the bitmap can be found. Should be
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	99 a full path. The bitmap should fit in the place of two
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	100 characters. This is not checked. If the bitmap is too big it
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	101 will cause redraw problems. Only GTK 2 can scale the bitmap
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	102 to fit the space available.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	103 toolkit supports ~
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	104 GTK 1 pixmap (.xpm)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	105 GTK 2 many
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	106 Motif pixmap (.xpm)
3256 ba708ee8d69d Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	107 Win32 .bmp, .ico, .cur
ba708ee8d69d Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	108 pixmap (.xpm) \|+xpm_w32\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	109
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	110 linehl={group}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	111 Highlighting group used for the whole line the sign is placed
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	112 in. Most useful is defining a background color.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	113
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	114 text={text} E239
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	115 Define the text that is displayed when there is no icon or the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	116 GUI is not being used. Only printable characters are allowed
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	117 and they must occupy one or two display cells.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	118
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	119 texthl={group}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	120 Highlighting group used for the text item.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	121
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	122
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	123 DELETING A SIGN :sign-undefine E155
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	124
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	125 See \|sign_undefine()\| for the equivalent Vim script function.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	126
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	127 :sign undefine {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	128 Deletes a previously defined sign. If signs with this {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	129 are still placed this will cause trouble.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	130
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	131
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	132
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	133 LISTING SIGNS :sign-list E156
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	134
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	135 See \|sign_getdefined()\| for the equivalent Vim script function.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	136
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	137 :sign list Lists all defined signs and their attributes.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	138
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	139 :sign list {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	140 Lists one defined sign and its attributes.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	141
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	142
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	143 PLACING SIGNS :sign-place E158
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	144
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	145 See \|sign_place()\| for the equivalent Vim script function.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	146
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	147 :sign place {id} line={lnum} name={name} file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	148 Place sign defined as {name} at line {lnum} in file {fname}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	149 :sign-fname
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	150 The file {fname} must already be loaded in a buffer. The
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	151 exact file name must be used, wildcards, $ENV and ~ are not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	152 expanded, white space must not be escaped. Trailing white
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	153 space is ignored.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	154
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	155 The sign is remembered under {id}, this can be used for
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	156 further manipulation. {id} must be a number.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	157 It's up to the user to make sure the {id} is used only once in
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	158 each file (if it's used several times unplacing will also have
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	159 to be done several times and making changes may not work as
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	160 expected).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	161
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	162 The following optional sign attributes can be specified before
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	163 "file=":
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	164 group={group} Place sign in sign group {group}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	165 priority={prio} Assign priority {prio} to sign
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	166
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	167 By default, the sign is placed in the global sign group.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	168
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	169 By default, the sign is assigned a default priority of 10. To
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	170 assign a different priority value, use "priority={prio}" to
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	171 specify a value. The priority is used to determine the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	172 highlight group used when multiple signs are placed on the
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	173 same line.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	174
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	175 Examples: >
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	176 :sign place 5 line=3 name=sign1 file=a.py
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	177 :sign place 6 group=g2 line=2 name=sign2 file=x.py
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	178 :sign place 9 group=g2 priority=50 line=5
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	179 \ name=sign1 file=a.py
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	180 <
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	181 :sign place {id} line={lnum} name={name} buffer={nr}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	182 Same, but use buffer {nr}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	183
5908 32de51778c27 Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5510 diff changeset	184 E885
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	185 :sign place {id} name={name} file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	186 Change the placed sign {id} in file {fname} to use the defined
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	187 sign {name}. See remark above about {fname} \|:sign-fname\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	188 This can be used to change the displayed sign without moving
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	189 it (e.g., when the debugger has stopped at a breakpoint).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	190
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	191 The optional "group={group}" attribute can be used before
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	192 "file=" to select a sign in a particular group.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	193
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	194 :sign place {id} name={name} buffer={nr}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	195 Same, but use buffer {nr}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	196
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	197
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	198 REMOVING SIGNS :sign-unplace E159
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	199
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	200 See \|sign_unplace()\| for the equivalent Vim script function.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	201
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	202 :sign unplace {id} file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	203 Remove the previously placed sign {id} from file {fname}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	204 See remark above about {fname} \|:sign-fname\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	205
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	206 :sign unplace {id} group={group} file={fname}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	207 Same but remove the sign {id} in sign group {group}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	208
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	209 :sign unplace {id} group=* file={fname}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	210 Same but remove the sign {id} from all the sign groups.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	211
3672 5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	212 :sign unplace * file={fname}
5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	213 Remove all placed signs in file {fname}.
5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	214
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	215 :sign unplace * group={group} file={fname}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	216 Remove all placed signs in group {group} from file {fname}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	217
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	218 :sign unplace * group=* file={fname}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	219 Remove all placed signs in all the groups from file {fname}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	220
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	221 :sign unplace {id} buffer={nr}
3672 5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	222 Remove the previously placed sign {id} from buffer {nr}.
5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	223
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	224 :sign unplace {id} group={group} buffer={nr}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	225 Remove the previously placed sign {id} in group {group} from
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	226 buffer {nr}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	227
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	228 :sign unplace {id} group=* buffer={nr}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	229 Remove the previously placed sign {id} in all the groups from
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	230 buffer {nr}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	231
3672 5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	232 :sign unplace * buffer={nr}
5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	233 Remove all placed signs in buffer {nr}.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	234
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	235 :sign unplace * group={group} buffer={nr}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	236 Remove all placed signs in group {group} from buffer {nr}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	237
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	238 :sign unplace * group=* buffer={nr}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	239 Remove all placed signs in all the groups from buffer {nr}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	240
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	241 :sign unplace {id}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	242 Remove the previously placed sign {id} from all files it
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	243 appears in.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	244
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	245 :sign unplace {id} group={group}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	246 Remove the previously placed sign {id} in group {group} from
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	247 all files it appears in.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	248
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	249 :sign unplace {id} group=*
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	250 Remove the previously placed sign {id} in all the groups from
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	251 all the files it appears in.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	252
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	253 :sign unplace *
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	254 Remove all placed signs in the global group.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	255
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	256 :sign unplace * group=*
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	257 Remove all placed signs in all the groups.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	258
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	259 :sign unplace
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	260 Remove the placed sign at the cursor position.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	261
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	262
5510 d7d7bac1a163 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	263 LISTING PLACED SIGNS :sign-place-list
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	264
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	265 See \|sign_getplaced()\| for the equivalent Vim script function.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	266
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	267 :sign place file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	268 List signs placed in file {fname}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	269 See remark above about {fname} \|:sign-fname\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	270
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	271 :sign place group={group} file={fname}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	272 List signs in group {group} placed in file {fname}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	273
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	274 :sign place buffer={nr}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	275 List signs placed in buffer {nr}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	276
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	277 :sign place group={group} buffer={nr}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	278 List signs in group {group} placed in buffer {nr}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	279
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	280 :sign place List placed signs in all files.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	281
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	282 :sign place group={group}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	283 List placed signs in all sign groups in all the files.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	284
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	285
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	286 JUMPING TO A SIGN :sign-jump E157
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	287
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	288 :sign jump {id} file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	289 Open the file {fname} or jump to the window that contains
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	290 {fname} and position the cursor at sign {id}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	291 See remark above about {fname} \|:sign-fname\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	292 If the file isn't displayed in window and the current file can
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	293 not be \|abandon\|ed this fails.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	294
9908 2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9860 diff changeset	295 :sign jump {id} buffer={nr} E934
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9860 diff changeset	296 Same, but use buffer {nr}. This fails if buffer {nr} does not
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9860 diff changeset	297 have a name.
2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9860 diff changeset	298
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	299
14421 2f7e67dd088c Update runtime files. Christian Brabandt <cb@256bit.org> parents: 13963 diff changeset	300 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/sign.txt @ 15209:3a99b2e6d136 v8.1.0614