| 1 | .Dd $Mdocdate$
|
|---|
| 2 | .Dt SUIKA 1
|
|---|
| 3 | .Os
|
|---|
| 4 | .Sh NAME
|
|---|
| 5 | .Nm suika
|
|---|
| 6 | .Nd Drunk as hell IRC bouncer oni.
|
|---|
| 7 | .Sh SYNOPSIS
|
|---|
| 8 | .Nm
|
|---|
| 9 | .Op Fl options
|
|---|
| 10 | .Ar ...
|
|---|
| 11 | .Sh DESCRIPTION
|
|---|
| 12 | suika is an user-friendly IRC bouncer.
|
|---|
| 13 | It connects to upstream IRC servers on
|
|---|
| 14 | behalf of the user to provide extra
|
|---|
| 15 | features.
|
|---|
| 16 |
|
|---|
| 17 | .Bl -tag -width 10n -compact
|
|---|
| 18 | .It *
|
|---|
| 19 | Multiple separate users sharing the same
|
|---|
| 20 | bouncer, each with their own upstream
|
|---|
| 21 | servers
|
|---|
| 22 | .It *
|
|---|
| 23 | Clients connecting to multiple upstream
|
|---|
| 24 | servers via a single connection to the
|
|---|
| 25 | bouncer
|
|---|
| 26 | .It *
|
|---|
| 27 | Sending the backlog (messages received
|
|---|
| 28 | while the user was disconnected from
|
|---|
| 29 | the bouncer), with per-client buffers
|
|---|
| 30 | .El
|
|---|
| 31 |
|
|---|
| 32 | When joining a channel, the channel will
|
|---|
| 33 | be saved and automatically joined on
|
|---|
| 34 | the next connection. When registering
|
|---|
| 35 | or authenticating with NickServ, the
|
|---|
| 36 | credentials will be saved and
|
|---|
| 37 | automatically used on the next
|
|---|
| 38 | connection if the server supports
|
|---|
| 39 | SASL. When parting a channel with
|
|---|
| 40 | the reason "detach", the channel
|
|---|
| 41 | will be detached instead of being
|
|---|
| 42 | left.
|
|---|
| 43 |
|
|---|
| 44 | When all clients are disconnected
|
|---|
| 45 | from the bouncer, the user is
|
|---|
| 46 | automatically marked as away.
|
|---|
| 47 |
|
|---|
| 48 | suika supports two connection modes:
|
|---|
| 49 |
|
|---|
| 50 | .Bl -tag -width 10n -compact
|
|---|
| 51 | .It Single upstream mode
|
|---|
| 52 | one downstream connection maps to one upstream
|
|---|
| 53 | connection. To enable this mode,
|
|---|
| 54 | connect to the bouncer with the username
|
|---|
| 55 | "<username>/<network>".
|
|---|
| 56 | If the bouncer isn't connected to the upstream
|
|---|
| 57 | server, it will get automatically added.
|
|---|
| 58 | Then channels can be joined and
|
|---|
| 59 | parted as if you were directly
|
|---|
| 60 | connected to the upstream server.
|
|---|
| 61 | .It Multiple upstream mode
|
|---|
| 62 | one downstream connection maps to multiple upstream
|
|---|
| 63 | connections.
|
|---|
| 64 | Channels and nicks are suffixed
|
|---|
| 65 | with the network name. To join
|
|---|
| 66 | a channel, you need to use
|
|---|
| 67 | the suffix too:
|
|---|
| 68 | /join #channel/network.
|
|---|
| 69 | Same applies to messages
|
|---|
| 70 | sent to users.
|
|---|
| 71 | .El
|
|---|
| 72 |
|
|---|
| 73 | For per-client history to work, clients need to indicate their name. This can
|
|---|
| 74 | be done by adding a "@<client>" suffix to the username.
|
|---|
| 75 |
|
|---|
| 76 | suika will reload the configuration file, the TLS certificate/key and the MOTD
|
|---|
| 77 | file when it receives the HUP signal. The configuration options listen, db
|
|---|
| 78 | and log cannot be reloaded.
|
|---|
| 79 |
|
|---|
| 80 | Administrators can broadcast a message to all bouncer users via /notice
|
|---|
| 81 | $<hostname> <text>, or via /notice $\* <text> in multi-upstream mode. All
|
|---|
| 82 | currently connected bouncer users will receive the message from the special
|
|---|
| 83 | BouncerServ service.
|
|---|
| 84 |
|
|---|
| 85 | .Sh OPTIONS
|
|---|
| 86 | .Bl -tag -width 11n -compact
|
|---|
| 87 | .It -h, -help
|
|---|
| 88 | Show help message and quit
|
|---|
| 89 | .It -config <path>
|
|---|
| 90 | Path to the config file. If unset, a default config file is used.
|
|---|
| 91 | .It -debug
|
|---|
| 92 | Enable debug logging (this will leak sensitive information
|
|---|
| 93 | such as passwords)
|
|---|
| 94 | .It -listen <uri>
|
|---|
| 95 | Listening URI (default ":6697"). Can be specified multiple times.
|
|---|
| 96 | .El
|
|---|
| 97 | .Sh SEE ALSO
|
|---|
| 98 | .Xr suika-config 5
|
|---|
| 99 | .Xr suika-bouncerserv 7
|
|---|
| 100 | .Sh AUTHORS
|
|---|
| 101 | .An Simon Ser and contributors https://emersion.fr
|
|---|
| 102 | .An Izuru Yakumo Aq Mt yakumo.izuru@chaotic.ninja
|
|---|
