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
0500'>2020-11-13Disallow / anywhere in server nameJune McEnroe 2020-11-12Check bounds of ClientHello extensions lengthJune McEnroe 2020-11-10Report paths in unveil errorsJune McEnroe 2020-10-24contrib/palaver: Use open_memstream instead of fmemopenJune McEnroe Somehow I never knew about this function. Much better than fmemopen with mode "w". 2020-10-11Handle signals before the main loopJune McEnroe This is a long-standing issue I ignored. 2020-09-09Fix possibliy uninitialized error 2.0June McEnroe It won't be, but gcc thinks it might. 2020-08-31Refactor reserialization and client self-producingJune McEnroe 2020-08-30Add chmod+chown to certbot exampleJune McEnroe 2020-08-30Rearrange bounce.c, move non-main mains below mainJune McEnroe 2020-08-30Sandbox pounce with unveil(2)June McEnroe 2020-08-28Refactor certificate loading and load all certs from config pathsJune McEnroe 2020-08-27Sandbox pounce with pledge(2)June McEnroe unveil(2) is a bit complicated to apply to this, I'll have to think about it more. 2020-08-27Sandbox calico with pledge(2) and unveil(2)June McEnroe 2020-08-27Add support for OpenBSDJune McEnroe 2020-08-27Remove rc scriptsJune McEnroe 2020-08-27contrib/palaver: Fix documented database pathJune McEnroe 2020-08-27contrib/palaver: Remove rc scriptJune McEnroe 2020-08-27contrib/palaver: Fix database search and creationJune McEnroe 2020-08-27contrib/palaver: Use pounce's XDG directoryJune McEnroe 2020-08-27contrib/palaver: Only allow HTTPSJune McEnroe 2020-08-25Support the pounce_env rc variableJune McEnroe 2020-08-25Remove deprecated option namesJune McEnroe The next release will be 2.0 so these can be removed now. 2020-08-25Document configuration and data file searchJune McEnroe 2020-08-24Use dataOpen for save fileJune McEnroe 2020-08-24Use configOpen to load localCAJune McEnroe 2020-08-24Use configPath to load client cert/privJune McEnroe 2020-08-24Use configOpen in getopt_configJune McEnroe 2020-08-24Import xdg.c from catgirlJune McEnroe 2020-08-23Replace “RAND_bytes” by “getentropy”Issam E. Maghni This removes the dependency on libcrypto. Signed-off-by: Issam E. Maghni <issam.e.maghni@mailbox.org> 2020-08-16contrib/palaver: Add no message preview flagsJune McEnroe 2020-08-13contrib/palaver: Don't set channel for PMsJune McEnroe 2020-08-13Fix unintended interception of NICK after registrationJune McEnroe Another bug caused by trying to support broken clients. I'm annoyed. 2020-08-12Add Additional Components section to READMEJune McEnroe 2020-08-12Document -L / palaver optionJune McEnroe 2020-08-11contrib/palaver: Document service configurationJune McEnroe 2020-08-11contrib/palaver: Add install target and rc scriptJune McEnroe 2020-08-11contrib/palaver: Implement command and notificationsJune McEnroe