about 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
?id=76f1d0775b52e7a8a1c322214836cde530117512&follow=1'>Add 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