summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html4
-rw-r--r--doc/s6-supervise.html7
-rw-r--r--doc/s6-svstat.html25
-rw-r--r--doc/upgrade.html11
4 files changed, 35 insertions, 12 deletions
diff --git a/doc/index.html b/doc/index.html
index 5423e12..57d1ef1 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -53,7 +53,7 @@ supervision that might help you understand the basics.
<li> A POSIX-compliant system with a standard C development environment </li>
<li> GNU make, version 4.0 or later </li>
<li> <a href="http://skarnet.org/software/skalibs/">skalibs</a> version
-2.2.0.0 or later </li>
+2.2.1.0 or later </li>
<li> <a href="http://skarnet.org/software/execline/">execline</a> version
2.0.1.1 or later </li>
</ul>
@@ -68,7 +68,7 @@ supervision that might help you understand the basics.
<h3> Download </h3>
<ul>
- <li> The current released version of s6 is <a href="s6-2.0.2.0.tar.gz">2.0.2.0</a>. </li>
+ <li> The current released version of s6 is <a href="s6-2.1.0.0.tar.gz">2.1.0.0</a>. </li>
<li> Alternatively, you can checkout a copy of the s6 git repository:
<pre> git clone git://git.skarnet.org/s6 </pre> </li>
</ul>
diff --git a/doc/s6-supervise.html b/doc/s6-supervise.html
index b080626..d0d1e54 100644
--- a/doc/s6-supervise.html
+++ b/doc/s6-supervise.html
@@ -44,9 +44,12 @@ If it already exists, it uses it as is, without modifying the subscription right
<li> s6-supervise sends a <tt>'u'</tt> event to <tt>./event</tt> whenever it
successfully spawns <tt>./run</tt>. </li>
<li> When <tt>./run</tt> dies, s6-supervise sends a <tt>'d'</tt> event to <tt>./event</tt>. </li>
- <li> When <tt>./run</tt> dies, s6-supervise spawns <tt>./finish</tt> if it exists. </li>
+ <li> When <tt>./run</tt> dies, s6-supervise spawns <tt>./finish</tt> if it exists.
+<tt>./finish</tt> will have <tt>./run</tt>'s exit code as first argument, or 256 if
+<tt>./run</tt> was signaled; it will have the number of the signal that killed <tt>./run</tt>
+as second argument, or an undefined number if <tt>./run</tt> was not signaled. </li>
<li> <tt>./finish</tt> must exit in less than 5 seconds. If it takes more than that,
-s6-supervise kills it. </li>
+s6-supervise kills it with a SIGKILL. </li>
<li> When <tt>./finish</tt> dies, s6-supervise restarts <tt>./run</tt> unless it has been
told not to. </li>
<li> There is a minimum 1-second delay between two <tt>./run</tt> spawns, to avoid busylooping
diff --git a/doc/s6-svstat.html b/doc/s6-svstat.html
index 75ee7e2..e5e5438 100644
--- a/doc/s6-svstat.html
+++ b/doc/s6-svstat.html
@@ -18,27 +18,38 @@
<h1> The s6-svstat program </h1>
<p>
-s6-svstat prints a short, human-readable summary of the state of a supervised
-service.
+s6-svstat prints a short, human-readable summary of the state of a process
+monitored by <a href="s6-supervise.html">s6-supervise</a>.
</p>
<h2> Interface </h2>
<pre>
- s6-svstat <em>servicedir</em>
+ s6-svstat [ -n ] <em>servicedir</em>
</pre>
<p>
- s6-svstat gives the following information about the process being monitored
+ s6-svstat gives information about the process being monitored
at the <em>servicedir</em> <a href="servicedir.html">service directory</a>, then
-exits 0:
+exits 0. The information includes the following:
</p>
<ul>
- <li> whether it is up or down </li>
- <li> its pid, if it is up </li>
+ <li> whether the process is up or down </li>
+ <li> the process' pid, if it is up, or its last exit code or terminating
+signal, if it is down </li>
<li> what its default state is, if it is different from its current state </li>
<li> the number of seconds since it last changed states </li>
+ <li> if the current state is transient and will change as soon as the
+kernel's scheduler picks up s6-supervise </li>
+</ul>
+
+<h2> Options </h2>
+
+<ul>
+ <li> <tt>-n</tt>&nbsp;: if the monitored process has been killed by a signal,
+print the signal number. By default, a symbolic name for the signal will be
+printed instead. </li>
</ul>
</body>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 5a1b1ec..68c0fe1 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -17,12 +17,21 @@
<h1> What has changed in s6 </h1>
-<h2> in 2.0.2.0 </h2>
+<h2> in 2.1.0.0 </h2>
<ul>
+ <li> skalibs dependency bumped to 2.2.1.0. </li>
<li> Unix domain socket utilities moved from the
<a href="http://skarnet.org/software/s6-networking/">s6-networking</a>
package to s6. </li>
+ <li> <tt>./finish</tt> argument for "service crashed" is now 256
+instead of 255 </li>
+ <li> <tt>supervise/status</tt> now includes wstat information
+when the service died, svstat reports it </li>
+ <li> svstat now reports symbolic signal information by default,
+use <tt>-n</tt> to get the old behaviour </li>
+ <li> s6-log now properly calls execlineb with its installation
+prefix, in the slashpackage case </li>
</ul>
<h2> in 2.0.1.0 </h2>