catboy/catgirl.1

.Dd February  5, 2020
.Dt CATGIRL 1
.Os
.
.Sh NAME
.Nm catgirl
.Nd IRC client
.
.Sh SYNOPSIS
.Nm
.Op Fl ev
.Op Fl a Ar auth
.Op Fl c Ar cert
.Op Fl h Ar host
.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 u Ar user
.Op Fl w Ar pass
.
.Sh DESCRIPTION
The
.Nm
program is a curses
TLS-only IRC client.
.
.Pp
The arguments are as follows:
.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
Connect to
.Ar host .
.
.It Fl j Ar join
Join the comma-separated list of channels
.Ar join .
.
.It Fl k Ar path
Load the TLS client private key from
.Ar path .
.
.It Fl n Ar nick
Set nickname to
.Ar nick .
The default nickname is the user's name.
.
.It Fl p Ar port
Connect to
.Ar port .
The default port is 6697.
.
.It Fl r Ar real
Set realname to
.Ar real .
The default realname is the same as the nickname.
.
.It Fl u Ar user
Set username to
.Ar user .
The default username is the same as the nickname.
.
.It Fl v
Log raw IRC messages to the
.Sy <debug>
window
as well as standard error
if it is not a terminal.
.
.It Fl w Ar pass
Log in with the server password
.Ar pass .
.El
.
.Sh COMMANDS
.Ss Chat Commands
.Bl -tag -width Ds
.It Ic /me Op Ar action
Send an action message.
.It Ic /notice Ar message
Send a notice.
.It Ic /quit Op Ar message
Quit IRC.
.It Ic /quote Ar command
Send a raw IRC command.
.El
.
.Ss UI Commands
.Bl -tag -width Ds
.It Ic /window Ar name
Switch to window by name.
.It Ic /window Ar num , Ic / Ns Ar num
Switch to window by number.
.El