Changeset 823 in code for trunk/doc/suika.1


Ignore:
Timestamp:
Sep 15, 2023, 4:20:11 AM (21 months ago)
Author:
yakumo.izuru
Message:

Use asciidoctor for generating manpages.
Rename suikactl to suikadb.

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/suika.1

    r817 r823  
    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 
     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"
     31suika \- Drunk as hell IRC bouncer, named after Suika Ibuki from Touhou Project
     32.SH "SYNOPSIS"
     33.sp
     34suika [\-options] ...
     35.SH "DESCRIPTION"
     36.sp
     37suika is an user\-friendly IRC bouncer.
     38It 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.\}
     48Multiple 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.\}
     59Clients 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.\}
     70Sending the backlog (messages received while the user was disconnected from the bouncer), with per\-client buffers
     71.RE
     72.sp
     73When joining a channel, the channel will be saved and automatically joined on the next connection.
     74When registering or authenticating with NickServ, the credentials will be saved and automatically used on the next connection if the server supports SASL.
     75When parting a channel with the reason "detach", the channel will be detached instead of being left.
     76When all clients are disconnected from the bouncer, the user is automatically marked as away.
     77.sp
    4878suika 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
     79.sp
     80Single upstream mode: one downstream connection maps to one upstream connection. To enable this mode, connect to the bouncer with the username "<username>/<network>".
     81If the bouncer isn\(cqt connected to the upstream server, it will get automatically added.
     82Then channels can be joined and parted as if you were directly connected to the upstream server.
     83.sp
     84Multiple upstream mode: one downstream connection maps to multiple upstream connections.
     85Channels and nicks are suffixed with the network name.
     86To join a channel, you need to use the suffix too: /join #channel/network.
     87Same applies to messages sent to users.
     88.sp
     89For per\-client history to work, clients need to indicate their name.
     90This can be done by adding a "@<client>" suffix to the username.
     91.sp
     92suika will reload the configuration file, the TLS certificate/key and the MOTD file when it receives the HUP signal.
     93The configuration options listen, db and log cannot be reloaded.
     94.sp
     95Administrators can broadcast a message to all bouncer users via /notice $<hostname> <text>, or via /notice $<text> in multi\-upstream mode.
     96All 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
    88108Show help message and quit
    89 .It -config <path>
     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>
    90120Path 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>
     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
     132Enable 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>
    95144Listening 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
     145.RE
     146.SH "SEE ALSO"
     147.sp
     148suikadb(1)
     149suika\-znc\-import(1)
     150suika\-config(5)
     151suika\-bouncerserv(7)
     152.SH "AUTHOR"
     153.sp
     154Simon Ser and contributors / Izuru Yakumo
Note: See TracChangeset for help on using the changeset viewer.