summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2019-10-29 19:53:27 -0400
committerJune McEnroe <june@causal.agency>2019-10-29 19:53:27 -0400
commit3ec9f7074737559084351b62e1eabb7f58f92909 (patch)
treebb777fffd9ed2241730f0413bc34168217ddb7d0
parentImplement getopt_long-integrated configuration parsing (diff)
downloadpounce-3ec9f7074737559084351b62e1eabb7f58f92909.tar.gz
pounce-3ec9f7074737559084351b62e1eabb7f58f92909.zip
Clarify some documentation
-rw-r--r--README.73
-rw-r--r--pounce.120
2 files changed, 18 insertions, 5 deletions
diff --git a/README.7 b/README.7
index 8cee7f1..c1a6806 100644
--- a/README.7
+++ b/README.7
@@ -20,6 +20,9 @@ requires LibreSSL
 .Pq Fl ltls
 and targets
 .Fx .
+It also runs on Darwin
+and doesn't use anything
+particularly BSD-specific.
 .
 .Sh RATIONALE
 As a former
diff --git a/pounce.1 b/pounce.1
index acb8433..f83882a 100644
--- a/pounce.1
+++ b/pounce.1
@@ -87,6 +87,8 @@ is set by
 Request
 .Ql NAMES
 for each channel when a client connects.
+This allows clients to populate user lists,
+but may just cause noise for some.
 .
 .It Fl P Ar port , Cm bind-port = Ar port
 Bind to
@@ -99,9 +101,9 @@ Quit with message
 when shutting down.
 .
 .It Fl W Ar pass , Cm client-pass = Ar pass
-Require the password
+Require the server password
 .Ar pass
-to connect.
+for clients to connect.
 .
 .It Fl a Ar user : Ns Ar pass , Cm sasl = Ar user : Ns Ar pass
 Authenticate as
@@ -111,12 +113,12 @@ with
 using SASL PLAIN.
 .
 .It Fl f Ar path , Cm save = Ar path
-Load the contents of the ring buffer from
+Load the contents of the buffer from
 .Ar path ,
 if it exists,
 and truncate it.
 On shutdown,
-save the contents of the ring buffer to
+save the contents of the buffer to
 .Ar path .
 .
 .It Fl h Ar host , Cm host = Ar host
@@ -143,7 +145,7 @@ Set realname to
 The default realname is the same as the nickname.
 .
 .It Fl u Ar user , Cm user = Ar user
-Set the username to
+Set username to
 .Ar user .
 The default username is the same as the nickname.
 .
@@ -294,3 +296,11 @@ daemon makes no distinction between channels.
 Elevated activity in one channel
 may push messages from a quieter channel
 out of the buffer.
+.
+.Sh BUGS
+Send mail to
+.Aq Mt june@causal.agency
+or join
+.Li #ascii.town
+on
+.Li chat.freenode.net .