util-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Johannes Altmanninger <aclopte@gmail.com>
To: util-linux@vger.kernel.org
Cc: Johannes Altmanninger <aclopte@gmail.com>
Subject: [PATCH 3/4] kill.1.adoc: clarify syntax of -SIG argument in synopsis
Date: Sun,  6 Feb 2022 07:11:57 +0100	[thread overview]
Message-ID: <20220206061158.752262-3-aclopte@gmail.com> (raw)
In-Reply-To: <20220206061158.752262-1-aclopte@gmail.com>

kill.1.adoc has this synopsis line

	*kill*  [-signal|*-s* _signal_]

For "-signal", the leading "-" should be typed literally, and the
"signal" suffix should be replaced by a signal name/number.
This means that according to GNU man(1), the "-" should render in
bold font whereas the "signal" placeholder should use italic (which
terminals often render with underscores).

Make it so. Use two askerisks because one is not enough for sub-word
markup [*].

[*] https://docs.asciidoctor.org/asciidoc/latest/text/#unconstrained

Signed-off-by: Johannes Altmanninger <aclopte@gmail.com>
---
 misc-utils/kill.1.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/misc-utils/kill.1.adoc b/misc-utils/kill.1.adoc
index afdf345fd..4a6996a38 100644
--- a/misc-utils/kill.1.adoc
+++ b/misc-utils/kill.1.adoc
@@ -17,7 +17,7 @@ kill - terminate a process
 
 == SYNOPSIS
 
-*kill*  [-signal|*-s* _signal_|*-p*]  [*-q* _value_] [*-a*] [*--timeout* _milliseconds_ _signal_] [*--*] _pid_|_name_...
+*kill*  [**-**_signal_|*-s* _signal_|*-p*]  [*-q* _value_] [*-a*] [*--timeout* _milliseconds_ _signal_] [*--*] _pid_|_name_...
 
 *kill* *-l* [_number_] | *-L*
 
-- 
2.35.1.301.gcdacdcff8b.dirty


  parent reply	other threads:[~2022-02-06  6:12 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-06  6:11 [PATCH 1/4] newgrp.1.adoc: use bold font for command name in synopsis Johannes Altmanninger
2022-02-06  6:11 ` [PATCH 2/4] mount.8.adoc: use bold font for literal text " Johannes Altmanninger
2022-02-06  6:11 ` Johannes Altmanninger [this message]
2022-02-06  6:11 ` [PATCH 4/4] getopt.1.adoc: render synopsis rules on separate lines Johannes Altmanninger
2022-02-07 18:42   ` Mario Blättermann
2022-02-07 10:00 ` [PATCH 1/4] newgrp.1.adoc: use bold font for command name in synopsis Karel Zak

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220206061158.752262-3-aclopte@gmail.com \
    --to=aclopte@gmail.com \
    --cc=util-linux@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).