about summary refs log tree commit diff
path: root/contrib/palaver/pounce-palaver.1
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-08-11 15:43:55 -0400
committerJune McEnroe <june@causal.agency>2020-08-11 15:43:55 -0400
commit79968a0aab940955ed81b0afb714706fb9ed36c8 (patch)
tree5b0d3eb014268613e961f3a8ae9df4364655e600 /contrib/palaver/pounce-palaver.1
parentcontrib/palaver: Add install target and rc script (diff)
downloadpounce-79968a0aab940955ed81b0afb714706fb9ed36c8.tar.gz
pounce-79968a0aab940955ed81b0afb714706fb9ed36c8.zip
contrib/palaver: Document service configuration
Diffstat (limited to '')
-rw-r--r--contrib/palaver/pounce-palaver.146
1 files changed, 45 insertions, 1 deletions
diff --git a/contrib/palaver/pounce-palaver.1 b/contrib/palaver/pounce-palaver.1
index d1776c3..187b8ee 100644
--- a/contrib/palaver/pounce-palaver.1
+++ b/contrib/palaver/pounce-palaver.1
@@ -1,4 +1,4 @@
-.Dd August 10, 2020
+.Dd August 11, 2020
 .Dt POUNCE-PALAVER 1
 .Os
 .
@@ -65,6 +65,50 @@ Connect to
 .Ar host .
 .El
 .
+.Ss Service Configuration
+Add the following to
+.Pa /etc/rc.conf
+to enable the
+.Nm
+daemon:
+.Bd -literal -offset indent
+pounce_palaver_enable="YES"
+.Ed
+.
+.Pp
+To use the preferences database of a user,
+add the following:
+.Bd -literal -offset indent
+pounce_palaver_user="user"
+pounce_palaver_env="HOME=/home/user"
+.Ed
+.
+.Pp
+The
+.Nm
+service supports profiles
+for running multiple instances.
+Set
+.Va pounce_palaver_profiles
+to a space-separated list of names.
+Flags for each profile
+will be set from
+.Va pounce_palaver_${profile}_flags .
+For example:
+.Bd -literal -offset indent
+pounce_palaver_profiles="example1 example2"
+pounce_palaver_example1_flags="example1.irc.example.org"
+pounce_palaver_example2_flags="example2.irc.example.org"
+.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.
+.
 .Sh FILES
 .Bl -tag -width Ds
 .It Pa $XDG_DATA_DIRS/pounce-palaver/preferences.sqlite