[PATCH] manual: sync arguments in synopsis with those in list

[PATCH] manual: sync arguments in synopsis with those in list

From: Klemens Nanni
E.g. SYNOPSIS says "-C copy" while the list documents "-C util".
SYNOPSIS uses the config option name as argument, but strictly speaking
that is not the argument, so sync with argument names used in the list.

While here, fix "-T" synopsis (argument is optional).
---
 catgirl.1 | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/catgirl.1 b/catgirl.1
index 03b708e..9fb2d63 100644
--- a/catgirl.1
+++ b/catgirl.1
@@ -9,37 +9,37 @@
 .Sh SYNOPSIS
 .Nm
 .Op Fl KRelv
-.Op Fl C Ar copy
-.Op Fl H Ar hash
-.Op Fl I Ar highlight
-.Op Fl N Ar notify
-.Op Fl O Ar open
-.Op Fl S Ar bind
-.Op Fl T Ar timestamp
-.Op Fl a Ar plain
-.Op Fl c Ar cert
+.Op Fl C Ar util
+.Op Fl H Ar init,bound
+.Op Fl I Ar pattern
+.Op Fl N Ar util
+.Op Fl O Ar util
+.Op Fl S Ar host
+.Op Fl T Op Ar format
+.Op Fl a Ar user : Ns Ar pass
+.Op Fl c Ar path
 .Op Fl h Ar host
-.Op Fl i Ar ignore
+.Op Fl i Ar pattern
 .Op Fl j Ar join
 .Op Fl k Ar priv
 .Op Fl n Ar nick
 .Op Fl p Ar port
 .Op Fl r Ar real
-.Op Fl s Ar save
-.Op Fl t Ar trust
+.Op Fl s Ar name
+.Op Fl t Ar path
 .Op Fl u Ar user
 .Op Fl w Ar pass
 .Op Ar config ...
 .
 .Nm
 .Fl o
-.Op Fl S Ar bind
+.Op Fl S Ar host
 .Op Fl h Ar host
 .Op Fl p Ar port
 .Op Ar config ...
 .
 .Nm
-.Fl g Ar cert
+.Fl g Ar path
 .
 .Sh DESCRIPTION
 The
@@ -182,7 +182,7 @@ Bind to source address
 .Ar host
 when connecting to the server.
 .
-.It Fl T Ar format , Cm timestamp Op = Ar format
+.It Fl T Oo Ar format Oc , Cm timestamp Op = Ar format
 Show timestamps by default,
 in the specified
 .Xr strftime 3
-- 
2.30.0

Re: [PATCH] manual: sync arguments in synopsis with those in list

From: June Bug
> On Feb 4, 2021, at 21:53, Klemens Nanni <klemens@posteo.de> wrote:
> 
> E.g. SYNOPSIS says "-C copy" while the list documents "-C util".
> SYNOPSIS uses the config option name as argument, but strictly speaking
> that is not the argument, so sync with argument names used in the list.

I did the opposite of this, to make the synopsis more useful: the
argument names in the synopsis are the same as the long option
names, which makes it more obvious what -C means, for example, and
makes the definition easier to find by searching “copy”.

> While here, fix "-T" synopsis (argument is optional).

Short options can’t have optional arguments, so the argument actually
is required for the -T form.