summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--pounce.140
1 files changed, 38 insertions, 2 deletions
diff --git a/pounce.1 b/pounce.1
index fb8330a..2fd7344 100644
--- a/pounce.1
+++ b/pounce.1
@@ -1,4 +1,4 @@
-.Dd November 6, 2019
+.Dd November 10, 2019
 .Dt POUNCE 1
 .Os
 .
@@ -45,9 +45,14 @@ is a multi-client, TLS-only IRC bouncer.
 It maintains a persistent connection to an IRC server
 while allowing clients to connect and disconnect,
 receiving messages that were missed upon reconnection.
-Clients should use the IRCv3.2 server-time extension
+Clients should use the IRCv3.2
+.Sy server-time
+extension
 to know when missed messages were received
 and uniquely identify themselves by username.
+See
+.Sx Client Configuration
+for details.
 .
 .Pp
 Options can be loaded from
@@ -249,6 +254,37 @@ specified by
 and
 .Fl K .
 .
+.Ss Client Configuration
+Clients should be configured to
+connect to the host and port set by
+.Fl H
+and
+.Fl P ,
+with TLS or SSL enabled.
+If
+.Fl W
+is used,
+clients must send a server password.
+Clients should not attempt SASL.
+.
+.Pp
+Clients should register with unique usernames,
+for example the name of the client software
+or location from which it is connecting.
+New clients with the same username
+are assumed to be reconnections
+and will cause previous connections
+to stop receiving messages.
+The nickname and real name sent by clients
+are ignored.
+.
+.Pp
+Pass-through of the following IRCv3 capabilities
+is supported:
+.Sy account-notify ,
+.Sy away-notify ,
+.Sy chghost .
+.
 .Ss Configuring SASL EXTERNAL
 .Bl -enum
 .It
pan title='2018-03-05 12:39:40 -0500'>2018-03-05Undef COLOR_ constants in torus.hJune McEnroe 2018-03-05Generate tagsJune McEnroe 2017-10-03Simplify Makefile with pattern ruleJune McEnroe Insert rant about how GNU make handles the .c rule with extra dependencies. Also I don't care that everything links curses now. 2017-09-27Remove leading blank linesJune McEnroe 2017-09-27Add merge.c to READMEJune McEnroe 2017-09-03Assert client coords are valid after movementJune McEnroe 2017-09-03Relicense AGPLJune McEnroe I know it's already published under a permissive license in what is probably its final form, but I want to license it AGPL anyway on principle following some conversations I had about open source, corporations and copyleft. 2017-09-01Revert "Add client readOnly mode"June McEnroe This reverts commit 34f25ae40a3db9369e9d98b3814f2b93bbc21451. 2017-09-01Remove clientRemove call from clientCastJune McEnroe If an error occurs on a client socket during a broadcast, that client will show up in the kqueue loop with EV_EOF and get removed that way. Tested by sending SIGKILL to a client and watching its cursor disappear. 2017-09-01Add client readOnly modeJune McEnroe 2017-08-31Clean up merge toolJune McEnroe Choose the version with the most recent access if the modify times are the same. 2017-08-31Choose B for tiles with equal modify timesJune McEnroe This way newer access counts and times will be preserved. 2017-08-31Add quick data file merge toolJune McEnroe Hopefully I won't have to use it ever again. 2017-08-30Use only foreground color for selecting spawnJune McEnroe 2017-08-29Add four additional spawnsJune McEnroe 2017-08-28Add respawningJune McEnroe 2017-08-26Move license above includesJune McEnroe Why was it down there? 2017-08-26Snapshot metadataJune McEnroe 2017-08-26Add meta.c to READMEJune McEnroe 2017-08-26Use MakefileJune McEnroe