summary refs log tree commit diff
path: root/catsit.conf.5
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2020-08-17 01:11:44 -0400
committerJune McEnroe <june@causal.agency>2020-08-17 01:11:44 -0400
commit84b2c1858a5ef26bfa40a01fe57ed3cf0a1ada03 (patch)
treecc438def4a5354e2d22ec1ac9f61387959956f43 /catsit.conf.5
parentAdd drop command (diff)
downloadcatsit-84b2c1858a5ef26bfa40a01fe57ed3cf0a1ada03.tar.gz
catsit-84b2c1858a5ef26bfa40a01fe57ed3cf0a1ada03.zip
Flesh out documentation and improve examples
Diffstat (limited to '')
-rw-r--r--catsit.conf.528
1 files changed, 15 insertions, 13 deletions
diff --git a/catsit.conf.5 b/catsit.conf.5
index eee5ed2..c18f683 100644
--- a/catsit.conf.5
+++ b/catsit.conf.5
@@ -20,7 +20,8 @@ is one of the following:
 .It Cm # Ar comment ...
 Lines beinning with
 .Ql #
-and blank lines are ignored.
+as well as blank lines
+are ignored.
 .
 .It Cm % Ar command ...
 Lines beginning with
@@ -62,20 +63,21 @@ or which call
 .
 .Sh EXAMPLES
 .Bd -literal
-# Basic services:
-calico	calico -H irc.example.org /var/run/calico
-pounce/freenode	pounce /usr/local/etc/pounce/freenode.conf
-pounce/tilde	pounce /usr/local/etc/pounce/tilde.conf
-
 # Setting environment variables:
-% export PATH=$PATH:/usr/local/bin
+% export LANG=en_US.UTF-8
 
-# Using variables to expand service command lines:
-% pounce=/usr/local/bin/pounce
-% conf=/usr/local/etc/pounce
-pounce/freenode	$pounce $conf/freenode.conf
-pounce/tilde	$pounce $conf/tilde.conf
-.El
+# 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/freenode	pounce ${0#*/}.conf
+pounce/tilde	pounce ${0#*/}.conf
+
+# Privileged services:
+@scooper	kfcgi -d -U $USER -p ~/.local -- /bin/scooper
+.Ed
 .
 .Sh SEE ALSO
 .Xr catsitd 8