diff options
| author | June McEnroe <june@causal.agency> | 2020-08-26 22:56:48 -0400 |
|---|---|---|
| committer | June McEnroe <june@causal.agency> | 2020-08-26 22:56:48 -0400 |
| commit | 52a93a927189f9481743907fda5c190816682076 (patch) | |
| tree | 998e5bf8af4c02826159938a4556799d0c8ed54e /rc.d/litterbox.in | |
| parent | Recommend catsit first in README (diff) | |
| download | litterbox-52a93a927189f9481743907fda5c190816682076.tar.gz litterbox-52a93a927189f9481743907fda5c190816682076.zip | |
Move rc script docs to rc script comment
Diffstat (limited to 'rc.d/litterbox.in')
| -rw-r--r-- | rc.d/litterbox.in | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/rc.d/litterbox.in b/rc.d/litterbox.in index cc48092..b0a3067 100644 --- a/rc.d/litterbox.in +++ b/rc.d/litterbox.in @@ -4,6 +4,26 @@ # REQUIRE: LOGIN # KEYWORD: shutdown +# Add the following to /etc/rc.conf to enable litterbox running as a +# user: +# +# litterbox_enable="YES" +# litterbox_user="user" +# litterbox_env="HOME=/home/user" +# +# The litterbox service supports profiles for running multiple +# instances. Set litterbox_profiles to a space-separated list of names. +# Flags for each profile will be set from litterbox_${profile}_flags. +# For example: +# +# litterbox_profiles="example1 example2" +# litterbox_example1_flags="example1.conf" +# litterbox_example2_flags="example2.conf" +# +# The commands start, stop, etc. will operating on the profile given as +# an additional argument, or on all profiles without an additional +# argument. + . /etc/rc.subr name='litterbox' |