From 32cf3d5617ab8a77e400a2b8b007b1029f0a9349 Mon Sep 17 00:00:00 2001 From: "C. McEnroe" Date: Thu, 13 Aug 2020 21:06:29 -0400 Subject: Add prospective manual page for spawntab --- spawntab.5 | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 spawntab.5 diff --git a/spawntab.5 b/spawntab.5 new file mode 100644 index 0000000..5819ff9 --- /dev/null +++ b/spawntab.5 @@ -0,0 +1,71 @@ +.Dd August 13, 2020 +.Dt SPAWNTAB 5 +.Os +. +.Sh NAME +.Nm spawntab +.Nd spawnd services list +. +.Sh DESCRIPTION +The +.Nm +file lists the services managed by the +.Xr spawnd 8 +daemon. +Leading whitespace is ignored. +Each line of the file +is one of the following: +. +.Bl -tag -width Ds +.It Cm # Ar comment ... +Lines beinning with +.Ql # +and 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. +.El +. +.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 + +# 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 +. +.Sh SEE ALSO +.Xr spawnd 8 +. +.Sh AUTHORS +.An June Bug Aq Mt june@causal.agency -- cgit 1.4.1