]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
kill.1.adoc: clarify syntax of -SIG argument in synopsis
authorJohannes Altmanninger <aclopte@gmail.com>
Sun, 6 Feb 2022 06:11:57 +0000 (07:11 +0100)
committerKarel Zak <kzak@redhat.com>
Mon, 7 Feb 2022 09:52:05 +0000 (10:52 +0100)
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

index afdf345fd5d2fcb58d511c5159a2ae81e51d21c5..4a6996a38015dc5945b14989f4ad76c8d4df5786 100644 (file)
@@ -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*