Skip to content

Commit 7221a1f

Browse files
authored
Merge pull request #412 from vim-jp/update_sign
Update sign.{txt,jax}
2 parents 12b0174 + 0e03b4d commit 7221a1f

File tree

2 files changed

+265
-12
lines changed

2 files changed

+265
-12
lines changed

doc/sign.jax

Lines changed: 140 additions & 8 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 26
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,56 +156,159 @@ 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+
256+
:sign unplace * group={group}
257+
全てのファイルからグループ{group}の設置された全ての目印を解除
258+
する。
259+
260+
:sign unplace * group=*
261+
全てのファイルから全てのグループの設置された全ての目印を解除す
262+
る。
172263

173264
:sign unplace
174-
カーソル位置に設置されている目印を解除する。
265+
カーソル位置の設置された目印を解除する。複数の目印が行内に設置
266+
されている場合は、1つだけが削除される。
267+
268+
:sign unplace group={group}
269+
カーソル位置のグループ{group}の設置された目印を解除する。
270+
271+
:sign unplace group=*
272+
カーソル位置の全てのグループの設置された目印を解除する。
175273

176274

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

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

283+
:sign place group={group} file={fname}
284+
ファイル{fname}に設置されているグループ{group}の目印を一覧表示
285+
する。
286+
287+
:sign place group=* file={fname}
288+
ファイル{fname}に設置されている全てのグループの目印を一覧表示
289+
する。
290+
183291
:sign place buffer={nr}
184292
バッファ{nr}に設置されている目印を一覧表示する。
185293

186-
:sign place 全てのファイルに設置されている全ての目印を一覧表示する。
294+
:sign place group={group} buffer={nr}
295+
バッファ{nr}に設置されているグループ{group}の目印を一覧表示す
296+
る。
297+
298+
:sign place group=* buffer={nr}
299+
バッファ{nr}に設置されている全てのグループの目印を一覧表示す
300+
る。
301+
302+
:sign place 全てのファイルに設置されているグローバルグループの目印を一覧表
303+
示する。
304+
305+
:sign place group={group}
306+
全てのファイルの目印グループ{group}に設置されている目印を一覧
307+
表示する。
308+
309+
:sign place group=*
310+
全てのファイルの全ての目印グループに設置されている目印を一覧表
311+
示する。
187312

188313

189314
(設置した)目印へ移動する *:sign-jump* *E157*
@@ -195,7 +320,14 @@ Netbeansは|netbeans|を参照。
195320
ファイルがウィンドウに表示されておらず、現在のファイルを放棄で
196321
きない時には、これは失敗する。
197322

323+
:sign jump {id} group={group} file={fname}
324+
上に同じだが、グループ{group}の目印に移動する。
325+
198326
:sign jump {id} buffer={nr} *E934*
199-
上に同じ。バッファ {nr} が名前を持っていない場合には失敗する。
327+
上に同じだが、バッファ{nr}を使う。バッファ{nr}が名前を持ってい
328+
ない場合には失敗する。
329+
330+
:sign jump {id} group={group} buffer={nr}
331+
上に同じだが、グループ{group}の目印に移動する。
200332

201333
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)