| 1 | '\" t
|
|---|
| 2 | .\" Title: suika
|
|---|
| 3 | .\" Author: Simon Ser and contributors / Izuru Yakumo
|
|---|
| 4 | .\" Generator: Asciidoctor 2.0.20
|
|---|
| 5 | .\" Date: 2023-09-15
|
|---|
| 6 | .\" Manual: Suika IRC Bouncer
|
|---|
| 7 | .\" Source: SUIKA
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "SUIKA" "1" "2023-09-15" "SUIKA" "Suika IRC Bouncer"
|
|---|
| 11 | .ie \n(.g .ds Aq \(aq
|
|---|
| 12 | .el .ds Aq '
|
|---|
| 13 | .ss \n[.ss] 0
|
|---|
| 14 | .nh
|
|---|
| 15 | .ad l
|
|---|
| 16 | .de URL
|
|---|
| 17 | \fI\\$2\fP <\\$1>\\$3
|
|---|
| 18 | ..
|
|---|
| 19 | .als MTO URL
|
|---|
| 20 | .if \n[.g] \{\
|
|---|
| 21 | . mso www.tmac
|
|---|
| 22 | . am URL
|
|---|
| 23 | . ad l
|
|---|
| 24 | . .
|
|---|
| 25 | . am MTO
|
|---|
| 26 | . ad l
|
|---|
| 27 | . .
|
|---|
| 28 | . LINKSTYLE blue R < >
|
|---|
| 29 | .\}
|
|---|
| 30 | .SH "NAME"
|
|---|
| 31 | suika \- Drunk as hell IRC bouncer, named after Suika Ibuki from Touhou Project
|
|---|
| 32 | .SH "SYNOPSIS"
|
|---|
| 33 | .sp
|
|---|
| 34 | suika [\-options] ...
|
|---|
| 35 | .SH "DESCRIPTION"
|
|---|
| 36 | .sp
|
|---|
| 37 | suika is an user\-friendly IRC bouncer.
|
|---|
| 38 | It connects to upstream IRC servers on behalf of the user to provide extra features.
|
|---|
| 39 | .sp
|
|---|
| 40 | .RS 4
|
|---|
| 41 | .ie n \{\
|
|---|
| 42 | \h'-04'\(bu\h'+03'\c
|
|---|
| 43 | .\}
|
|---|
| 44 | .el \{\
|
|---|
| 45 | . sp -1
|
|---|
| 46 | . IP \(bu 2.3
|
|---|
| 47 | .\}
|
|---|
| 48 | Multiple separate users sharing the same bouncer, each with their own upstream servers
|
|---|
| 49 | .RE
|
|---|
| 50 | .sp
|
|---|
| 51 | .RS 4
|
|---|
| 52 | .ie n \{\
|
|---|
| 53 | \h'-04'\(bu\h'+03'\c
|
|---|
| 54 | .\}
|
|---|
| 55 | .el \{\
|
|---|
| 56 | . sp -1
|
|---|
| 57 | . IP \(bu 2.3
|
|---|
| 58 | .\}
|
|---|
| 59 | Clients connecting to multiple upstream servers via a single connection to the bouncer
|
|---|
| 60 | .RE
|
|---|
| 61 | .sp
|
|---|
| 62 | .RS 4
|
|---|
| 63 | .ie n \{\
|
|---|
| 64 | \h'-04'\(bu\h'+03'\c
|
|---|
| 65 | .\}
|
|---|
| 66 | .el \{\
|
|---|
| 67 | . sp -1
|
|---|
| 68 | . IP \(bu 2.3
|
|---|
| 69 | .\}
|
|---|
| 70 | Sending the backlog (messages received while the user was disconnected from the bouncer), with per\-client buffers
|
|---|
| 71 | .RE
|
|---|
| 72 | .sp
|
|---|
| 73 | When joining a channel, the channel will be saved and automatically joined on the next connection.
|
|---|
| 74 | When registering or authenticating with NickServ, the credentials will be saved and automatically used on the next connection if the server supports SASL.
|
|---|
| 75 | When parting a channel with the reason "detach", the channel will be detached instead of being left.
|
|---|
| 76 | When all clients are disconnected from the bouncer, the user is automatically marked as away.
|
|---|
| 77 | .sp
|
|---|
| 78 | suika supports two connection modes:
|
|---|
| 79 | .sp
|
|---|
| 80 | Single upstream mode: one downstream connection maps to one upstream connection. To enable this mode, connect to the bouncer with the username "<username>/<network>".
|
|---|
| 81 | If the bouncer isn\(cqt connected to the upstream server, it will get automatically added.
|
|---|
| 82 | Then channels can be joined and parted as if you were directly connected to the upstream server.
|
|---|
| 83 | .sp
|
|---|
| 84 | Multiple upstream mode: one downstream connection maps to multiple upstream connections.
|
|---|
| 85 | Channels and nicks are suffixed with the network name.
|
|---|
| 86 | To join a channel, you need to use the suffix too: /join #channel/network.
|
|---|
| 87 | Same applies to messages sent to users.
|
|---|
| 88 | .sp
|
|---|
| 89 | For per\-client history to work, clients need to indicate their name.
|
|---|
| 90 | This can be done by adding a "@<client>" suffix to the username.
|
|---|
| 91 | .sp
|
|---|
| 92 | suika will reload the configuration file, the TLS certificate/key and the MOTD file when it receives the HUP signal.
|
|---|
| 93 | The configuration options listen, db and log cannot be reloaded.
|
|---|
| 94 | .sp
|
|---|
| 95 | Administrators can broadcast a message to all bouncer users via /notice $<hostname> <text>, or via /notice $<text> in multi\-upstream mode.
|
|---|
| 96 | All currently connected bouncer users will receive the message from the special BouncerServ service.
|
|---|
| 97 | .SH "OPTIONS"
|
|---|
| 98 | .sp
|
|---|
| 99 | .RS 4
|
|---|
| 100 | .ie n \{\
|
|---|
| 101 | \h'-04'\(bu\h'+03'\c
|
|---|
| 102 | .\}
|
|---|
| 103 | .el \{\
|
|---|
| 104 | . sp -1
|
|---|
| 105 | . IP \(bu 2.3
|
|---|
| 106 | .\}
|
|---|
| 107 | \-h, \-help
|
|---|
| 108 | Show help message and quit
|
|---|
| 109 | .RE
|
|---|
| 110 | .sp
|
|---|
| 111 | .RS 4
|
|---|
| 112 | .ie n \{\
|
|---|
| 113 | \h'-04'\(bu\h'+03'\c
|
|---|
| 114 | .\}
|
|---|
| 115 | .el \{\
|
|---|
| 116 | . sp -1
|
|---|
| 117 | . IP \(bu 2.3
|
|---|
| 118 | .\}
|
|---|
| 119 | \-config <path>
|
|---|
| 120 | Path to the config file. If unset, a default config file is used.
|
|---|
| 121 | .RE
|
|---|
| 122 | .sp
|
|---|
| 123 | .RS 4
|
|---|
| 124 | .ie n \{\
|
|---|
| 125 | \h'-04'\(bu\h'+03'\c
|
|---|
| 126 | .\}
|
|---|
| 127 | .el \{\
|
|---|
| 128 | . sp -1
|
|---|
| 129 | . IP \(bu 2.3
|
|---|
| 130 | .\}
|
|---|
| 131 | \-debug
|
|---|
| 132 | Enable debug logging (this will leak sensitive information such as passwords)
|
|---|
| 133 | .RE
|
|---|
| 134 | .sp
|
|---|
| 135 | .RS 4
|
|---|
| 136 | .ie n \{\
|
|---|
| 137 | \h'-04'\(bu\h'+03'\c
|
|---|
| 138 | .\}
|
|---|
| 139 | .el \{\
|
|---|
| 140 | . sp -1
|
|---|
| 141 | . IP \(bu 2.3
|
|---|
| 142 | .\}
|
|---|
| 143 | \-listen <uri>
|
|---|
| 144 | Listening URI (default ":6697"). Can be specified multiple times.
|
|---|
| 145 | .RE
|
|---|
| 146 | .SH "SEE ALSO"
|
|---|
| 147 | .sp
|
|---|
| 148 | suikadb(1)
|
|---|
| 149 | suika\-znc\-import(1)
|
|---|
| 150 | suika\-config(5)
|
|---|
| 151 | suika\-bouncerserv(7)
|
|---|
| 152 | .SH "AUTHOR"
|
|---|
| 153 | .sp
|
|---|
| 154 | Simon Ser and contributors / Izuru Yakumo
|
|---|
