summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-01-11 02:55:43 -0500
committerJune McEnroe <june@causal.agency>2020-01-11 02:55:43 -0500
commit0ccf60fce9ddce78e473ef872889bd5a86f18d6b (patch)
tree5cdab7e207fc51b8fcbc6966e7fe79ac9799ee9e
parentAdd FreeBSD rc script (diff)
downloadlitterbox-0ccf60fce9ddce78e473ef872889bd5a86f18d6b.tar.gz
litterbox-0ccf60fce9ddce78e473ef872889bd5a86f18d6b.zip
Document Service Configuration
-rw-r--r--litterbox.142
1 files changed, 42 insertions, 0 deletions
diff --git a/litterbox.1 b/litterbox.1
index 79bec7e..64b145d 100644
--- a/litterbox.1
+++ b/litterbox.1
@@ -173,6 +173,48 @@ Log in with the server password
 .Ar pass .
 .El
 .
+.Ss Service Configuration
+Add the following to
+.Pa /etc/rc.conf
+to enable the
+.Nm
+daemon:
+.Bd -literal -offset indent
+litterbox_enable="YES"
+.Ed
+.
+.Pp
+To use the database and configuration files of a user,
+add the following:
+.Bd -literal -offset indent
+litterbox_user="user"
+litterbox_env="HOME=/home/user"
+.Ed
+.
+.Pp
+The
+.Nm
+service supports profiles
+for running multiple instances.
+Set
+.Va litterbox_profiles
+to a space-separated list of names.
+Flags for each profile will be set from
+.Va litterbox_${profile}_flags .
+For example:
+.Bd -literal -offset indent
+litterbox_profiles="example1 example2"
+litterbox_example1_flags="example1.conf"
+litterbox_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.
+.
 .Sh FILES
 .Bl -tag -width Ds
 .It Pa $XDG_CONFIG_DIRS/litterbox