100 lines
2.0 KiB
Groff
100 lines
2.0 KiB
Groff
.Dd September 28, 2021
|
|
.Dt CATSIT.CONF 5
|
|
.Os
|
|
.
|
|
.Sh NAME
|
|
.Nm catsit.conf
|
|
.Nd catsitd services list
|
|
.
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
file lists the services managed by the
|
|
.Xr catsitd 8
|
|
daemon.
|
|
Leading whitespace is ignored.
|
|
The current line
|
|
can be extended over multiple lines
|
|
using a backslash
|
|
.Pq Ql \e .
|
|
Each line of the file
|
|
is one of the following:
|
|
.
|
|
.Bl -tag -width Ds
|
|
.It Cm # Ar comment ...
|
|
Lines beinning with
|
|
.Ql #
|
|
as well as blank lines
|
|
are ignored.
|
|
.
|
|
.It Cm % Ar command ...
|
|
Lines beginning with
|
|
.Ql %
|
|
add shell commands
|
|
to be executed before
|
|
each of the service commands.
|
|
These commands are executed
|
|
in the order they appear in the file,
|
|
for all services.
|
|
These lines can be used to
|
|
set shell or environment variables
|
|
to be expanded in service command lines
|
|
or used by the service processes.
|
|
.
|
|
.It Ar service Ar command ...
|
|
All other lines define services.
|
|
The service name is separated
|
|
from its command line by whitespace.
|
|
The rest of the line after the service name
|
|
is executed using the shell.
|
|
The shell variable
|
|
.Va $0
|
|
is set to the name of the service.
|
|
If the command line
|
|
does not contain the characters
|
|
.Ql ;&|()
|
|
it is prepended by
|
|
.Ic exec
|
|
when passed to the shell.
|
|
.
|
|
.It Ar @service Ar command ...
|
|
Service names beginning with
|
|
.Ql @
|
|
define
|
|
.Em privileged
|
|
services,
|
|
which are started with the same user and group as
|
|
.Xr catsitd 8 .
|
|
This can be used for services
|
|
which drop their own privileges
|
|
or which call
|
|
.Xr chroot 2 .
|
|
.El
|
|
.
|
|
.Sh EXAMPLES
|
|
.Bd -literal
|
|
# Setting environment variables:
|
|
% export LANG=en_US.UTF-8
|
|
|
|
# Expanding command lines with variables:
|
|
% socks=/var/run/calico
|
|
calico calico -H irc.example.org $socks
|
|
pounce pounce -U $socks pounce.conf
|
|
|
|
# Templating command lines using service names:
|
|
pounce/tilde pounce ${0#*/}.conf
|
|
pounce/libera pounce ${0#*/}.conf
|
|
|
|
# Privileged services:
|
|
@scooper kfcgi -d -U $USER -p ~/.local -- \e
|
|
/bin/scooper /share/litterbox/litterbox.sqlite
|
|
.Ed
|
|
.
|
|
.Sh SEE ALSO
|
|
.Xr catsit-timer 1 ,
|
|
.Xr catsit-watch 1 ,
|
|
.Xr catsitd 8
|
|
.
|
|
.Sh AUTHORS
|
|
.An June Bug Aq Mt june@causal.agency
|