Skip to content

Commit a76ea52

Browse files
dkearnschrisbra
authored andcommitted
runtime(doc): Use the optional tail command-name spec at :help :sign
closes: #18489 Signed-off-by: Doug Kearns <[email protected]> Signed-off-by: Christian Brabandt <[email protected]>
1 parent da91b51 commit a76ea52

File tree

1 file changed

+43
-43
lines changed

1 file changed

+43
-43
lines changed

runtime/doc/sign.txt

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*sign.txt* For Vim version 9.1. Last change: 2024 Jul 07
1+
*sign.txt* For Vim version 9.1. Last change: 2025 Oct 05
22

33

44
VIM REFERENCE MANUAL by Gordon Prieur
@@ -115,7 +115,7 @@ DEFINING A SIGN. *:sign-define* *E255* *E160* *E612*
115115

116116
See |sign_define()| for the equivalent Vim script function.
117117

118-
:sign define {name} {argument}...
118+
:sig[n] define {name} {argument}...
119119
Define a new sign or set attributes for an existing sign.
120120
The {name} can either be a number (all digits) or a name
121121
starting with a non-digit. Leading zeros are ignored, thus
@@ -168,7 +168,7 @@ DELETING A SIGN *:sign-undefine* *E155*
168168

169169
See |sign_undefine()| for the equivalent Vim script function.
170170

171-
:sign undefine {name}
171+
:sig[n] undefine {name}
172172
Deletes a previously defined sign. If signs with this {name}
173173
are still placed this will cause trouble.
174174

@@ -180,17 +180,17 @@ LISTING SIGNS *:sign-list* *E156*
180180

181181
See |sign_getdefined()| for the equivalent Vim script function.
182182

183-
:sign list Lists all defined signs and their attributes.
183+
:sig[n] list Lists all defined signs and their attributes.
184184

185-
:sign list {name}
185+
:sig[n] list {name}
186186
Lists one defined sign and its attributes.
187187

188188

189189
PLACING SIGNS *:sign-place* *E158*
190190

191191
See |sign_place()| for the equivalent Vim script function.
192192

193-
:sign place {id} line={lnum} name={name} file={fname}
193+
:sig[n] place {id} line={lnum} name={name} file={fname}
194194
Place sign defined as {name} at line {lnum} in file {fname}.
195195
*:sign-fname*
196196
The file {fname} must already be loaded in a buffer. The
@@ -224,7 +224,7 @@ See |sign_place()| for the equivalent Vim script function.
224224
:sign place 9 group=g2 priority=50 line=5
225225
\ name=sign1 file=a.py
226226
<
227-
:sign place {id} line={lnum} name={name} [buffer={nr}]
227+
:sig[n] place {id} line={lnum} name={name} [buffer={nr}]
228228
Same, but use buffer {nr}. If the buffer argument is not
229229
given, place the sign in the current buffer.
230230

@@ -233,7 +233,7 @@ See |sign_place()| for the equivalent Vim script function.
233233
:sign place 10 line=99 name=sign3 buffer=3
234234
<
235235
*E885*
236-
:sign place {id} name={name} file={fname}
236+
:sig[n] place {id} name={name} file={fname}
237237
Change the placed sign {id} in file {fname} to use the defined
238238
sign {name}. See remark above about {fname} |:sign-fname|.
239239
This can be used to change the displayed sign without moving
@@ -247,7 +247,7 @@ See |sign_place()| for the equivalent Vim script function.
247247
Example: >
248248
:sign place 23 name=sign1 file=/path/to/edit.py
249249
<
250-
:sign place {id} name={name} [buffer={nr}]
250+
:sig[n] place {id} name={name} [buffer={nr}]
251251
Same, but use buffer {nr}. If the buffer argument is not
252252
given, use the current buffer.
253253

@@ -260,130 +260,130 @@ REMOVING SIGNS *:sign-unplace* *E159*
260260

261261
See |sign_unplace()| for the equivalent Vim script function.
262262

263-
:sign unplace {id} file={fname}
263+
:sig[n] unplace {id} file={fname}
264264
Remove the previously placed sign {id} from file {fname}.
265265
See remark above about {fname} |:sign-fname|.
266266

267-
:sign unplace {id} group={group} file={fname}
267+
:sig[n] unplace {id} group={group} file={fname}
268268
Same but remove the sign {id} in sign group {group}.
269269

270-
:sign unplace {id} group=* file={fname}
270+
:sig[n] unplace {id} group=* file={fname}
271271
Same but remove the sign {id} from all the sign groups.
272272

273-
:sign unplace * file={fname}
273+
:sig[n] unplace * file={fname}
274274
Remove all placed signs in file {fname}.
275275

276-
:sign unplace * group={group} file={fname}
276+
:sig[n] unplace * group={group} file={fname}
277277
Remove all placed signs in group {group} from file {fname}.
278278

279-
:sign unplace * group=* file={fname}
279+
:sig[n] unplace * group=* file={fname}
280280
Remove all placed signs in all the groups from file {fname}.
281281

282-
:sign unplace {id} buffer={nr}
282+
:sig[n] unplace {id} buffer={nr}
283283
Remove the previously placed sign {id} from buffer {nr}.
284284

285-
:sign unplace {id} group={group} buffer={nr}
285+
:sig[n] unplace {id} group={group} buffer={nr}
286286
Remove the previously placed sign {id} in group {group} from
287287
buffer {nr}.
288288

289-
:sign unplace {id} group=* buffer={nr}
289+
:sig[n] unplace {id} group=* buffer={nr}
290290
Remove the previously placed sign {id} in all the groups from
291291
buffer {nr}.
292292

293-
:sign unplace * buffer={nr}
293+
:sig[n] unplace * buffer={nr}
294294
Remove all placed signs in buffer {nr}.
295295

296-
:sign unplace * group={group} buffer={nr}
296+
:sig[n] unplace * group={group} buffer={nr}
297297
Remove all placed signs in group {group} from buffer {nr}.
298298

299-
:sign unplace * group=* buffer={nr}
299+
:sig[n] unplace * group=* buffer={nr}
300300
Remove all placed signs in all the groups from buffer {nr}.
301301

302-
:sign unplace {id}
302+
:sig[n] unplace {id}
303303
Remove the previously placed sign {id} from all files it
304304
appears in.
305305

306-
:sign unplace {id} group={group}
306+
:sig[n] unplace {id} group={group}
307307
Remove the previously placed sign {id} in group {group} from
308308
all files it appears in.
309309

310-
:sign unplace {id} group=*
310+
:sig[n] unplace {id} group=*
311311
Remove the previously placed sign {id} in all the groups from
312312
all the files it appears in.
313313

314-
:sign unplace *
314+
:sig[n] unplace *
315315
Remove all placed signs in the global group from all the files.
316316

317-
:sign unplace * group={group}
317+
:sig[n] unplace * group={group}
318318
Remove all placed signs in group {group} from all the files.
319319

320-
:sign unplace * group=*
320+
:sig[n] unplace * group=*
321321
Remove all placed signs in all the groups from all the files.
322322

323-
:sign unplace
323+
:sig[n] unplace
324324
Remove a placed sign at the cursor position. If multiple signs
325325
are placed in the line, then only one is removed.
326326

327-
:sign unplace group={group}
327+
:sig[n] unplace group={group}
328328
Remove a placed sign in group {group} at the cursor
329329
position.
330330

331-
:sign unplace group=*
331+
:sig[n] unplace group=*
332332
Remove a placed sign in any group at the cursor position.
333333

334334

335335
LISTING PLACED SIGNS *:sign-place-list*
336336

337337
See |sign_getplaced()| for the equivalent Vim script function.
338338

339-
:sign place file={fname}
339+
:sig[n] place file={fname}
340340
List signs placed in file {fname}.
341341
See remark above about {fname} |:sign-fname|.
342342

343-
:sign place group={group} file={fname}
343+
:sig[n] place group={group} file={fname}
344344
List signs in group {group} placed in file {fname}.
345345

346-
:sign place group=* file={fname}
346+
:sig[n] place group=* file={fname}
347347
List signs in all the groups placed in file {fname}.
348348

349-
:sign place buffer={nr}
349+
:sig[n] place buffer={nr}
350350
List signs placed in buffer {nr}.
351351

352-
:sign place group={group} buffer={nr}
352+
:sig[n] place group={group} buffer={nr}
353353
List signs in group {group} placed in buffer {nr}.
354354

355-
:sign place group=* buffer={nr}
355+
:sig[n] place group=* buffer={nr}
356356
List signs in all the groups placed in buffer {nr}.
357357

358-
:sign place List placed signs in the global group in all files.
358+
:sig[n] place List placed signs in the global group in all files.
359359

360-
:sign place group={group}
360+
:sig[n] place group={group}
361361
List placed signs with sign group {group} in all files.
362362

363-
:sign place group=*
363+
:sig[n] place group=*
364364
List placed signs in all sign groups in all files.
365365

366366

367367
JUMPING TO A SIGN *:sign-jump* *E157*
368368

369369
See |sign_jump()| for the equivalent Vim script function.
370370

371-
:sign jump {id} file={fname}
371+
:sig[n] jump {id} file={fname}
372372
Open the file {fname} or jump to the window that contains
373373
{fname} and position the cursor at sign {id}.
374374
See remark above about {fname} |:sign-fname|.
375375
If the file isn't displayed in window and the current file can
376376
not be |abandon|ed this fails.
377377

378-
:sign jump {id} group={group} file={fname}
378+
:sig[n] jump {id} group={group} file={fname}
379379
Same but jump to the sign in group {group}
380380

381-
:sign jump {id} [buffer={nr}] *E934*
381+
:sig[n] jump {id} [buffer={nr}] *E934*
382382
Same, but use buffer {nr}. This fails if buffer {nr} does not
383383
have a name. If the buffer argument is not given, use the
384384
current buffer.
385385

386-
:sign jump {id} group={group} [buffer={nr}]
386+
:sig[n] jump {id} group={group} [buffer={nr}]
387387
Same but jump to the sign in group {group}
388388

389389

0 commit comments

Comments
 (0)