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