'\" t
.\"     Title: suika
.\"    Author: Simon Ser and contributors / Izuru Yakumo
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2023-09-15
.\"    Manual: Suika IRC Bouncer
.\"    Source: SUIKA
.\"  Language: English
.\"
.TH "SUIKA" "1" "2023-09-15" "SUIKA" "Suika IRC Bouncer"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
suika \- Drunk as hell IRC bouncer, named after Suika Ibuki from Touhou Project
.SH "SYNOPSIS"
.sp
suika [\-options] ...
.SH "DESCRIPTION"
.sp
suika is an user\-friendly IRC bouncer.
It connects to upstream IRC servers on behalf of the user to provide extra features.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Multiple separate users sharing the same bouncer, each with their own upstream servers
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Clients connecting to multiple upstream servers via a single connection to the bouncer
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
Sending the backlog (messages received while the user was disconnected from the bouncer), with per\-client buffers
.RE
.sp
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.
.sp
suika supports two connection modes:
.sp
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\(cqt 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.
.sp
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.
.sp
For per\-client history to work, clients need to indicate their name.
This can be done by adding a "@<client>" suffix to the username.
.sp
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.
.sp
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"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\-h, \-help
Show help message and quit
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\-config <path>
Path to the config file. If unset, a default config file is used.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\-debug
Enable debug logging (this will leak sensitive information such as passwords)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\-listen <uri>
Listening URI (default ":6697"). Can be specified multiple times.
.RE
.SH "SEE ALSO"
.sp
suikadb(1)
suika\-znc\-import(1)
suika\-config(5)
suika\-bouncerserv(7)
.SH "AUTHOR"
.sp
Simon Ser and contributors / Izuru Yakumo