Mercurial > vim

comparison runtime/doc/sign.txt @ 15378:0d76dd701e49 v8.1.0697

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
patch 8.1.0697: ":sign place" requires the buffer argument commit https://github.com/vim/vim/commit/b328cca2548936c5f68fff683049a929882f5011 Author: Bram Moolenaar <Bram@vim.org> Date: Sun Jan 6 16:24:01 2019 +0100 patch 8.1.0697: ":sign place" requires the buffer argument Problem: ":sign place" requires the buffer argument. Solution: Make the argument optional. Also update the help and clean up the sign test. (Yegappan Lakshmanan, closes #3767)
author Bram Moolenaar <Bram@vim.org>
date Sun, 06 Jan 2019 16:30:05 +0100
parents 9d3d7b0f4861
children 51b3c36b0523
comparison
equal deleted inserted replaced
15377:88b0a490816e 15378:0d76dd701e49
1 *sign.txt* For Vim version 8.1. Last change: 2019 Jan 01 1 *sign.txt* For Vim version 8.1. Last change: 2019 Jan 06
2 2
3 3
4 VIM REFERENCE MANUAL by Gordon Prieur 4 VIM REFERENCE MANUAL by Gordon Prieur
5 and Bram Moolenaar 5 and Bram Moolenaar
6 6
50 The color of the column is set with the SignColumn group |hl-SignColumn|. 50 The color of the column is set with the SignColumn group |hl-SignColumn|.
51 Example to set the color: > 51 Example to set the color: >
52 52
53 :highlight SignColumn guibg=darkgrey 53 :highlight SignColumn guibg=darkgrey
54 < 54 <
55 *sign-identifier*
56 Each placed sign is identified by a number called the sign identifier. This
57 identifier is used to jump to the sign or to remove the sign. The identifier
58 is assigned when placing the sign using the |sign-place| command or the
59 |sign_place()| function. Each sign identifier should be a unique number. If
60 multiple placed signs use the same identifier, then jumping to or removing a
61 sign becomes unpredictable. To avoid overlapping identifiers, sign groups can
62 be used. The |sign_place()| function can be called with a zero sign identifier
63 to allocate the next available identifier.
64
55 *sign-group* 65 *sign-group*
56 Each sign can be assigned to either the global group or a named group. When 66 Each placed sign can be assigned to either the global group or a named group.
57 placing a sign, if a group name is not supplied, or an empty string is used, 67 When placing a sign, if a group name is not supplied, or an empty string is
58 then the sign is placed in the global group. Otherwise the sign is placed in 68 used, then the sign is placed in the global group. Otherwise the sign is
59 the named group. The sign identifier is unique within a group. The sign group 69 placed in the named group. The sign identifier is unique within a group. The
60 allows Vim plugins to use unique signs without interfering with other plugins 70 sign group allows Vim plugins to use unique signs without interfering with
61 using signs. 71 other plugins using signs.
62 72
63 *sign-priority* 73 *sign-priority*
64 Each placed sign is assigned a priority value. When multiple signs are placed 74 Each placed sign is assigned a priority value. When multiple signs are placed
65 on the same line, the attributes of the sign with the highest priority is used 75 on the same line, the attributes of the sign with the highest priority is used
66 independent of the sign group. The default priority for a sign is 10. The 76 independent of the sign group. The default priority for a sign is 10. The
176 :sign place 5 line=3 name=sign1 file=a.py 186 :sign place 5 line=3 name=sign1 file=a.py
177 :sign place 6 group=g2 line=2 name=sign2 file=x.py 187 :sign place 6 group=g2 line=2 name=sign2 file=x.py
178 :sign place 9 group=g2 priority=50 line=5 188 :sign place 9 group=g2 priority=50 line=5
179 \ name=sign1 file=a.py 189 \ name=sign1 file=a.py
180 < 190 <
181 :sign place {id} line={lnum} name={name} buffer={nr} 191 :sign place {id} line={lnum} name={name} [buffer={nr}]
182 Same, but use buffer {nr}. 192 Same, but use buffer {nr}. If the buffer argument is not
193 given, place the sign in the current buffer.
183 194
184 *E885* 195 *E885*
185 :sign place {id} name={name} file={fname} 196 :sign place {id} name={name} file={fname}
186 Change the placed sign {id} in file {fname} to use the defined 197 Change the placed sign {id} in file {fname} to use the defined
187 sign {name}. See remark above about {fname} |:sign-fname|. 198 sign {name}. See remark above about {fname} |:sign-fname|.
189 it (e.g., when the debugger has stopped at a breakpoint). 200 it (e.g., when the debugger has stopped at a breakpoint).
190 201
191 The optional "group={group}" attribute can be used before 202 The optional "group={group}" attribute can be used before
192 "file=" to select a sign in a particular group. 203 "file=" to select a sign in a particular group.
193 204
194 :sign place {id} name={name} buffer={nr} 205 :sign place {id} name={name} [buffer={nr}]
195 Same, but use buffer {nr}. 206 Same, but use buffer {nr}. If the buffer argument is not
207 given, use the current buffer.
196 208
197 209
198 REMOVING SIGNS *:sign-unplace* *E159* 210 REMOVING SIGNS *:sign-unplace* *E159*
199 211
200 See |sign_unplace()| for the equivalent Vim script function. 212 See |sign_unplace()| for the equivalent Vim script function.
313 not be |abandon|ed this fails. 325 not be |abandon|ed this fails.
314 326
315 :sign jump {id} group={group} file={fname} 327 :sign jump {id} group={group} file={fname}
316 Same but jump to the sign in group {group} 328 Same but jump to the sign in group {group}
317 329
318 :sign jump {id} buffer={nr} *E934* 330 :sign jump {id} [buffer={nr}] *E934*
319 Same, but use buffer {nr}. This fails if buffer {nr} does not 331 Same, but use buffer {nr}. This fails if buffer {nr} does not
320 have a name. 332 have a name. If the buffer argument is not given, use the
321 333 current buffer.
322 :sign jump {id} group={group} buffer={nr} 334
335 :sign jump {id} group={group} [buffer={nr}]
323 Same but jump to the sign in group {group} 336 Same but jump to the sign in group {group}
324 337
325 338
326 vim:tw=78:ts=8:noet:ft=help:norl: 339 vim:tw=78:ts=8:noet:ft=help:norl: