yakumo.izuru/suika
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update references

Browse Source 
Signed-off-by: Aoi K <koizumi.aoi@chaotic.ninja>

git-svn-id: file:///srv/svn/repo/suika/trunk@802 f0ae65fe-ee39-954e-97ec-027ff2717ef4
This commit is contained in:
koizumi.aoi 2023-03-21 03:06:55 +00:00
parent 56f5116d21
commit c00353ac95
2 changed files with 19 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.gitignore vendored
View File

@ -1,4 +1,5 @@
/soju
/sojuctl
/soju.db
/doc/soju.1
/suika
/suikactl
/suika-znc-import
/suika.db
/doc/suika.1

30
doc/soju.1.scd → doc/suika.1.scd
View File

@ -1,16 +1,16 @@
soju(1)
suika(1)
# NAME
soju - IRC bouncer
suika - IRC bouncer. Hard-fork of soju
# SYNOPSIS
*soju* [options...]
*suika* [options...]
# DESCRIPTION
soju is a user-friendly IRC bouncer. It connects to upstream IRC servers on
suika is a user-friendly IRC bouncer. It connects to upstream IRC servers on
behalf of the user to provide extra features.
- Multiple separate users sharing the same bouncer, each with their own
@ -29,7 +29,7 @@ channel will be detached instead of being left.
When all clients are disconnected from the bouncer, the user is automatically
marked as away.
soju supports two connection modes:
suika supports two connection modes:
- Single upstream mode: one downstream connection maps to one upstream
connection. To enable this mode, connect to the bouncer with the username
@ -44,7 +44,7 @@ soju supports two connection modes:
For per-client history to work, clients need to indicate their name. This can
be done by adding a "@<client>" suffix to the username.
soju will reload the configuration file, the TLS certificate/key and the MOTD
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.
@ -105,7 +105,7 @@ The following directives are supported:
more information, see: <https://pkg.go.dev/net/http/pprof>.
If the scheme is omitted, "ircs" is assumed. If multiple *listen*
directives are specified, soju will listen on each of them.
directives are specified, suika will listen on each of them.
*hostname* <name>
Server hostname (default: system hostname).
@ -119,13 +119,13 @@ The following directives are supported:
*db* <driver> <source>
Set the database location for user, network and channel storage. By default,
a _sqlite3_ database is opened in "./soju.db".
a _sqlite3_ database is opened in "./suika.db".
Supported drivers:
- _sqlite3_ expects _source_ to be a path to the SQLite file
- _postgres_ expects _source_ to be a space-separated list of _key=value_
parameters, e.g. _db postgres "host=/run/postgresql dbname=soju"_. Note
parameters, e.g. _db postgres "host=/run/postgresql dbname=suika"_. Note
that _sslmode_ defaults to _require_. For more information on connection
strings, see:
<https://pkg.go.dev/github.com/lib/pq#hdr-Connection_String_Parameters>.
@ -172,7 +172,7 @@ The following directives are supported:
# IRC SERVICE
soju exposes an IRC service called *BouncerServ* to manage the bouncer.
suika exposes an IRC service called *BouncerServ* to manage the bouncer.
Commands can be sent via regular private messages
(_/msg BouncerServ <command> [args...]_). Commands may be written in full or
abbreviated form, for instance *network* can be abbreviated as *net* or just
@ -240,7 +240,7 @@ abbreviated form, for instance *network* can be abbreviated as *net* or just
Update an existing network. The options are the same as the
_network create_ command.
When this command is executed, soju will disconnect and re-connect to the
When this command is executed, suika will disconnect and re-connect to the
network.
If _name_ is not specified, the current network is updated.
@ -383,7 +383,7 @@ abbreviated form, for instance *network* can be abbreviated as *net* or just
Select a network. By default, the current network is selected, if any.
*user create* -username <username> -password <password> [options...]
Create a new soju user. Only admin users can create new accounts.
Create a new suika user. Only admin users can create new accounts.
The _-username_ and _-password_ flags are mandatory.
Options are:
@ -415,7 +415,7 @@ abbreviated form, for instance *network* can be abbreviated as *net* or just
- The _-admin_ flag is only valid when updating another user.
*user delete* <username>
Delete a soju user. Only admins can delete accounts.
Delete a suika user. Only admins can delete accounts.
*server status*
Show some bouncer statistics. Only admins can query this information.
@ -427,6 +427,4 @@ abbreviated form, for instance *network* can be abbreviated as *net* or just
# AUTHORS
Maintained by Simon Ser <contact@emersion.fr>, who is assisted by other
open-source contributors. For more information about soju development, see
<https://sr.ht/~emersion/soju>.
Maintained by Aoi Koizumi <koizumi.aoi@chaotic.ninja>