Add more login options to the manual page

master
C. McEnroe 2020-02-01 01:17:15 -05:00
parent 2ce2f493e1
commit f76145645e
1 changed files with 36 additions and 1 deletions

View File

@ -1,4 +1,4 @@
.Dd January 31, 2020 .Dd February 1, 2020
.Dt CATGIRL 1 .Dt CATGIRL 1
.Os .Os
. .
@ -8,8 +8,12 @@
. .
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl e
.Op Fl a Ar auth
.Op Fl c Ar cert
.Op Fl h Ar host .Op Fl h Ar host
.Op Fl j Ar join .Op Fl j Ar join
.Op Fl k Ar priv
.Op Fl n Ar nick .Op Fl n Ar nick
.Op Fl p Ar port .Op Fl p Ar port
.Op Fl r Ar real .Op Fl r Ar real
@ -25,6 +29,33 @@ TLS-only IRC client.
.Pp .Pp
The arguments are as follows: The arguments are as follows:
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl a Ar user Ns : Ns Ar pass
Authenticate as
.Ar user
with
.Ar pass
using SASL PLAIN.
Since this requires the account password
in plain text,
it is recommended to use SASL EXTERNAL instead with
.Fl e .
.
.It Fl c Ar path
Load the TLS client certificate from
.Ar path .
If the private key is in a separate file,
it is loaded with
.Fl k .
With
.Fl e ,
authenticate using SASL EXTERNAL.
.
.It Fl e
Authenticate using SASL EXTERNAL,
also known as CertFP.
The TLS client certificate is loaded with
.Fl c .
.
.It Fl h Ar host .It Fl h Ar host
Connect to Connect to
.Ar host . .Ar host .
@ -33,6 +64,10 @@ Connect to
Join the comma-separated list of channels Join the comma-separated list of channels
.Ar join . .Ar join .
. .
.It Fl k Ar path
Load the TLS client private key from
.Ar path .
.
.It Fl n Ar nick .It Fl n Ar nick
Set nickname to Set nickname to
.Ar nick . .Ar nick .