summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2019-11-06 19:54:21 -0500
committerJune McEnroe <june@causal.agency>2019-11-06 19:54:21 -0500
commit82b27477253f6d64046dde1453a2f67d2ea91391 (patch)
tree12779240f17e1b1020418ceb17dc7944ef618aae
parentMention Darwin and GNU/Linux in README (diff)
downloadpounce-82b27477253f6d64046dde1453a2f67d2ea91391.tar.gz
pounce-82b27477253f6d64046dde1453a2f67d2ea91391.zip
Document pounce service configuration
Diffstat (limited to '')
-rw-r--r--pounce.163
1 files changed, 61 insertions, 2 deletions
diff --git a/pounce.1 b/pounce.1
index 4db3535..35a2dd9 100644
--- a/pounce.1
+++ b/pounce.1
@@ -247,6 +247,65 @@ specified by
 and
 .Fl K .
 .
+.Ss Service Configuration
+Add the following to
+.Pa /etc/rc.conf
+to enable the
+.Nm
+daemon:
+.Bd -literal -offset indent
+pounce_enable="YES"
+.Ed
+.
+.Pp
+By default,
+the
+.Nm
+daemon is started in the
+.Pa /usr/local/etc/pounce
+directory.
+Configuration files in that location
+can be loaded by setting
+.Ar pounce_flags :
+.Bd -literal -offset indent
+pounce_flags="example.conf"
+.Ed
+.
+.Pp
+The
+.Nm
+service supports profiles
+for running multiple instances.
+Set
+.Ar pounce_profiles
+to a space-separated list of names.
+Flags for each profile will be set from
+.Ar pounce_${profile}_flags .
+For example:
+.Bd -literal -offset indent
+pounce_profiles="example1 example2"
+pounce_example1_flags="example1.conf"
+pounce_example2_flags="example2.conf"
+.Ed
+.
+.Pp
+The commands
+.Cm start , stop ,
+etc.\&
+will operate on the profile given as an additional argument,
+or on all profiles without an additional argument.
+.
+.Pp
+The
+.Cm reload
+command will cause the
+.Nm
+daemon to reload certificate files.
+To reload other configuration,
+use the
+.Cm restart
+command.
+.
 .Sh ENVIRONMENT
 .Bl -tag -width Ds
 .It Ev USER
@@ -254,13 +313,13 @@ The default nickname.
 .El
 .
 .Sh EXAMPLES
-Command line:
+Configuration on the command line:
 .Bd -literal -offset indent
 .Nm Fl H Li pounce.example.org Fl h Li chat.freenode.net Fl j Li '#ascii.town'
 .Ed
 .
 .Pp
-Configuration file:
+Configuration in a file:
 .Bd -literal -offset indent
 bind-host = pounce.example.org
 host = chat.freenode.net
tr class='logheader'>2019-11-10Request all supported caps from serverJune McEnroe 2019-11-10Filter ACCOUNT, AWAY, CHGHOST for incapable clientsJune McEnroe 2019-11-10Rename listen to localJune McEnroe 2019-11-09Remove extended-join and invite-notifyJune McEnroe The remaining caps only generate new commands which can easily be filtered out when sending to clients so will be in the first pass of support. extended-join is probably safe to pass through unaltered, just causing extraneous parameters on JOIN commands, but maybe not. invite-notify reuses the INVITE command where the invited user is not self. 2019-11-09Maintain stateCaps and offer them to clientsJune McEnroe 2019-11-09Parse capabilitiesJune McEnroe The list that I've defined are the ones that I expect to be able to enable probably without any clients breaking... And of course server-time which pounce implements itself. 2019-11-09Avoid the reserved _A names with BIT macroJune McEnroe 2019-11-09Define macro for bit flag enumsJune McEnroe 2019-11-08Check that password is hashedJune McEnroe 2019-11-08Avoid calling getopt_long again after it returns -1June McEnroe On GNU, calling getopt_long again will reset optind back to the first non-option argument, which would cause an infinite loop of reading the same configurtion file forever. 2019-11-08Only change AWAY status for registered clientsJune McEnroe Turns out I did eventually fix this, because I may want to implement "passive clients" for logging or notification stuff, which wouldn't affect AWAY status either. 2019-11-07Just write the example normallyJune McEnroe 2019-11-07Include path in readlinkat errorJune McEnroe 2019-11-07Call clientConsume before clientRecvJune McEnroe This might reduce the frequency of a client getting its own message back because it was behind in the ring when it sent it. 2019-11-06Use -l:filename in Linux.mkJune McEnroe 2019-11-06Fix compat.h for #defined strlcpyJune McEnroe 2019-11-06Allow unsetting LIBRESSL_PREFIXJune McEnroe 2019-11-06Document calico service configurationJune McEnroe 2019-11-06Document SASL EXTERNAL configuration in more detailJune McEnroe 2019-11-06Document pounce service configurationJune McEnroe 2019-11-06Mention Darwin and GNU/Linux in READMEJune McEnroe 2019-11-06Assume LibreSSL from brew on DarwinJune McEnroe 2019-11-06Remove -DNO_EXPLICIT_BZERO from Darwin.mkJune McEnroe 2019-11-06Don't install rc scripts or dirs on LinuxJune McEnroe