summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2015-08-27 17:12:13 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2015-08-27 17:12:13 +0000
commit5f247199e897e2d79d1a31bfb53e2fdc943a4bde (patch)
tree1201fdfbb2db6962ee63b11c561ba1157d1f9fac /doc
parent62b08ed24bd50737ce090f9ab37acb832845ef4f (diff)
downloads6-5f247199e897e2d79d1a31bfb53e2fdc943a4bde.tar.xz
- New -wr | -wR options to s6-svc, s6-svlisten1 and s6-svlisten
- skalibs and execline dep bump - rc for 2.2.1.0 unless more new functionality is needed for s6-rc
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html6
-rw-r--r--doc/s6-svc.html14
-rw-r--r--doc/s6-svlisten.html11
-rw-r--r--doc/s6-svlisten1.html7
-rw-r--r--doc/upgrade.html11
5 files changed, 42 insertions, 7 deletions
diff --git a/doc/index.html b/doc/index.html
index 500d450..b458c92 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -84,11 +84,11 @@ with s6</a> </li>
<li> GNU make, version 4.0 or later. Please be aware that s6 will not build
with an earlier version. </li>
<li> <a href="http://skarnet.org/software/skalibs/">skalibs</a> version
-2.3.6.1 or later. It's a build-time requirement. It's also a run-time
+2.3.7.0 or later. It's a build-time requirement. It's also a run-time
requirement if you link against the shared version of the skalibs
library. </li>
<li> <a href="http://skarnet.org/software/execline/">execline</a> version
-2.1.3.1 or later. It's a build-time and run-time requirement. </li>
+2.1.4.0 or later. It's a build-time and run-time requirement. </li>
</ul>
<h3> Licensing </h3>
@@ -101,7 +101,7 @@ library. </li>
<h3> Download </h3>
<ul>
- <li> The current released version of s6 is <a href="s6-2.2.0.1.tar.gz">2.2.0.1</a>. </li>
+ <li> The current released version of s6 is <a href="s6-2.2.1.0.tar.gz">2.2.1.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>
<li> There's also a
diff --git a/doc/s6-svc.html b/doc/s6-svc.html
index 86e6857..7c3b2bd 100644
--- a/doc/s6-svc.html
+++ b/doc/s6-svc.html
@@ -28,7 +28,7 @@ knowing their PIDs, and without using horrible hacks such as .pid files.
<h2> Interface </h2>
<pre>
- s6-svc [ -wu | -wU | -wd | -wD ] [ -T <em>timeout</em> ] [ -abqhkti12pcoduxO ] <em>servicedir</em>
+ s6-svc [ -wu | -wU | -wd | -wD | -wr | -wR ] [ -T <em>timeout</em> ] [ -abqhkti12pcoduxO ] <em>servicedir</em>
</pre>
<p>
@@ -89,6 +89,11 @@ a <tt>notification-fd</tt> file to tell
<a href="s6-supervise.html">s6-supervise</a> to accept readiness
notification, s6-svc will print a warning and act as if the <tt>-wu</tt>
option had been given instead. </li>
+ <li> <tt>-wr</tt>&nbsp;: s6-svc will not exit until the service has been
+started or restarted. </li>
+ <li> <tt>-wR</tt>&nbsp;: s6-svc will not exit until the service has been
+started or restarted and has notified readiness. </li>
+
</ul>
<h2> Usage examples </h2>
@@ -119,6 +124,13 @@ the finish script has completed.
is ready. Exit 1 if it is still not ready after 5 seconds.
</p>
+<pre> s6-svc -wR -t /service/ftpd </pre>
+<p>
+ Send a SIGTERM to the ftpd server; wait for
+<a href="s6-supervise.html">s6-supervise</a> to restart it, and block
+until it has notified that it is ready to serve again.
+</p>
+
<pre> s6-svc -a /service/httpd/log </pre>
<p>
Send a SIGALRM to the logger process for the httpd server. If this logger
diff --git a/doc/s6-svlisten.html b/doc/s6-svlisten.html
index 1db24c0..2426fc9 100644
--- a/doc/s6-svlisten.html
+++ b/doc/s6-svlisten.html
@@ -34,7 +34,7 @@ a collection of supervised services, and blocks until they all go up, or down.
</p>
<pre>
- s6-svlisten [ -U | -u | -D | -d ] [ -a | -o ] [ -t <em>timeout</em> ] { <em>servicedir</em> <em>servicedir...</em> } <em>prog...</em>
+ s6-svlisten [ -U | -u | -D | -d | -r | -R ] [ -a | -o ] [ -t <em>timeout</em> ] { <em>servicedir</em> <em>servicedir...</em> } <em>prog...</em>
</pre>
<p>
@@ -42,7 +42,7 @@ a collection of supervised services, and blocks until they all go up, or down.
</p>
<pre>
- s6-svlisten [ -U | -u | -D | -d ] [ -a | -o ] [ -t <em>timeout</em> ] <em>servicedir</em> <em>servicedir...</em> "" <em>prog...</em>
+ s6-svlisten [ -U | -u | -D | -d | -r | -R ] [ -a | -o ] [ -t <em>timeout</em> ] <em>servicedir</em> <em>servicedir...</em> "" <em>prog...</em>
</pre>
<ul>
@@ -73,6 +73,11 @@ See the explanation on <a href="notifywhenup.html">this page</a>. </li>
services are down and the cleanup scripts in <tt><em>servicedir</em>/finish</tt>
for every <em>servicedir</em>
have finished executing (or have timed out and been killed). </li>
+ <li> <tt>-r</tt>&nbsp;: restart. s6-svlisten will wait until all
+the services have been started or restarted. </li>
+ <li> <tt>-R</tt>&nbsp;: restart and ready. s6-svlisten will wait until
+all the services have been started or restarted and have notified
+readiness. </li>
<li> <tt>-o</tt>&nbsp;: or. s6-svlisten will wait until <em>one</em> of the
given services comes up or down. </li>
<li> <tt>-a</tt>&nbsp;: and. s6-svlisten will wait until <em>all</em> of the
@@ -100,6 +105,8 @@ to only use it in execline scripts (only the execline syntax is guaranteed
not to change). There is a variant of s6-svlisten that does not use execline
syntax, but only handles one service directory:
<a href="s6-svlisten1.html">s6-svlisten1</a>. </li>
+ <li> The <tt>-R</tt> or <tt>-r</tt> options imply the <tt>-a</tt> option.
+It is not possible to wait for one of the listed services to restart. </li>
</ul>
</body>
diff --git a/doc/s6-svlisten1.html b/doc/s6-svlisten1.html
index c3f5ef4..0ce283f 100644
--- a/doc/s6-svlisten1.html
+++ b/doc/s6-svlisten1.html
@@ -30,7 +30,7 @@ supervised service, and blocks until said service goes up, or down.
<h2> Interface </h2>
<pre>
- s6-svlisten [ -U | -u | -D | -d ] [ -t <em>timeout</em> ] <em>servicedir</em> <em>prog...</em>
+ s6-svlisten1 [ -U | -u | -D | -d | -r | -R ] [ -t <em>timeout</em> ] <em>servicedir</em> <em>prog...</em>
</pre>
<ul>
@@ -60,6 +60,11 @@ See the explanation on <a href="notifywhenup.html">this page</a>. </li>
<li> <tt>-D</tt>&nbsp;: really down. s6-svlisten1 will wait until the
service is down and the cleanup script in <tt><em>servicedir</em>/finish</tt>
has finished executing (or has timed out and been killed). </li>
+ <li> <tt>-r</tt>&nbsp;: restart. s6-svlisteni1 will wait until
+the service has been started or restarted. </li>
+ <li> <tt>-R</tt>&nbsp;: restart and ready. s6-svlisten1 will wait until
+the service has been started or restarted and has notified
+readiness. </li>
<li> <tt>-t&nbsp;<em>timeout</em></tt>&nbsp;: if the requested event has not
happened after <em>timeout</em> milliseconds, s6-svlisten1 will print a message
to stderr and exit 1. By default, <em>timeout</em> is 0, which means no time
diff --git a/doc/upgrade.html b/doc/upgrade.html
index f74d7fb..d9d8cdd 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,17 @@
<h1> What has changed in s6 </h1>
+<h2> in 2.2.1.0 </h2>
+
+<ul>
+ <li> skalibs dependency bumped to 2.3.7.0. </li>
+ <li> execline dependency bumped to 2.1.4.0. </li>
+ <li> <a href="s6-svc.html">s6-svc</a>,
+<a href="s6-svlisten1.html">s6-svlisten1</a> and
+<a href="s6-svlisten.html">s6-svlisten</a> support new
+<tt>-wr</tt> and <tt>-wR</tt> options. </li>
+</ul>
+
<h2> in 2.2.0.1 </h2>
<ul>