.Dd $Mdocdate$
.Dt SUIKA 1
.Os
.Sh NAME
.Nm suika
.Nd A drunk as hell IRC bouncer, named after Suika Ibuki from Touhou Project
.Sh SYNOPSIS
.Nm
.Op Fl config Ar path
.Op Fl debug
.Op Fl listen Ar uri
.Sh DESCRIPTION
.Nm
is an user-friendly IRC bouncer, it connects to upstream
IRC servers on behalf of the user to provide extra features.
.Bl -tag -width 6n
.It Multiple separate users sharing the same bouncer
.It Clients connecting to multiple upstream servers (via a single connection)
.It Sending the backlog with per-client buffers
.El
.Pp
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.
.Pp
.Nm
supports two connection modes:
.Bl -tag -width 6n
.It Single upstream mode
One downstream connection maps to one upstream connection
.Pp
To enable this mode, connect to the bouncer
with the username "<username>/<network>".
.Pp
If the bouncer isn't connected to the upstream server,
it will get automatically added.
.Pp
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
.Pp
For per-client history to work, clients need to indicate their name.
This can be done by adding a "@<client>" suffix to the username.
.Pp
.Nm
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.
.Pp
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 AUTHORS
.An Simon Ser Aq Mt contact@emersion.fr
.An The soju Contributors
.Sh MAINTAINERS
.An Izuru Yakumo Aq Mt yakumo.izuru@chaotic.ninja