dzwdz
/
catboy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Tag config options in manual 

E.g. ":t debug" will now jump right to the definition just like ":t v"
already did -- at least with mandoc(1) from OpenBSD.
master
Klemens Nanni 2021-05-27 22:35:33 +00:00 committed by C. McEnroe
parent 27a93090bb
commit 37343179a4
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
catgirl.1
View File

@ -83,7 +83,7 @@ following their corresponding flags.
.Pp .Pp
The arguments are as follows: The arguments are as follows:
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl C Ar util , Cm copy = Ar util .It Fl C Ar util | Cm copy = Ar util
Set the utility used by Set the utility used by
.Ic /copy . .Ic /copy .
Use more than once to add arguments to Use more than once to add arguments to
@ -94,7 +94,7 @@ The default is the first available of
.Xr xclip 1 , .Xr xclip 1 ,
.Xr xsel 1 . .Xr xsel 1 .
. .
.It Fl H Ar seed,bound , Cm hash = Ar seed,bound .It Fl H Ar seed,bound | Cm hash = Ar seed,bound
Set the initial seed Set the initial seed
of the nick and channel of the nick and channel
color hash function color hash function
@ -107,7 +107,7 @@ use 0,15.
To disable nick and channel colors, To disable nick and channel colors,
use 0,0. use 0,0.
. .
.It Fl I Ar pattern , Cm highlight = Ar pattern .It Fl I Ar pattern | Cm highlight = Ar pattern
Add a case-insensitive message highlight pattern, Add a case-insensitive message highlight pattern,
which may contain which may contain
.Ql * , .Ql * ,
@ -135,7 +135,7 @@ The commands which can be filtered are:
.Sy QUIT , .Sy QUIT ,
.Sy SETNAME . .Sy SETNAME .
. .
.It Fl K , Cm kiosk .It Fl K | Cm kiosk
Disable the Disable the
.Ic /copy , .Ic /copy ,
.Ic /debug , .Ic /debug ,
@ -151,7 +151,7 @@ commands.
Replace the username Replace the username
with a hash of its original value. with a hash of its original value.
. .
.It Fl N Ar util , Cm notify = Ar util .It Fl N Ar util | Cm notify = Ar util
Send notifications using a utility. Send notifications using a utility.
Use more than once to add arguments to Use more than once to add arguments to
.Ar util . .Ar util .
@ -161,7 +161,7 @@ a title and a description,
appropriate for appropriate for
.Xr notify-send 1 . .Xr notify-send 1 .
. .
.It Fl O Ar util , Cm open = Ar util .It Fl O Ar util | Cm open = Ar util
Set the utility used by Set the utility used by
.Ic /open . .Ic /open .
Use more than once to add arguments to Use more than once to add arguments to
@ -170,7 +170,7 @@ The default is the first available of
.Xr open 1 , .Xr open 1 ,
.Xr xdg-open 1 . .Xr xdg-open 1 .
. .
.It Fl R , Cm restrict .It Fl R | Cm restrict
Disable the Disable the
.Ic /copy , .Ic /copy ,
.Ic /exec .Ic /exec
@ -183,12 +183,12 @@ option,
and viewing this manual with and viewing this manual with
.Ic /help . .Ic /help .
. .
.It Fl S Ar host , Cm bind = Ar host .It Fl S Ar host | Cm bind = Ar host
Bind to source address Bind to source address
.Ar host .Ar host
when connecting to the server. when connecting to the server.
. .
.It Fl T Ar format , Cm timestamp Op = Ar format .It Fl T Ar format | Cm timestamp Op = Ar format
Show timestamps by default, Show timestamps by default,
in the specified in the specified
.Xr strftime 3 .Xr strftime 3
@ -196,7 +196,7 @@ in the specified
The default format is The default format is
.Qq \&%X . .Qq \&%X .
. .
.It Fl a Ar user : Ns Ar pass , Cm sasl-plain = Ar user : Ns Ar pass .It Fl a Ar user : Ns Ar pass | Cm sasl-plain = Ar user : Ns Ar pass
Authenticate as Authenticate as
.Ar user .Ar user
with with
@ -207,7 +207,7 @@ in plain text,
it is recommended to use SASL EXTERNAL instead with it is recommended to use SASL EXTERNAL instead with
.Fl e . .Fl e .
. .
.It Fl c Ar path , Cm cert = Ar path .It Fl c Ar path | Cm cert = Ar path
Load the TLS client certificate from Load the TLS client certificate from
.Ar path . .Ar path .
The The
@ -223,7 +223,7 @@ authenticate using SASL EXTERNAL.
Certificates can be generated with Certificates can be generated with
.Fl g . .Fl g .
. .
.It Fl e , Cm sasl-external .It Fl e | Cm sasl-external
Authenticate using SASL EXTERNAL, Authenticate using SASL EXTERNAL,
also known as CertFP. also known as CertFP.
The TLS client certificate is loaded with The TLS client certificate is loaded with
@ -237,11 +237,11 @@ Generate a TLS client certificate using
and write it to and write it to
.Ar path . .Ar path .
. .
.It Fl h Ar host , Cm host = Ar host .It Fl h Ar host | Cm host = Ar host
Connect to Connect to
.Ar host . .Ar host .
. .
.It Fl i Ar pattern , Cm ignore = Ar pattern .It Fl i Ar pattern | Cm ignore = Ar pattern
Add a case-insensitive message ignore pattern, Add a case-insensitive message ignore pattern,
which may contain which may contain
.Ql * , .Ql * ,
@ -269,13 +269,13 @@ The commands which can be filtered are:
.Sy QUIT , .Sy QUIT ,
.Sy SETNAME . .Sy SETNAME .
. .
.It Fl j Ar channels Oo Ar keys Oc , Cm join = Ar channels Oo Ar keys Oc .It Fl j Ar channels Oo Ar keys Oc | Cm join = Ar channels Oo Ar keys Oc
Join the comma-separated list of Join the comma-separated list of
.Ar channels .Ar channels
with the optional comma-separated list of channel with the optional comma-separated list of channel
.Ar keys . .Ar keys .
. .
.It Fl k Ar path , Cm priv = Ar priv .It Fl k Ar path | Cm priv = Ar priv
Load the TLS client private key from Load the TLS client private key from
.Ar path . .Ar path .
The The
@ -283,11 +283,11 @@ The
is searched for in the same manner is searched for in the same manner
as configuration files. as configuration files.
. .
.It Fl l , Cm log .It Fl l | Cm log
Log chat events to files in paths Log chat events to files in paths
.Pa $XDG_DATA_HOME/catgirl/log/network/channel/YYYY-MM-DD.log . .Pa $XDG_DATA_HOME/catgirl/log/network/channel/YYYY-MM-DD.log .
. .
.It Fl n Ar nick , Cm nick = Ar nick .It Fl n Ar nick | Cm nick = Ar nick
Set nickname to Set nickname to
.Ar nick . .Ar nick .
The default nickname is the user's name. The default nickname is the user's name.
@ -297,17 +297,17 @@ Print the server certificate chain
to standard output in PEM format to standard output in PEM format
and exit. and exit.
. .
.It Fl p Ar port , Cm port = Ar port .It Fl p Ar port | Cm port = Ar port
Connect to Connect to
.Ar port . .Ar port .
The default port is 6697. The default port is 6697.
. .
.It Fl r Ar real , Cm real = Ar real .It Fl r Ar real | Cm real = Ar real
Set realname to Set realname to
.Ar real . .Ar real .
The default realname is the same as the nickname. The default realname is the same as the nickname.
. .
.It Fl s Ar name , Cm save = Ar name .It Fl s Ar name | Cm save = Ar name
Save and load the contents of windows from Save and load the contents of windows from
.Ar name .Ar name
in in
@ -320,7 +320,7 @@ starts with
or or
.Ql \&../ . .Ql \&../ .
. .
.It Fl t Ar path , Cm trust = Ar path .It Fl t Ar path | Cm trust = Ar path
Trust the self-signed certificate Trust the self-signed certificate
loaded from loaded from
.Ar path .Ar path
@ -332,19 +332,19 @@ as configuration files.
See See
.Sx Connecting to Servers with Self-signed Certificates . .Sx Connecting to Servers with Self-signed Certificates .
. .
.It Fl u Ar user , Cm user = Ar user .It Fl u Ar user | Cm user = Ar user
Set username to Set username to
.Ar user . .Ar user .
The default username is the same as the nickname. The default username is the same as the nickname.
. .
.It Fl v , Cm debug .It Fl v | Cm debug
Log raw IRC messages to the Log raw IRC messages to the
.Sy <debug> .Sy <debug>
window window
as well as standard error as well as standard error
if it is not a terminal. if it is not a terminal.
. .
.It Fl w Ar pass , Cm pass = Ar pass .It Fl w Ar pass | Cm pass = Ar pass
Log in with the server password Log in with the server password
.Ar pass . .Ar pass .
.El .El