Index | Thread | Search

From:
"H. Hartzer" <h@hartzer.sh>
Subject:
Re: [PATCH] man 1 pkill: Add where signals can be found
To:
"Ingo Schwarze" <schwarze@usta.de>
Cc:
<tech@openbsd.org>
Date:
Sun, 20 Apr 2025 03:55:13 +0000

Download raw body.

Thread
Hi Ingo,

> Ingo Schwarze wrote:
>
> I like the basic idea.  The kill(1) manual page also refers
> to sigaction(2) near the end of the DESCRIPTION, and kill(2)
> even does that at the beginning of the DESCRIPTION.
>
> Indeed, the purpose of the existing .Xr may not be obvious
> to less experienced users.
>
> We generally don't want to talk about "you" in manual pages, though,
> so here is what i suggest.
>
> Since "TERM" is a string that has to be typed in verbatim, it should
> appear in bold face, and actually, a dash has to be typed in front of it,
> which is exactly what the .Fl macro does.  That macro also makes sense
> semantically because "-TERM" clearly serves the function of a command
> line flag.
>
> OK?
>   Ingo
>
>
> Index: pkill.1
> ===================================================================
> RCS file: /cvs/src/usr.bin/pkill/pkill.1,v
> diff -u -r1.25 pkill.1
> --- pkill.1	14 Nov 2020 14:06:42 -0000	1.25
> +++ pkill.1	19 Apr 2025 20:28:48 -0000
> @@ -166,8 +166,10 @@
>  is given.
>  The default is to match any substring.
>  .It Fl Ar signal
> -A non-negative decimal number or symbolic signal name specifying the signal
> -to be sent instead of the default TERM.
> +A non-negative decimal number or one of the symbolic names listed in
> +.Xr sigaction 2
> +specifying the signal to be sent instead of the default
> +.Fl TERM .
>  This option is valid only when given as the first argument to
>  .Nm pkill .
>  .El

That's good to know about the man page syntax. I'm certainly no expert
in that domain.

I like your patch much better. Let's go with that.

Thanks!

-Henrich