diff options
| author | June McEnroe <june@causal.agency> | 2019-10-25 23:41:27 -0400 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2019-10-25 23:41:27 -0400 |
| commit | e948a8b5b413486c1070e4684ad6b499564f9373 (patch) | |
| tree | f1db79656cd3779617e81252a3f1c7e84f1a0876 | |
| parent | Add AGPLv3 notice on client registration (diff) | |
| download | pounce-e948a8b5b413486c1070e4684ad6b499564f9373.tar.gz pounce-e948a8b5b413486c1070e4684ad6b499564f9373.zip | |
Expand documentation
| -rw-r--r-- | README.7 | 12 | ||||
| -rw-r--r-- | pounce.1 | 27 |
2 files changed, 37 insertions, 2 deletions
diff --git a/README.7 b/README.7 index 6223c4f..7bc7f5f 100644 --- a/README.7 +++ b/README.7 @@ -4,10 +4,18 @@ . .Sh NAME .Nm pounce -.Nd IRC bouncer +.Nd IRC pouncer :3 . .Sh DESCRIPTION .Nm +is a multi-client, TLS-only IRC bouncer. +It takes a simple approach, +using a multiple-consumer ring buffer +and the IRCv3.2 server-time extension +to communicate with clients. +. +.Pp +.Nm requires LibreSSL .Pq Fl ltls and targets @@ -16,7 +24,7 @@ and targets .Sh FILES .Bl -tag -width "bounce.h" -compact .It Pa bounce.h -function prototypes and default paths +common declarations and default paths .It Pa bounce.c command line parsing and event loop .It Pa listen.c diff --git a/pounce.1 b/pounce.1 index 08a5a85..156a511 100644 --- a/pounce.1 +++ b/pounce.1 @@ -119,6 +119,24 @@ Log in with the password .Ar pass . .El . +.Pp +When using +.Xr certbot 8 +to obtain TLS certificates, +is it sufficient to specify the domain with +.Fl H . +. +.Sh ENVIRONMENT +.Bl -tag -width Ds +.It Ev USER +The default nickname. +.El +. +.Sh EXAMPLES +.Bd -literal -offset indent +.Nm Fl H Li pounce.example.org Fl h Li chat.freenode.net Fl j Li '#ascii.town' +.Ed +. .Sh STANDARDS The .Nm @@ -199,3 +217,12 @@ daemon implements the following: .%U https://tools.ietf.org/html/rfc4648 .Re .El +. +.Sh AUTHORS +.An June Bug Aq Mt june@causal.agency +. +.Sh CAVEATS +One instance of +.Nm , +and therefore one local port, +is required for each server connection. |