Mercurial > vim

annotate runtime/doc/sign.txt @ 15418:51b3c36b0523 v8.1.0717

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