Re: [hackers] [ii][PATCH] use square brackets for optional -u parameter in man page

From: Hiltjo Posthuma <hiltjo_AT_codemadness.org>
Date: Fri, 2 Sep 2022 10:37:56 +0200

On Thu, Sep 01, 2022 at 01:56:04PM +0000, Tom Schwindl wrote:
> Hi,
>
> On Tue Aug 30, 2022 at 10:43 AM CEST, Petr Vaněk wrote:
> > ---
> > ii.1 | 4 ++--
> > 1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/ii.1 b/ii.1
> > index 8e06af7..db05ab6 100644
> > --- a/ii.1
> > +++ b/ii.1
> > _AT_@ -29,8 +29,8 @@ and ii creates a new channel directory with in and out file.
> > .IR nickname ]
> > .RB [ \-f
> > .IR realname ]
> > -.RB < \-u
> > -.IR sockname >
> > +.RB [ \-u
> > +.IR sockname ]
> > .SH OPTIONS
> > .TP
> > .BI \-s " servername"
> > --
> > 2.35.1
>
> While we're at it, I think we should also remove the angle brackets
> around the `-s' option and sync the names of the arguments with the
> ones used in the usage() function.
> Additionally, the `-u' option is missing in the usage message and a lot
> of unnecessary angle brackets are used, too.
>

I agree.

I don't fully like the man page, because using either the -s or -u option is
mandatory.

Maybe something like: <-s server> | <-u socket>.

-- 
Kind regards,
Hiltjo
Received on Fri Sep 02 2022 - 10:37:56 CEST

This archive was generated by hypermail 2.3.0 : Fri Sep 02 2022 - 10:48:36 CEST