8ebdc7f3ad
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja> git-svn-id: https://svn.yakumo.dev/yakumo.izuru/suika/trunk@817 f0ae65fe-ee39-954e-97ec-027ff2717ef4
103 lines
2.8 KiB
Groff
103 lines
2.8 KiB
Groff
.Dd $Mdocdate$
|
|
.Dt SUIKA 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm suika
|
|
.Nd Drunk as hell IRC bouncer oni.
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl options
|
|
.Ar ...
|
|
.Sh DESCRIPTION
|
|
suika is an user-friendly IRC bouncer.
|
|
It connects to upstream IRC servers on
|
|
behalf of the user to provide extra
|
|
features.
|
|
|
|
.Bl -tag -width 10n -compact
|
|
.It *
|
|
Multiple separate users sharing the same
|
|
bouncer, each with their own upstream
|
|
servers
|
|
.It *
|
|
Clients connecting to multiple upstream
|
|
servers via a single connection to the
|
|
bouncer
|
|
.It *
|
|
Sending the backlog (messages received
|
|
while the user was disconnected from
|
|
the bouncer), with per-client buffers
|
|
.El
|
|
|
|
When joining a channel, the channel will
|
|
be saved and automatically joined on
|
|
the next connection. When registering
|
|
or authenticating with NickServ, the
|
|
credentials will be saved and
|
|
automatically used on the next
|
|
connection if the server supports
|
|
SASL. When parting a channel with
|
|
the reason "detach", the channel
|
|
will be detached instead of being
|
|
left.
|
|
|
|
When all clients are disconnected
|
|
from the bouncer, the user is
|
|
automatically marked as away.
|
|
|
|
suika supports two connection modes:
|
|
|
|
.Bl -tag -width 10n -compact
|
|
.It Single upstream mode
|
|
one downstream connection maps to one upstream
|
|
connection. To enable this mode,
|
|
connect to the bouncer with the username
|
|
"<username>/<network>".
|
|
If the bouncer isn't connected to the upstream
|
|
server, it will get automatically added.
|
|
Then channels can be joined and
|
|
parted as if you were directly
|
|
connected to the upstream server.
|
|
.It Multiple upstream mode
|
|
one downstream connection maps to multiple upstream
|
|
connections.
|
|
Channels and nicks are suffixed
|
|
with the network name. To join
|
|
a channel, you need to use
|
|
the suffix too:
|
|
/join #channel/network.
|
|
Same applies to messages
|
|
sent to users.
|
|
.El
|
|
|
|
For per-client history to work, clients need to indicate their name. This can
|
|
be done by adding a "@<client>" suffix to the username.
|
|
|
|
suika will reload the configuration file, the TLS certificate/key and the MOTD
|
|
file when it receives the HUP signal. The configuration options listen, db
|
|
and log cannot be reloaded.
|
|
|
|
Administrators can broadcast a message to all bouncer users via /notice
|
|
$<hostname> <text>, or via /notice $\* <text> in multi-upstream mode. All
|
|
currently connected bouncer users will receive the message from the special
|
|
BouncerServ service.
|
|
|
|
.Sh OPTIONS
|
|
.Bl -tag -width 11n -compact
|
|
.It -h, -help
|
|
Show help message and quit
|
|
.It -config <path>
|
|
Path to the config file. If unset, a default config file is used.
|
|
.It -debug
|
|
Enable debug logging (this will leak sensitive information
|
|
such as passwords)
|
|
.It -listen <uri>
|
|
Listening URI (default ":6697"). Can be specified multiple times.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr suika-config 5
|
|
.Xr suika-bouncerserv 7
|
|
.Sh AUTHORS
|
|
.An Simon Ser and contributors https://emersion.fr
|
|
.An Izuru Yakumo Aq Mt yakumo.izuru@chaotic.ninja
|