| 1 | = suika(1)
|
|---|
| 2 | Simon Ser and contributors / Izuru Yakumo
|
|---|
| 3 | v0.4.3
|
|---|
| 4 | :doctype: manpage
|
|---|
| 5 | :manmanual: Suika IRC Bouncer
|
|---|
| 6 | :mansource: SUIKA
|
|---|
| 7 |
|
|---|
| 8 | == Name
|
|---|
| 9 | suika - Drunk as hell IRC bouncer, named after Suika Ibuki from Touhou Project
|
|---|
| 10 |
|
|---|
| 11 | == Synopsis
|
|---|
| 12 | suika [-options] ...
|
|---|
| 13 |
|
|---|
| 14 | == Description
|
|---|
| 15 | suika is an user-friendly IRC bouncer.
|
|---|
| 16 | It connects to upstream IRC servers on behalf of the user to provide extra features.
|
|---|
| 17 |
|
|---|
| 18 | * Multiple separate users sharing the same bouncer, each with their own upstream servers
|
|---|
| 19 | * Clients connecting to multiple upstream servers via a single connection to the bouncer
|
|---|
| 20 | * Sending the backlog (messages received while the user was disconnected from the bouncer), with per-client buffers
|
|---|
| 21 |
|
|---|
| 22 | When joining a channel, the channel will be saved and automatically joined on the next connection.
|
|---|
| 23 | When registering or authenticating with NickServ, the credentials will be saved and automatically used on the next connection if the server supports SASL.
|
|---|
| 24 | When parting a channel with the reason "detach", the channel will be detached instead of being left.
|
|---|
| 25 | When all clients are disconnected from the bouncer, the user is automatically marked as away.
|
|---|
| 26 |
|
|---|
| 27 | suika supports two connection modes:
|
|---|
| 28 |
|
|---|
| 29 | Single upstream mode: one downstream connection maps to one upstream connection. To enable this mode, connect to the bouncer with the username "<username>/<network>".
|
|---|
| 30 | If the bouncer isn't connected to the upstream server, it will get automatically added.
|
|---|
| 31 | Then channels can be joined and parted as if you were directly connected to the upstream server.
|
|---|
| 32 |
|
|---|
| 33 | Multiple upstream mode: one downstream connection maps to multiple upstream connections.
|
|---|
| 34 | Channels and nicks are suffixed with the network name.
|
|---|
| 35 | To join a channel, you need to use the suffix too: /join #channel/network.
|
|---|
| 36 | Same applies to messages sent to users.
|
|---|
| 37 |
|
|---|
| 38 | For per-client history to work, clients need to indicate their name.
|
|---|
| 39 | This can be done by adding a "@<client>" suffix to the username.
|
|---|
| 40 |
|
|---|
| 41 | suika will reload the configuration file, the TLS certificate/key and the MOTD file when it receives the HUP signal.
|
|---|
| 42 | The configuration options listen, db and log cannot be reloaded.
|
|---|
| 43 |
|
|---|
| 44 | Administrators can broadcast a message to all bouncer users via /notice $<hostname> <text>, or via /notice $<text> in multi-upstream mode.
|
|---|
| 45 | All currently connected bouncer users will receive the message from the special BouncerServ service.
|
|---|
| 46 |
|
|---|
| 47 | == Options
|
|---|
| 48 | * -h, -help
|
|---|
| 49 | Show help message and quit
|
|---|
| 50 | * -config <path>
|
|---|
| 51 | Path to the config file. If unset, a default config file is used.
|
|---|
| 52 | * -debug
|
|---|
| 53 | Enable debug logging (this will leak sensitive information such as passwords)
|
|---|
| 54 | * -listen <uri>
|
|---|
| 55 | Listening URI (default ":6697"). Can be specified multiple times.
|
|---|
| 56 |
|
|---|
| 57 | == See Also
|
|---|
| 58 | suikadb(1)
|
|---|
| 59 | suika-znc-import(1)
|
|---|
| 60 | suika-config(5)
|
|---|
| 61 | suika-bouncerserv(7)
|
|---|
