source: basicnet/djb/daemontools/daemontools-desc.xml@ 681ad68

<sect2>
<title>Contents</title>

<para>The daemontools package contains
<command>svscanboot</command>, <command>svscan</command>,
<command>supervise</command>, <command>svc</command>,
<command>svok</command>, <command>svstat</command>,
<command>fghack</command>, <command>pgrphack</command>,
<command>readproctitle</command>, <command>multilog</command>,
<command>tai64n</command>, <command>tai64nlocal</command>,
<command>setuidgid</command>, <command>envuidgid</command>,
<command>envdir</command>, <command>softlimit</command> and 
<command>setlock</command>. More detailed descriptions of these 
commands may be found at <ulink url="http://cr.yp.to/daemontools.html"/>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>svscanboot</title>
<para><command>svscanboot</command> is simply a script that calls
<command>svscan</command> and pipes its output to readproctitle.</para></sect3>

<sect3><title>svscan</title>
<para><command>svscan</command> checks the <filename>service</filename> 
directory for daemons to run and starts a <command>supervise</command> process 
for each run script that it finds.</para></sect3>

<sect3><title>supervise</title>
<para><command>supervise</command> runs the run script passed to it by
<command>svscan</command> and monitors the process the script starts so that 
if it dies, <command>supervise</command> restarts it.</para></sect3>

<sect3><title>svc</title>
<para><command>svc</command> sends signals to processes being run under 
<command>supervise</command>.
</para></sect3>

<sect3><title>svok</title>
<para><command>svok</command> checks to see that
<command>supervise</command> is running in the directory 
passed to it.</para></sect3>

<sect3><title>svstat</title>
<para><command>svstat</command> prints the status of processes monitored by 
<command>supervise</command>.</para></sect3>

<sect3><title>fghack</title>
<para><command>fghack</command> prevents processes from putting themselves into 
the background.</para></sect3>

<sect3><title>pgrphack</title>
<para><command>pgrphack</command> runs a process in a separate process group.
</para></sect3>

<sect3><title>readproctitle</title>
<para><command>readproctitle</command> displays log entries in the output of 
<command>ps</command>.
</para></sect3>

<sect3><title>multilog</title>
<para><command>multilog</command> is a logging program. It takes output from a 
daemon and appends it to any number of logs.</para></sect3>

<sect3><title>tai64n</title>
<para><command>tai64n</command> is a timestamp generating program.</para>
</sect3>

<sect3><title>tai64nlocal</title>
<para><command>tai64nlocal</command> converts output of tai64n into a human 
readable format.</para></sect3>

<sect3><title>setuidgid</title>
<para><command>setuidgid</command> runs a specified program under a given 
account's uid and gid.</para></sect3>

<sect3><title>envuidgid</title>
<para><command>envuidgid</command> performs the same function as setuidgid, 
but sets environment variables <envar>UID</envar> and <envar>GID</envar> equal 
to the uid and gid of the account specified.</para></sect3>

<sect3><title>envdir</title>
<para><command>envdir</command> runs a given program with environment variables 
specified by files in a directory.</para></sect3>

<sect3><title>softlimit</title>
<para><command>softlimit</command> allows resource limits to be set for a given 
program.</para></sect3>

<sect3><title>setlock</title>
<para><command>setlock</command> locks a file and runs a program.</para></sect3>

</sect2>