vim: runtime/doc/sign.txt annotate

annotate runtime/doc/sign.txt @ 25219:269f1e0a2cf1

Added tag v8.2.3145 for changeset 645c7963a586cca21c43c05bfb52f67f0de460df

author	Bram Moolenaar <Bram@vim.org>
date	Sun, 11 Jul 2021 16:45:04 +0200
parents	788e10cec9bd
children	29ec2c198c8d

rev	line source
24103 788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	1 sign.txt For Vim version 8.2. Last change: 2021 Mar 07
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\|
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	12 3. Functions \|sign-functions-details\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	13
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
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15418 diff changeset	34 highlight colors, see \|NetBeans\|.
7 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
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15418 diff changeset	46 sign-column
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	47 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	48 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	49 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	50
18615 c4cdc715cb68 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18016 diff changeset	51 The color of the column is set with the SignColumn highlight group
c4cdc715cb68 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18016 diff changeset	52 \|hl-SignColumn\|. Example to set the color: >
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	53
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	54 :highlight SignColumn guibg=darkgrey
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	55 <
15378 0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	56 sign-identifier
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	57 Each placed sign is identified by a number called the sign identifier. This
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	58 identifier is used to jump to the sign or to remove the sign. The identifier
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15418 diff changeset	59 is assigned when placing the sign using the \|:sign-place\| command or the
15378 0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	60 \|sign_place()\| function. Each sign identifier should be a unique number. If
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	61 multiple placed signs use the same identifier, then jumping to or removing a
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	62 sign becomes unpredictable. To avoid overlapping identifiers, sign groups can
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	63 be used. The \|sign_place()\| function can be called with a zero sign identifier
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	64 to allocate the next available identifier.
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	65
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	66 sign-group
15378 0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	67 Each placed sign can be assigned to either the global group or a named group.
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	68 When placing a sign, if a group name is not supplied, or an empty string is
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	69 used, then the sign is placed in the global group. Otherwise the sign is
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	70 placed in the named group. The sign identifier is unique within a group. The
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	71 sign group allows Vim plugins to use unique signs without interfering with
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	72 other plugins using signs.
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	73
18744 b29d8a06e72c patch 8.1.2362: cannot place signs in a popup window Bram Moolenaar <Bram@vim.org> parents: 18719 diff changeset	74 To place a sign in a popup window the group name must start with "PopUp".
b29d8a06e72c patch 8.1.2362: cannot place signs in a popup window Bram Moolenaar <Bram@vim.org> parents: 18719 diff changeset	75 Other signs will not show in a popup window. The group name "PopUpMenu" is
b29d8a06e72c patch 8.1.2362: cannot place signs in a popup window Bram Moolenaar <Bram@vim.org> parents: 18719 diff changeset	76 used by popup windows where 'cursorline' is set.
b29d8a06e72c patch 8.1.2362: cannot place signs in a popup window Bram Moolenaar <Bram@vim.org> parents: 18719 diff changeset	77
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	78 sign-priority
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	79 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	80 on the same line, the attributes of the sign with the highest priority is used
21499 3a1ed539ae2a Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 18879 diff changeset	81 independently of the sign group. The default priority for a sign is 10. The
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	82 priority is assigned at the time of placing a sign.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	83
22824 8dad79c661d1 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22013 diff changeset	84 When two signs with the same priority are present, and one has an icon or text
8dad79c661d1 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22013 diff changeset	85 in the signcolumn while the other has line highlighting, then both are
8dad79c661d1 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22013 diff changeset	86 displayed.
8dad79c661d1 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22013 diff changeset	87
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15418 diff changeset	88 When the line on which the sign is placed is deleted, the sign is moved to the
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15418 diff changeset	89 next line (or the last line of the buffer, if there is no next line). When
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15418 diff changeset	90 the delete is undone the sign does not move back.
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15418 diff changeset	91
22013 125051dff419 patch 8.2.1556: cursorline highlighting always overrules sign highlighting Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	92 When a sign with line highlighting and 'cursorline' highlighting are both
125051dff419 patch 8.2.1556: cursorline highlighting always overrules sign highlighting Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	93 present, if the priority is 100 or more then the sign highlighting takes
125051dff419 patch 8.2.1556: cursorline highlighting always overrules sign highlighting Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	94 precedence, otherwise the 'cursorline' highlighting.
125051dff419 patch 8.2.1556: cursorline highlighting always overrules sign highlighting Bram Moolenaar <Bram@vim.org> parents: 21499 diff changeset	95
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	96 ==============================================================================
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	97 2. Commands sign-commands :sig :sign
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	98
2152 b9e314fe473f Updated runtime files. Bram Moolenaar <bram@zimbu.org> parents: 1702 diff changeset	99 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	100 line 23 of the current file: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	101 :sign define piet text=>> texthl=Search
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	102 :exe ":sign place 2 line=23 name=piet file=" . expand("%:p")
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	103
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	104 And here is the command to delete it again: >
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	105 :sign unplace 2
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	106
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	107 Note that the ":sign" command cannot be followed by another command or a
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	108 comment. If you do need that, use the \|:execute\| command.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	109
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	110
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	111 DEFINING A SIGN. :sign-define E255 E160 E612
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	112
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	113 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	114
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	115 :sign define {name} {argument}...
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	116 Define a new sign or set attributes for an existing sign.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	117 The {name} can either be a number (all digits) or a name
15334 9d3d7b0f4861 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 15300 diff changeset	118 starting with a non-digit. Leading zeros are ignored, thus
2608 7d8af31066c8 Updated runtime files and translations. Bram Moolenaar <bram@vim.org> parents: 2577 diff changeset	119 "0012", "012" and "12" are considered the same name.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	120 About 120 different signs can be defined.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	121
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	122 Accepted arguments:
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	123
3256 ba708ee8d69d Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	124 icon={bitmap}
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	125 Define the file name where the bitmap can be found. Should be
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	126 a full path. The bitmap should fit in the place of two
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	127 characters. This is not checked. If the bitmap is too big it
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	128 will cause redraw problems. Only GTK 2 can scale the bitmap
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	129 to fit the space available.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	130 toolkit supports ~
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	131 GTK 1 pixmap (.xpm)
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	132 GTK 2 many
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	133 Motif pixmap (.xpm)
3256 ba708ee8d69d Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	134 Win32 .bmp, .ico, .cur
ba708ee8d69d Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 2608 diff changeset	135 pixmap (.xpm) \|+xpm_w32\|
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	136
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	137 linehl={group}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	138 Highlighting group used for the whole line the sign is placed
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	139 in. Most useful is defining a background color.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	140
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	141 text={text} E239
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	142 Define the text that is displayed when there is no icon or the
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	143 GUI is not being used. Only printable characters are allowed
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	144 and they must occupy one or two display cells.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	145
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	146 texthl={group}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	147 Highlighting group used for the text item.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	148
24103 788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	149 Example: >
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	150 :sign define MySign text=>> texthl=Search linehl=DiffText
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	151 <
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	152
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	153 DELETING A SIGN :sign-undefine E155
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	154
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	155 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	156
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	157 :sign undefine {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	158 Deletes a previously defined sign. If signs with this {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	159 are still placed this will cause trouble.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	160
24103 788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	161 Example: >
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	162 :sign undefine MySign
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	163 <
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	164
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	165 LISTING SIGNS :sign-list E156
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	166
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	167 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	168
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	169 :sign list Lists all defined signs and their attributes.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	170
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	171 :sign list {name}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	172 Lists one defined sign and its attributes.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	173
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	174
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	175 PLACING SIGNS :sign-place E158
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	176
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	177 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	178
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	179 :sign place {id} line={lnum} name={name} file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	180 Place sign defined as {name} at line {lnum} in file {fname}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	181 :sign-fname
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	182 The file {fname} must already be loaded in a buffer. The
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	183 exact file name must be used, wildcards, $ENV and ~ are not
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	184 expanded, white space must not be escaped. Trailing white
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	185 space is ignored.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	186
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	187 The sign is remembered under {id}, this can be used for
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	188 further manipulation. {id} must be a number.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	189 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	190 each file (if it's used several times unplacing will also have
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	191 to be done several times and making changes may not work as
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	192 expected).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	193
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	194 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	195 "file=":
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	196 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	197 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	198
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	199 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	200
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	201 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	202 assign a different priority value, use "priority={prio}" to
16930 1689b52cf297 patch 8.1.1466: not updating priority on existing sign Bram Moolenaar <Bram@vim.org> parents: 16553 diff changeset	203 specify a value. The priority is used to determine the sign
1689b52cf297 patch 8.1.1466: not updating priority on existing sign Bram Moolenaar <Bram@vim.org> parents: 16553 diff changeset	204 that is displayed when multiple signs are placed on the same
1689b52cf297 patch 8.1.1466: not updating priority on existing sign Bram Moolenaar <Bram@vim.org> parents: 16553 diff changeset	205 line.
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	206
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	207 Examples: >
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	208 :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	209 :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	210 :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	211 \ name=sign1 file=a.py
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	212 <
15378 0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	213 :sign place {id} line={lnum} name={name} [buffer={nr}]
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	214 Same, but use buffer {nr}. If the buffer argument is not
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	215 given, place the sign in the current buffer.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	216
24103 788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	217 Example: >
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	218 :sign place 10 line=99 name=sign3
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	219 :sign place 10 line=99 name=sign3 buffer=3
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	220 <
5908 32de51778c27 Update runtime files. Bram Moolenaar <bram@vim.org> parents: 5510 diff changeset	221 E885
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	222 :sign place {id} name={name} file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	223 Change the placed sign {id} in file {fname} to use the defined
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	224 sign {name}. See remark above about {fname} \|:sign-fname\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	225 This can be used to change the displayed sign without moving
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	226 it (e.g., when the debugger has stopped at a breakpoint).
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	227
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	228 The optional "group={group}" attribute can be used before
16930 1689b52cf297 patch 8.1.1466: not updating priority on existing sign Bram Moolenaar <Bram@vim.org> parents: 16553 diff changeset	229 "file=" to select a sign in a particular group. The optional
1689b52cf297 patch 8.1.1466: not updating priority on existing sign Bram Moolenaar <Bram@vim.org> parents: 16553 diff changeset	230 "priority={prio}" attribute can be used to change the priority
1689b52cf297 patch 8.1.1466: not updating priority on existing sign Bram Moolenaar <Bram@vim.org> parents: 16553 diff changeset	231 of an existing sign.
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	232
24103 788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	233 Example: >
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	234 :sign place 23 name=sign1 file=/path/to/edit.py
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	235 <
15378 0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	236 :sign place {id} name={name} [buffer={nr}]
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	237 Same, but use buffer {nr}. If the buffer argument is not
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	238 given, use the current buffer.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	239
24103 788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	240 Example: >
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	241 :sign place 23 name=sign1
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	242 :sign place 23 name=sign1 buffer=7
788e10cec9bd Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 22824 diff changeset	243 <
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	244
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	245 REMOVING SIGNS :sign-unplace E159
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	246
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	247 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	248
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	249 :sign unplace {id} file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	250 Remove the previously placed sign {id} from file {fname}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	251 See remark above about {fname} \|:sign-fname\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	252
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	253 :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	254 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	255
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	256 :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	257 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	258
3672 5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	259 :sign unplace * file={fname}
5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	260 Remove all placed signs in file {fname}.
5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	261
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	262 :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	263 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	264
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	265 :sign unplace * group=* file={fname}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	266 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	267
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	268 :sign unplace {id} buffer={nr}
3672 5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	269 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	270
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	271 :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	272 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	273 buffer {nr}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	274
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	275 :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	276 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	277 buffer {nr}.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	278
3672 5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	279 :sign unplace * buffer={nr}
5aad2c444a00 updated for version 7.3.596 Bram Moolenaar <bram@vim.org> parents: 3256 diff changeset	280 Remove all placed signs in buffer {nr}.
7 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 unplace * group={group} buffer={nr}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	283 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	284
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	285 :sign unplace * group=* buffer={nr}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	286 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	287
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	288 :sign unplace {id}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	289 Remove the previously placed sign {id} from all files it
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	290 appears in.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	291
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	292 :sign unplace {id} group={group}
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	293 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	294 all files it appears in.
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	295
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	296 :sign unplace {id} group=*
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	297 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	298 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	299
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	300 :sign unplace *
15418 51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command Bram Moolenaar <Bram@vim.org> parents: 15378 diff changeset	301 Remove all placed signs in the global group from all the files.
15300 890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	302
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	303 :sign unplace * group={group}
15418 51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command Bram Moolenaar <Bram@vim.org> parents: 15378 diff changeset	304 Remove all placed signs in group {group} from all the files.
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	305
3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	306 :sign unplace * group=*
15418 51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command Bram Moolenaar <Bram@vim.org> parents: 15378 diff changeset	307 Remove all placed signs in all the groups from all the files.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	308
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	309 :sign unplace
15300 890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	310 Remove a placed sign at the cursor position. If multiple signs
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	311 are placed in the line, then only one is removed.
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	312
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	313 :sign unplace group={group}
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	314 Remove a placed sign in group {group} at the cursor
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	315 position.
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	316
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	317 :sign unplace group=*
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	318 Remove a placed sign in any group at the cursor position.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	319
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	320
5510 d7d7bac1a163 Updated runtime files. Bram Moolenaar <bram@vim.org> parents: 5294 diff changeset	321 LISTING PLACED SIGNS :sign-place-list
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	322
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	323 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	324
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	325 :sign place file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	326 List signs placed in file {fname}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	327 See remark above about {fname} \|:sign-fname\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	328
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	329 :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	330 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	331
15300 890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	332 :sign place group=* file={fname}
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	333 List signs in all the groups placed in file {fname}.
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	334
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	335 :sign place buffer={nr}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	336 List signs placed in buffer {nr}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	337
15209 3a99b2e6d136 patch 8.1.0614: placing signs can be complicated Bram Moolenaar <Bram@vim.org> parents: 14421 diff changeset	338 :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	339 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	340
15300 890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	341 :sign place group=* buffer={nr}
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	342 List signs in all the groups placed in buffer {nr}.
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	343
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	344 :sign place List placed signs in the global group in all files.
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	345
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	346 :sign place group={group}
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	347 List placed signs with sign group {group} in all files.
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	348
15281 97b40b4c6911 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15209 diff changeset	349 :sign place group=*
97b40b4c6911 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15209 diff changeset	350 List placed signs in all sign groups in all files.
97b40b4c6911 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15209 diff changeset	351
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	352
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	353 JUMPING TO A SIGN :sign-jump E157
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	354
15418 51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command Bram Moolenaar <Bram@vim.org> parents: 15378 diff changeset	355 See \|sign_jump()\| for the equivalent Vim script function.
51b3c36b0523 patch 8.1.0717: there is no function for the ":sign jump" command Bram Moolenaar <Bram@vim.org> parents: 15378 diff changeset	356
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	357 :sign jump {id} file={fname}
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	358 Open the file {fname} or jump to the window that contains
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	359 {fname} and position the cursor at sign {id}.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	360 See remark above about {fname} \|:sign-fname\|.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	361 If the file isn't displayed in window and the current file can
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	362 not be \|abandon\|ed this fails.
3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	363
15300 890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	364 :sign jump {id} group={group} file={fname}
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	365 Same but jump to the sign in group {group}
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	366
15378 0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	367 :sign jump {id} [buffer={nr}] E934
9908 2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9860 diff changeset	368 Same, but use buffer {nr}. This fails if buffer {nr} does not
15378 0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	369 have a name. If the buffer argument is not given, use the
0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	370 current buffer.
9908 2b6654519a7c commit https://github.com/vim/vim/commit/7571d55f7dcc009a375b2124cce2c8b21f361234 Christian Brabandt <cb@256bit.org> parents: 9860 diff changeset	371
15378 0d76dd701e49 patch 8.1.0697: ":sign place" requires the buffer argument Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	372 :sign jump {id} group={group} [buffer={nr}]
15300 890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	373 Same but jump to the sign in group {group}
890203d87ee5 patch 8.1.0658: deleting signs and completion for :sign is insufficient Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	374
7 3fc0f57ecb91 updated for version 7.0001 vimboss parents: diff changeset	375
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	376 ==============================================================================
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	377 3. Functions sign-functions-details
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	378
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	379 sign_define({name} [, {dict}]) sign_define()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	380 sign_define({list})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	381 Define a new sign named {name} or modify the attributes of an
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	382 existing sign. This is similar to the \|:sign-define\| command.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	383
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	384 Prefix {name} with a unique text to avoid name collisions.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	385 There is no {group} like with placing signs.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	386
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	387 The {name} can be a String or a Number. The optional {dict}
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	388 argument specifies the sign attributes. The following values
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	389 are supported:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	390 icon full path to the bitmap file for the sign.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	391 linehl highlight group used for the whole line the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	392 sign is placed in.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	393 text text that is displayed when there is no icon
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	394 or the GUI is not being used.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	395 texthl highlight group used for the text item
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	396
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	397 If the sign named {name} already exists, then the attributes
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	398 of the sign are updated.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	399
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	400 The one argument {list} can be used to define a list of signs.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	401 Each list item is a dictionary with the above items in {dict}
18719 99586852c2db Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18615 diff changeset	402 and a "name" item for the sign name.
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	403
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	404 Returns 0 on success and -1 on failure. When the one argument
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	405 {list} is used, then returns a List of values one for each
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	406 defined sign.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	407
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	408 Examples: >
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	409 call sign_define("mySign", {
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	410 \ "text" : "=>",
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	411 \ "texthl" : "Error",
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	412 \ "linehl" : "Search"})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	413 call sign_define([
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	414 \ {'name' : 'sign1',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	415 \ 'text' : '=>'},
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	416 \ {'name' : 'sign2',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	417 \ 'text' : '!!'}
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	418 \ ])
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	419 <
17998 ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	420 Can also be used as a \|method\|: >
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	421 GetSignList()->sign_define()
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	422
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	423 sign_getdefined([{name}]) sign_getdefined()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	424 Get a list of defined signs and their attributes.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	425 This is similar to the \|:sign-list\| command.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	426
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	427 If the {name} is not supplied, then a list of all the defined
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	428 signs is returned. Otherwise the attribute of the specified
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	429 sign is returned.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	430
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	431 Each list item in the returned value is a dictionary with the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	432 following entries:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	433 icon full path to the bitmap file of the sign
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	434 linehl highlight group used for the whole line the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	435 sign is placed in.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	436 name name of the sign
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	437 text text that is displayed when there is no icon
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	438 or the GUI is not being used.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	439 texthl highlight group used for the text item
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	440
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	441 Returns an empty List if there are no signs and when {name} is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	442 not found.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	443
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	444 Examples: >
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	445 " Get a list of all the defined signs
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	446 echo sign_getdefined()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	447
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	448 " Get the attribute of the sign named mySign
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	449 echo sign_getdefined("mySign")
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	450 <
17998 ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	451 Can also be used as a \|method\|: >
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	452 GetSignList()->sign_getdefined()
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	453
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	454 sign_getplaced([{expr} [, {dict}]]) sign_getplaced()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	455 Return a list of signs placed in a buffer or all the buffers.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	456 This is similar to the \|:sign-place-list\| command.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	457
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	458 If the optional buffer name {expr} is specified, then only the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	459 list of signs placed in that buffer is returned. For the use
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	460 of {expr}, see \|bufname()\|. The optional {dict} can contain
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	461 the following entries:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	462 group select only signs in this group
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	463 id select sign with this identifier
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	464 lnum select signs placed in this line. For the use
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	465 of {lnum}, see \|line()\|.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	466 If {group} is '*', then signs in all the groups including the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	467 global group are returned. If {group} is not supplied or is an
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	468 empty string, then only signs in the global group are
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	469 returned. If no arguments are supplied, then signs in the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	470 global group placed in all the buffers are returned.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	471 See \|sign-group\|.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	472
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	473 Each list item in the returned value is a dictionary with the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	474 following entries:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	475 bufnr number of the buffer with the sign
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	476 signs list of signs placed in {bufnr}. Each list
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	477 item is a dictionary with the below listed
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	478 entries
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	479
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	480 The dictionary for each sign contains the following entries:
22824 8dad79c661d1 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22013 diff changeset	481 group sign group. Set to '' for the global group.
8dad79c661d1 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22013 diff changeset	482 id identifier of the sign
8dad79c661d1 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22013 diff changeset	483 lnum line number where the sign is placed
8dad79c661d1 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22013 diff changeset	484 name name of the defined sign
8dad79c661d1 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 22013 diff changeset	485 priority sign priority
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	486
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	487 The returned signs in a buffer are ordered by their line
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	488 number and priority.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	489
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	490 Returns an empty list on failure or if there are no placed
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	491 signs.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	492
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	493 Examples: >
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	494 " Get a List of signs placed in eval.c in the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	495 " global group
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	496 echo sign_getplaced("eval.c")
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	497
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	498 " Get a List of signs in group 'g1' placed in eval.c
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	499 echo sign_getplaced("eval.c", {'group' : 'g1'})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	500
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	501 " Get a List of signs placed at line 10 in eval.c
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	502 echo sign_getplaced("eval.c", {'lnum' : 10})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	503
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	504 " Get sign with identifier 10 placed in a.py
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	505 echo sign_getplaced("a.py", {'id' : 10})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	506
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	507 " Get sign with id 20 in group 'g1' placed in a.py
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	508 echo sign_getplaced("a.py", {'group' : 'g1',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	509 \ 'id' : 20})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	510
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	511 " Get a List of all the placed signs
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	512 echo sign_getplaced()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	513 <
17998 ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	514 Can also be used as a \|method\|: >
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	515 GetBufname()->sign_getplaced()
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	516 <
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	517 sign_jump()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	518 sign_jump({id}, {group}, {expr})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	519 Open the buffer {expr} or jump to the window that contains
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	520 {expr} and position the cursor at sign {id} in group {group}.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	521 This is similar to the \|:sign-jump\| command.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	522
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	523 For the use of {expr}, see \|bufname()\|.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	524
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	525 Returns the line number of the sign. Returns -1 if the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	526 arguments are invalid.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	527
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	528 Example: >
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	529 " Jump to sign 10 in the current buffer
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	530 call sign_jump(10, '', '')
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	531 <
17998 ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	532 Can also be used as a \|method\|: >
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	533 GetSignid()->sign_jump()
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	534 <
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	535 sign_place()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	536 sign_place({id}, {group}, {name}, {expr} [, {dict}])
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	537 Place the sign defined as {name} at line {lnum} in file or
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	538 buffer {expr} and assign {id} and {group} to sign. This is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	539 similar to the \|:sign-place\| command.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	540
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	541 If the sign identifier {id} is zero, then a new identifier is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	542 allocated. Otherwise the specified number is used. {group} is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	543 the sign group name. To use the global sign group, use an
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	544 empty string. {group} functions as a namespace for {id}, thus
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	545 two groups can use the same IDs. Refer to \|sign-identifier\|
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	546 and \|sign-group\| for more information.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	547
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	548 {name} refers to a defined sign.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	549 {expr} refers to a buffer name or number. For the accepted
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	550 values, see \|bufname()\|.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	551
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	552 The optional {dict} argument supports the following entries:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	553 lnum line number in the file or buffer
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	554 {expr} where the sign is to be placed.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	555 For the accepted values, see \|line()\|.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	556 priority priority of the sign. See
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	557 \|sign-priority\| for more information.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	558
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	559 If the optional {dict} is not specified, then it modifies the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	560 placed sign {id} in group {group} to use the defined sign
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	561 {name}.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	562
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	563 Returns the sign identifier on success and -1 on failure.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	564
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	565 Examples: >
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	566 " Place a sign named sign1 with id 5 at line 20 in
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	567 " buffer json.c
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	568 call sign_place(5, '', 'sign1', 'json.c',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	569 \ {'lnum' : 20})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	570
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	571 " Updates sign 5 in buffer json.c to use sign2
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	572 call sign_place(5, '', 'sign2', 'json.c')
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	573
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	574 " Place a sign named sign3 at line 30 in
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	575 " buffer json.c with a new identifier
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	576 let id = sign_place(0, '', 'sign3', 'json.c',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	577 \ {'lnum' : 30})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	578
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	579 " Place a sign named sign4 with id 10 in group 'g3'
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	580 " at line 40 in buffer json.c with priority 90
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	581 call sign_place(10, 'g3', 'sign4', 'json.c',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	582 \ {'lnum' : 40, 'priority' : 90})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	583 <
17998 ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	584 Can also be used as a \|method\|: >
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	585 GetSignid()->sign_place(group, name, expr)
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	586 <
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	587 sign_placelist()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	588 sign_placelist({list})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	589 Place one or more signs. This is similar to the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	590 \|sign_place()\| function. The {list} argument specifies the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	591 List of signs to place. Each list item is a dict with the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	592 following sign attributes:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	593 buffer buffer name or number. For the accepted
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	594 values, see \|bufname()\|.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	595 group sign group. {group} functions as a namespace
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	596 for {id}, thus two groups can use the same
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	597 IDs. If not specified or set to an empty
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	598 string, then the global group is used. See
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	599 \|sign-group\| for more information.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	600 id sign identifier. If not specified or zero,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	601 then a new unique identifier is allocated.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	602 Otherwise the specified number is used. See
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	603 \|sign-identifier\| for more information.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	604 lnum line number in the buffer {expr} where the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	605 sign is to be placed. For the accepted values,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	606 see \|line()\|.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	607 name name of the sign to place. See \|sign_define()\|
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	608 for more information.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	609 priority priority of the sign. When multiple signs are
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	610 placed on a line, the sign with the highest
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	611 priority is used. If not specified, the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	612 default value of 10 is used. See
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	613 \|sign-priority\| for more information.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	614
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	615 If {id} refers to an existing sign, then the existing sign is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	616 modified to use the specified {name} and/or {priority}.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	617
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	618 Returns a List of sign identifiers. If failed to place a
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	619 sign, the corresponding list item is set to -1.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	620
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	621 Examples: >
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	622 " Place sign s1 with id 5 at line 20 and id 10 at line
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	623 " 30 in buffer a.c
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	624 let [n1, n2] = sign_placelist([
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	625 \ {'id' : 5,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	626 \ 'name' : 's1',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	627 \ 'buffer' : 'a.c',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	628 \ 'lnum' : 20},
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	629 \ {'id' : 10,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	630 \ 'name' : 's1',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	631 \ 'buffer' : 'a.c',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	632 \ 'lnum' : 30}
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	633 \ ])
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	634
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	635 " Place sign s1 in buffer a.c at line 40 and 50
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	636 " with auto-generated identifiers
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	637 let [n1, n2] = sign_placelist([
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	638 \ {'name' : 's1',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	639 \ 'buffer' : 'a.c',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	640 \ 'lnum' : 40},
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	641 \ {'name' : 's1',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	642 \ 'buffer' : 'a.c',
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	643 \ 'lnum' : 50}
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	644 \ ])
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	645 <
17998 ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	646 Can also be used as a \|method\|: >
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	647 GetSignlist()->sign_placelist()
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	648
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	649 sign_undefine([{name}]) sign_undefine()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	650 sign_undefine({list})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	651 Deletes a previously defined sign {name}. This is similar to
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	652 the \|:sign-undefine\| command. If {name} is not supplied, then
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	653 deletes all the defined signs.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	654
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	655 The one argument {list} can be used to undefine a list of
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	656 signs. Each list item is the name of a sign.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	657
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	658 Returns 0 on success and -1 on failure. For the one argument
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	659 {list} call, returns a list of values one for each undefined
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	660 sign.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	661
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	662 Examples: >
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	663 " Delete a sign named mySign
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	664 call sign_undefine("mySign")
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	665
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	666 " Delete signs 'sign1' and 'sign2'
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	667 call sign_undefine(["sign1", "sign2"])
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	668
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	669 " Delete all the signs
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	670 call sign_undefine()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	671 <
17998 ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	672 Can also be used as a \|method\|: >
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	673 GetSignlist()->sign_undefine()
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	674
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	675 sign_unplace({group} [, {dict}]) sign_unplace()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	676 Remove a previously placed sign in one or more buffers. This
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	677 is similar to the \|:sign-unplace\| command.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	678
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	679 {group} is the sign group name. To use the global sign group,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	680 use an empty string. If {group} is set to '*', then all the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	681 groups including the global group are used.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	682 The signs in {group} are selected based on the entries in
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	683 {dict}. The following optional entries in {dict} are
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	684 supported:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	685 buffer buffer name or number. See \|bufname()\|.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	686 id sign identifier
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	687 If {dict} is not supplied, then all the signs in {group} are
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	688 removed.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	689
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	690 Returns 0 on success and -1 on failure.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	691
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	692 Examples: >
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	693 " Remove sign 10 from buffer a.vim
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	694 call sign_unplace('', {'buffer' : "a.vim", 'id' : 10})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	695
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	696 " Remove sign 20 in group 'g1' from buffer 3
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	697 call sign_unplace('g1', {'buffer' : 3, 'id' : 20})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	698
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	699 " Remove all the signs in group 'g2' from buffer 10
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	700 call sign_unplace('g2', {'buffer' : 10})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	701
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	702 " Remove sign 30 in group 'g3' from all the buffers
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	703 call sign_unplace('g3', {'id' : 30})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	704
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	705 " Remove all the signs placed in buffer 5
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	706 call sign_unplace('*', {'buffer' : 5})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	707
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	708 " Remove the signs in group 'g4' from all the buffers
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	709 call sign_unplace('g4')
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	710
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	711 " Remove sign 40 from all the buffers
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	712 call sign_unplace('*', {'id' : 40})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	713
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	714 " Remove all the placed signs from all the buffers
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	715 call sign_unplace('*')
17998 ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	716
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	717 < Can also be used as a \|method\|: >
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	718 GetSigngroup()->sign_unplace()
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	719 <
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	720 sign_unplacelist({list}) sign_unplacelist()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	721 Remove previously placed signs from one or more buffers. This
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	722 is similar to the \|sign_unplace()\| function.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	723
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	724 The {list} argument specifies the List of signs to remove.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	725 Each list item is a dict with the following sign attributes:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	726 buffer buffer name or number. For the accepted
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	727 values, see \|bufname()\|. If not specified,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	728 then the specified sign is removed from all
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	729 the buffers.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	730 group sign group name. If not specified or set to an
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	731 empty string, then the global sign group is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	732 used. If set to '*', then all the groups
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	733 including the global group are used.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	734 id sign identifier. If not specified, then all
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	735 the signs in the specified group are removed.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	736
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	737 Returns a List where an entry is set to 0 if the corresponding
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	738 sign was successfully removed or -1 on failure.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	739
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	740 Example: >
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	741 " Remove sign with id 10 from buffer a.vim and sign
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	742 " with id 20 from buffer b.vim
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	743 call sign_unplacelist([
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	744 \ {'id' : 10, 'buffer' : "a.vim"},
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	745 \ {'id' : 20, 'buffer' : 'b.vim'},
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	746 \ ])
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	747 <
17998 ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	748 Can also be used as a \|method\|: >
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	749 GetSignlist()->sign_unplacelist()
ea916dbbb9b9 patch 8.1.1995: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	750 <
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 16944 diff changeset	751
14421 2f7e67dd088c Update runtime files. Christian Brabandt <cb@256bit.org> parents: 13963 diff changeset	752 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/sign.txt @ 25219:269f1e0a2cf1