Mercurial > vim

annotate runtime/doc/sign.txt @ 16930:1689b52cf297 v8.1.1466

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