Refer to long option names, prefix commands with $

weechat-hashes
June McEnroe 2021-12-11 20:51:49 -05:00
parent 431230e0ea
commit adff312570
2 changed files with 33 additions and 30 deletions

View File

@ -124,9 +124,9 @@ and
.Lk https://repology.org/project/libretls/versions libretls . .Lk https://repology.org/project/libretls/versions libretls .
. .
.Bd -literal -offset indent .Bd -literal -offset indent
\&./configure $ ./configure
make all $ make all
sudo make install # make install
.Ed .Ed
. .
.Pp .Pp
@ -155,7 +155,7 @@ for
.Nm ./configure .Nm ./configure
to find it. to find it.
.Bd -literal -offset indent .Bd -literal -offset indent
PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure $ PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure
.Ed .Ed
. .
.Pp .Pp
@ -167,8 +167,8 @@ to stop and start
on system sleep and wake. on system sleep and wake.
Install it as follows: Install it as follows:
.Bd -literal -offset indent .Bd -literal -offset indent
make scripts/sandman $ make scripts/sandman
sudo make install-sandman # make install-sandman
.Ed .Ed
. .
.Sh FILES .Sh FILES

View File

@ -135,7 +135,7 @@ The format of the pattern is as follows:
.Ar nick Ns Op Ar !user@host Op Ar command Op Ar channel Op Ar message .Ar nick Ns Op Ar !user@host Op Ar command Op Ar channel Op Ar message
.Ed .Ed
.Pp .Pp
The commands which can be filtered are: The commands which can be matched are:
.Sy INVITE , .Sy INVITE ,
.Sy JOIN , .Sy JOIN ,
.Sy NICK , .Sy NICK ,
@ -196,7 +196,7 @@ and
.Ic /open .Ic /open
commands, commands,
the the
.Fl N .Cm notify
option, option,
and viewing this manual with and viewing this manual with
.Ic /help . .Ic /help .
@ -211,6 +211,8 @@ Show timestamps by default,
in the specified in the specified
.Xr strftime 3 .Xr strftime 3
.Ar format . .Ar format .
The format string may contain
raw IRC formatting codes.
The default format is The default format is
.Qq \&%X . .Qq \&%X .
. .
@ -235,9 +237,9 @@ is searched for in the same manner
as configuration files. as configuration files.
If the private key is in a separate file, If the private key is in a separate file,
it is loaded with it is loaded with
.Fl k . .Cm priv .
With With
.Fl e , .Cm sasl-external ,
authenticate using SASL EXTERNAL. authenticate using SASL EXTERNAL.
Certificates can be generated with Certificates can be generated with
.Fl g . .Fl g .
@ -246,7 +248,7 @@ Certificates can be generated with
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
.Fl c . .Cm cert .
See See
.Sx Configuring CertFP . .Sx Configuring CertFP .
. .
@ -274,7 +276,7 @@ The format of the pattern is as follows:
.Ar nick Ns Op Ar !user@host Op Ar command Op Ar channel Op Ar message .Ar nick Ns Op Ar !user@host Op Ar command Op Ar channel Op Ar message
.Ed .Ed
.Pp .Pp
The commands which can be filtered are: The commands which can be matched are:
.Sy INVITE , .Sy INVITE ,
.Sy JOIN , .Sy JOIN ,
.Sy NICK , .Sy NICK ,
@ -380,13 +382,13 @@ Log in with the server password
.It .It
Generate a new TLS client certificate: Generate a new TLS client certificate:
.Bd -literal -offset indent .Bd -literal -offset indent
catgirl -g ~/.config/catgirl/example.pem $ catgirl -g ~/.config/catgirl/example.pem
.Ed .Ed
.It .It
Connect to the server using the certificate: Connect to the server using the certificate:
.Bd -literal -offset indent .Bd -literal -offset indent
cert = example.pem cert = example.pem
# or: catgirl -c example.pem # or: $ catgirl -c example.pem
.Ed .Ed
.It .It
Identify with services or use Identify with services or use
@ -404,7 +406,7 @@ when connecting
.Bd -literal -offset indent .Bd -literal -offset indent
cert = example.pem cert = example.pem
sasl-external sasl-external
# or: catgirl -e -c example.pem # or: $ catgirl -e -c example.pem
.Ed .Ed
.El .El
. .
@ -414,7 +416,7 @@ sasl-external
Connect to the server Connect to the server
and write its certificate to a file: and write its certificate to a file:
.Bd -literal -offset indent .Bd -literal -offset indent
catgirl -o -h irc.example.org > ~/.config/catgirl/example.pem $ catgirl -o -h irc.example.org > ~/.config/catgirl/example.pem
.Ed .Ed
.It .It
Configure Configure
@ -422,7 +424,7 @@ Configure
to trust the certificate: to trust the certificate:
.Bd -literal -offset indent .Bd -literal -offset indent
trust = example.pem trust = example.pem
# or: catgirl -t example.pem # or: $ catgirl -t example.pem
.Ed .Ed
.El .El
. .
@ -524,13 +526,17 @@ for a list of topics.
.It Ic /highlight Op Ar pattern .It Ic /highlight Op Ar pattern
List message highlight patterns List message highlight patterns
or temporarily add a pattern. or temporarily add a pattern.
To permanently add a pattern, use To permanently add a pattern,
.Fl I . use the
.Cm highlight
option.
.It Ic /ignore Op Ar pattern .It Ic /ignore Op Ar pattern
List message ignore patterns List message ignore patterns
or temporarily add a pattern. or temporarily add a pattern.
To permanently add a pattern, use To permanently add a pattern,
.Fl i . use the
.Cm ignore
option.
.It Ic /move Oo Ar name Oc Ar num .It Ic /move Oo Ar name Oc Ar num
Move the named or current window to number. Move the named or current window to number.
.It Ic /open Op Ar count .It Ic /open Op Ar count
@ -760,13 +766,10 @@ The color numbers are as follows:
.Sh ENVIRONMENT .Sh ENVIRONMENT
.Bl -tag -width Ds .Bl -tag -width Ds
.It Ev SHELL .It Ev SHELL
The path executed by The shell used by
.Ic /exec .Ic /exec .
with The default is
.Fl c Ar command . .Pa /bin/sh .
If unset,
.Pa /bin/sh
is used.
.It Ev USER .It Ev USER
The default nickname. The default nickname.
.El .El
@ -813,7 +816,7 @@ Join
.Li #ascii.town .Li #ascii.town
from the command line: from the command line:
.Bd -literal -offset indent .Bd -literal -offset indent
catgirl -h irc.tilde.chat -j '#ascii.town' $ catgirl -h irc.tilde.chat -j '#ascii.town'
.Ed .Ed
.Pp .Pp
Create a configuration file in Create a configuration file in
@ -825,7 +828,7 @@ join = #ascii.town
.Pp .Pp
Load the configuration file: Load the configuration file:
.Bd -literal -offset indent .Bd -literal -offset indent
catgirl tilde $ catgirl tilde
.Ed .Ed
. .
.Sh STANDARDS .Sh STANDARDS