Skip to content

Commit bfedfdc

Browse files
h-easth-east
committed
Update sign.{txt,jax}
1 parent 6dd10d8 commit bfedfdc

File tree

2 files changed

+202
-7
lines changed

2 files changed

+202
-7
lines changed

‎doc/sign.jax‎

Lines changed: 105 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*sign.txt* For Vim バージョン 8.1. Last change: 2016 Aug 17
1+
*sign.txt* For Vim バージョン 8.1. Last change: 2018 Dec 21
22

33

44
VIMリファレンスマニュアル by Gordon Prieur
@@ -47,6 +47,19 @@ Netbeansは|netbeans|を参照。
4747
う|hl-SignColumn|が設定される。色を設定するには次のようにする: >
4848
4949
:highlight SignColumn guibg=darkgrey
50+
<
51+
*sign-group*
52+
各目印は、グローバルグループまたは名前付きグループのどちらにも割り当てることが
53+
できる。目印を配置するときに、グループ名が指定されていない場合、または空の文字
54+
列が使用されている場合は、目印はグローバルグループに配置される。それ以外の場合
55+
は名前付きグループに配置される。目印の識別子はグループ内で一意である。グループ
56+
を使うと、Vimプラグインは他のプラグインを妨害することなく独自の目印を使うこと
57+
ができる。
58+
59+
*sign-priority*
60+
配置された各目印には、優先順位値が割り当てられる。同じ行に複数の目印が配置され
61+
ている場合、最も優先順位の高い目印の属性が目印のグループとは独立して使用され
62+
る。デフォルトの優先順位は10である。優先順位は、目印の配置時に割り当てられる。
5063

5164
==============================================================================
5265
2. コマンド *sign-commands* *:sig* *:sign*
@@ -65,6 +78,8 @@ Netbeansは|netbeans|を参照。
6578

6679
目印を定義する *:sign-define* *E255* *E160* *E612*
6780

81+
同等のVim script関数については |sign_define()| を参照。
82+
6883
:sign define {name} {argument}...
6984
新しい目印を定義するか既にある目印に属性を設定する。{name}は番
7085
号(全て数字)か非数字で始まる名前である。先導数字は無視されるの
@@ -103,13 +118,18 @@ Netbeansは|netbeans|を参照。
103118

104119
(定義した)目印を削除する *:sign-undefine* *E155*
105120

121+
同等のVim script関数については |sign_undefine()| を参照。
122+
106123
:sign undefine {name}
107124
既に定義された目印を削除する。{name}という名前の目印がまだ設置
108125
されたままの場合はトラブルを引き起こす。
109126

110127

128+
111129
(定義した)目印を一覧表示する *:sign-list* *E156*
112130

131+
同等のVim script関数については |sign_getdefined()| を参照。
132+
113133
:sign list 全部の定義済み目印とその属性を一覧表示する。
114134

115135
:sign list {name}
@@ -118,6 +138,8 @@ Netbeansは|netbeans|を参照。
118138

119139
目印を設置する *:sign-place* *E158*
120140

141+
同等のVim script関数については |sign_place()| を参照。
142+
121143
:sign place {id} line={lnum} name={name} file={fname}
122144
{name}として定義された目印をファイル{fname}の{lnum}行目に設置
123145
する。
@@ -134,57 +156,135 @@ Netbeansは|netbeans|を参照。
134156
も同じ回数だけ行う必要がある。同じ{id}を使うことで目印の位置を
135157
変更しようという試みはうまく行かない)。
136158

159+
次の任意の目印属性は、"file=" の前に指定できる:
160+
group={group} 目印を目印グループ{group}に配置する
161+
priority={prio} 目印に優先順位{prio}を割り当てる
162+
163+
デフォルトでは、目印はグローバル目印グループに配置される。
164+
165+
デフォルトでは、目印にデフォルトの優先順位10が割り当てられてい
166+
る。別の優先順位値を割り当てるには、"priority={prio}" を使用し
167+
て値を指定する。優先順位は、複数の目印が同じ行に配置されている
168+
ときに使用されるハイライトグループを決定するために使用される。
169+
170+
例: >
171+
:sign place 5 line=3 name=sign1 file=a.py
172+
:sign place 6 group=g2 line=2 name=sign2 file=x.py
173+
:sign place 9 group=g2 priority=50 line=5
174+
\ name=sign1 file=a.py
175+
<
137176
:sign place {id} line={lnum} name={name} buffer={nr}
138177
上に同じ。バッファ番号を使用していることが異なる。
139178

179+
*E885*
140180
:sign place {id} name={name} file={fname}
141181
ファイル{fname}に{id}で設置された目印を、{name}で定義されてい
142182
る目印に変更する。{fname}については上述の|:sign-fname|を参照す
143183
ること。
144184
これは既に設置された目印を動かすことなく変更するのに使われる。
145185
(例: デバッガがブレークポイントで停止した時)
146186

147-
*E885*
187+
任意の "group={group}" 属性を "file ="の前に使用して、特定のグ
188+
ループの目印を選択することができる。
189+
148190
:sign place {id} name={name} buffer={nr}
149191
上に同じ。バッファ番号を使用していることが異なる。
150192

151193

152194
(設置した)目印を解除する *:sign-unplace* *E159*
153195

196+
同等のVim script関数については |sign_unplace()| を参照。
197+
154198
:sign unplace {id} file={fname}
155199
ファイル{fname}に{id}で設置された目印を解除する。
156200
{fname}については上述の|:sign-fname|を参照すること。
157201

202+
:sign unplace {id} group={group} file={fname}
203+
上に同じだが、目印グループ{group}の目印{id}を解除する。
204+
205+
:sign unplace {id} group=* file={fname}
206+
上に同じだが、全ての目印グループから目印{id}を解除する。
207+
158208
:sign unplace * file={fname}
159-
ファイル{fname}に設置された目印をすべて解除する。
209+
ファイル{fname}に設置された目印を全て解除する。
210+
211+
:sign unplace * group={group} file={fname}
212+
ファイル{fname}からグループ{group}に配置されている全ての目印を
213+
解除する。
214+
215+
:sign unplace * group=* file={fname}
216+
ファイル{fname}から全てのグループに配置されている全ての目印を
217+
解除する。
160218

161219
:sign unplace {id} buffer={nr}
162220
バッファ{nr}に{id}で設置された目印を解除する。
163221

222+
:sign unplace {id} group={group} buffer={nr}
223+
バッファ{nr}からグループ{group}の以前に配置された目印{id}を解
224+
除する。
225+
226+
:sign unplace {id} group=* buffer={nr}
227+
バッファ{nr}から、全てのグループで以前に配置された目印{id}を解
228+
除する。
229+
164230
:sign unplace * buffer={nr}
165-
バッファ{nr}に設置された目印をすべて解除する。
231+
バッファ{nr}に設置された目印を全て解除する。
232+
233+
:sign unplace * group={group} buffer={nr}
234+
グループ{group}に配置されている全ての目印をバッファ{nr}から解
235+
除する。
236+
237+
:sign unplace * group=* buffer={nr}
238+
全てのグループに配置されている全ての目印をバッファ{nr}から解除
239+
する。
166240

167241
:sign unplace {id}
168242
{id}で設置された目印を、全てのファイルから削除する。
169243

244+
:sign unplace {id} group={group}
245+
表示されている全てのファイルから、グループ{group}の以前に配置
246+
された目印{id}を解除する。
247+
248+
:sign unplace {id} group=*
249+
表示されている全てのファイルから、全てのグループの以前に配置さ
250+
れた目印{id}を解除する。
251+
170252
:sign unplace *
171-
設置された全ての目印を解除する。
253+
グローバルグループの設置された全ての目印を解除する。
254+
255+
:sign unplace * group=*
256+
Remove all placed signs in all the groups.
257+
全てのグループの設置された全ての目印を解除する。
172258

173259
:sign unplace
174260
カーソル位置に設置されている目印を解除する。
175261

176262

177263
(設置した)目印を一覧表示する *:sign-place-list*
178264

265+
同等のVim script関数については |sign_getplaced()| を参照。
266+
179267
:sign place file={fname}
180268
ファイル{fname}に設置されている目印を一覧表示する。
181269
{fname}については上述の|:sign-fname|を参照すること。
182270

271+
:sign place group={group} file={fname}
272+
ファイル{fname}に配置されているグループ{group}の目印を一覧表示
273+
する。
274+
183275
:sign place buffer={nr}
184276
バッファ{nr}に設置されている目印を一覧表示する。
185277

278+
:sign place group={group} buffer={nr}
279+
バッファ{nr}に配置されているグループ{group}の目印を一覧表示す
280+
る。
281+
186282
:sign place 全てのファイルに設置されている全ての目印を一覧表示する。
187283

284+
:sign place group={group}
285+
全てのファイルの全ての目印グループに配置された目印を一覧表示す
286+
る。
287+
188288

189289
(設置した)目印へ移動する *:sign-jump* *E157*
190290

‎en/sign.txt‎

Lines changed: 97 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*sign.txt* For Vim version 8.1. Last change: 2016 Aug 17
1+
*sign.txt* For Vim version 8.1. Last change: 2018 Dec 21
22

33

44
VIM REFERENCE MANUAL by Gordon Prieur
@@ -51,6 +51,20 @@ The color of the column is set with the SignColumn group |hl-SignColumn|.
5151
Example to set the color: >
5252
5353
:highlight SignColumn guibg=darkgrey
54+
<
55+
*sign-group*
56+
Each sign can be assigned to either the global group or a named group. When
57+
placing a sign, if a group name is not supplied, or an empty string is used,
58+
then the sign is placed in the global group. Otherwise the sign is placed in
59+
the named group. The sign identifier is unique within a group. The sign group
60+
allows Vim plugins to use unique signs without interfering with other plugins
61+
using signs.
62+
63+
*sign-priority*
64+
Each placed sign is assigned a priority value. When multiple signs are placed
65+
on the same line, the attributes of the sign with the highest priority is used
66+
independent of the sign group. The default priority for a sign is 10. The
67+
priority is assigned at the time of placing a sign.
5468

5569
==============================================================================
5670
2. Commands *sign-commands* *:sig* *:sign*
@@ -69,6 +83,8 @@ comment. If you do need that, use the |:execute| command.
6983

7084
DEFINING A SIGN. *:sign-define* *E255* *E160* *E612*
7185

86+
See |sign_define()| for the equivalent Vim script function.
87+
7288
:sign define {name} {argument}...
7389
Define a new sign or set attributes for an existing sign.
7490
The {name} can either be a number (all digits) or a name
@@ -106,13 +122,18 @@ DEFINING A SIGN. *:sign-define* *E255* *E160* *E612*
106122

107123
DELETING A SIGN *:sign-undefine* *E155*
108124

125+
See |sign_undefine()| for the equivalent Vim script function.
126+
109127
:sign undefine {name}
110128
Deletes a previously defined sign. If signs with this {name}
111129
are still placed this will cause trouble.
112130

113131

132+
114133
LISTING SIGNS *:sign-list* *E156*
115134

135+
See |sign_getdefined()| for the equivalent Vim script function.
136+
116137
:sign list Lists all defined signs and their attributes.
117138

118139
:sign list {name}
@@ -121,6 +142,8 @@ LISTING SIGNS *:sign-list* *E156*
121142

122143
PLACING SIGNS *:sign-place* *E158*
123144

145+
See |sign_place()| for the equivalent Vim script function.
146+
124147
:sign place {id} line={lnum} name={name} file={fname}
125148
Place sign defined as {name} at line {lnum} in file {fname}.
126149
*:sign-fname*
@@ -136,6 +159,25 @@ PLACING SIGNS *:sign-place* *E158*
136159
to be done several times and making changes may not work as
137160
expected).
138161

162+
The following optional sign attributes can be specified before
163+
"file=":
164+
group={group} Place sign in sign group {group}
165+
priority={prio} Assign priority {prio} to sign
166+
167+
By default, the sign is placed in the global sign group.
168+
169+
By default, the sign is assigned a default priority of 10. To
170+
assign a different priority value, use "priority={prio}" to
171+
specify a value. The priority is used to determine the
172+
highlight group used when multiple signs are placed on the
173+
same line.
174+
175+
Examples: >
176+
:sign place 5 line=3 name=sign1 file=a.py
177+
:sign place 6 group=g2 line=2 name=sign2 file=x.py
178+
:sign place 9 group=g2 priority=50 line=5
179+
\ name=sign1 file=a.py
180+
<
139181
:sign place {id} line={lnum} name={name} buffer={nr}
140182
Same, but use buffer {nr}.
141183

@@ -146,47 +188,100 @@ PLACING SIGNS *:sign-place* *E158*
146188
This can be used to change the displayed sign without moving
147189
it (e.g., when the debugger has stopped at a breakpoint).
148190

191+
The optional "group={group}" attribute can be used before
192+
"file=" to select a sign in a particular group.
193+
149194
:sign place {id} name={name} buffer={nr}
150195
Same, but use buffer {nr}.
151196

152197

153198
REMOVING SIGNS *:sign-unplace* *E159*
154199

200+
See |sign_unplace()| for the equivalent Vim script function.
201+
155202
:sign unplace {id} file={fname}
156203
Remove the previously placed sign {id} from file {fname}.
157204
See remark above about {fname} |:sign-fname|.
158205

206+
:sign unplace {id} group={group} file={fname}
207+
Same but remove the sign {id} in sign group {group}.
208+
209+
:sign unplace {id} group=* file={fname}
210+
Same but remove the sign {id} from all the sign groups.
211+
159212
:sign unplace * file={fname}
160213
Remove all placed signs in file {fname}.
161214

215+
:sign unplace * group={group} file={fname}
216+
Remove all placed signs in group {group} from file {fname}.
217+
218+
:sign unplace * group=* file={fname}
219+
Remove all placed signs in all the groups from file {fname}.
220+
162221
:sign unplace {id} buffer={nr}
163222
Remove the previously placed sign {id} from buffer {nr}.
164223

224+
:sign unplace {id} group={group} buffer={nr}
225+
Remove the previously placed sign {id} in group {group} from
226+
buffer {nr}.
227+
228+
:sign unplace {id} group=* buffer={nr}
229+
Remove the previously placed sign {id} in all the groups from
230+
buffer {nr}.
231+
165232
:sign unplace * buffer={nr}
166233
Remove all placed signs in buffer {nr}.
167234

235+
:sign unplace * group={group} buffer={nr}
236+
Remove all placed signs in group {group} from buffer {nr}.
237+
238+
:sign unplace * group=* buffer={nr}
239+
Remove all placed signs in all the groups from buffer {nr}.
240+
168241
:sign unplace {id}
169242
Remove the previously placed sign {id} from all files it
170243
appears in.
171244

245+
:sign unplace {id} group={group}
246+
Remove the previously placed sign {id} in group {group} from
247+
all files it appears in.
248+
249+
:sign unplace {id} group=*
250+
Remove the previously placed sign {id} in all the groups from
251+
all the files it appears in.
252+
172253
:sign unplace *
173-
Remove all placed signs.
254+
Remove all placed signs in the global group.
255+
256+
:sign unplace * group=*
257+
Remove all placed signs in all the groups.
174258

175259
:sign unplace
176260
Remove the placed sign at the cursor position.
177261

178262

179263
LISTING PLACED SIGNS *:sign-place-list*
180264

265+
See |sign_getplaced()| for the equivalent Vim script function.
266+
181267
:sign place file={fname}
182268
List signs placed in file {fname}.
183269
See remark above about {fname} |:sign-fname|.
184270

271+
:sign place group={group} file={fname}
272+
List signs in group {group} placed in file {fname}.
273+
185274
:sign place buffer={nr}
186275
List signs placed in buffer {nr}.
187276

277+
:sign place group={group} buffer={nr}
278+
List signs in group {group} placed in buffer {nr}.
279+
188280
:sign place List placed signs in all files.
189281

282+
:sign place group={group}
283+
List placed signs in all sign groups in all the files.
284+
190285

191286
JUMPING TO A SIGN *:sign-jump* *E157*
192287

0 commit comments

Comments
 (0)