summary refs log tree commit diff
path: root/pounce.1
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2019-11-10 18:51:36 -0500
committerJune McEnroe <june@causal.agency>2019-11-10 18:51:36 -0500
commit64905c6604164ce7d8e125e81b7acd84d5d40475 (patch)
treecefa1a0fad10a162389a7ac40bb89e1d70be6c30 /pounce.1
parentRequest all supported caps from server (diff)
downloadpounce-64905c6604164ce7d8e125e81b7acd84d5d40475.tar.gz
pounce-64905c6604164ce7d8e125e81b7acd84d5d40475.zip
Expand client configuration documentation and list capabilities
Diffstat (limited to 'pounce.1')
-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
d class='logsubject'>Use Z_FILTERED strategyJune McEnroe 2021-09-21Recalculate various lengths only as neededJune McEnroe This actually speeds things up quite a bit, saving roughly a second on a big PNG screenshot. Almost all the remaining time is spent in deflate. 2021-09-21Rewrite pngo, add explicit optionsJune McEnroe Interesting to see how my code habits have changed. 2021-09-16Fix /* **/ comment matchingJune McEnroe 2021-09-15Remove typer, add downgrade to READMEJune McEnroe 2021-09-15Set bot mode on downgradeJune McEnroe 2021-09-15Enter capsicum in downgradeJune McEnroe 2021-09-15Factor out common parts of downgrade messagesJune McEnroe Also bump the message cap to 1024 because that is ostensibly useful for replying to older messages. 2021-09-14Add downgrade IRC botJune McEnroe 2021-09-14Sort by title if authors matchJune McEnroe There are probably better things to sort by but title definitely always exists. 2021-09-13Swap-remove tags as they're foundJune McEnroe This makes it even faster. From ~1s on a sqlite3.c amalgamation to ~0.85s. 2021-09-12Replace htagml regex with strncmpJune McEnroe Since ctags only ever produces regular expressions of the form /^re$/ or /^re/ with no other special characters, instead unescape the pattern and simply use strncmp. Running on a sqlite3.c amalgamation, the regex version takes ~37s while the strncmp version takes ~1s, producing identical output. Big win! 2021-09-11Also defer printing comment for lone close-parensJune McEnroe 2021-09-10Publish "git-comment"June McEnroe 2021-09-10Add git comment --pretty optionJune McEnroe 2021-09-08Defer printing comment if line is blank or closing braceJune McEnroe This fixes badly indented comments. 2021-09-08Up default min-repeat to 30 linesJune McEnroe 2021-09-08Handle dirty lines in git-commentJune McEnroe 2021-09-08Document and install git-commentJune McEnroe 2021-09-08Add repeat and all options to git-commentJune McEnroe 2021-09-08Add group threshold to git-commentJune McEnroe