summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-02-14 10:41:44 +0000
committerLaurent Bercot <ska@appnovation.com>2023-02-14 10:41:44 +0000
commit07a5243d8a78dddac98040741cd204f382f6012e (patch)
tree6b33983d841a1079608625ea6e8da06b31d6757c /doc
parentbbf31e578acd6b6e860fc2b58c1fc910e81c00dd (diff)
downloads6-rc-07a5243d8a78dddac98040741cd204f382f6012e.tar.xz
Prepare for 0.5.4.0; add start and stop subcommands to s6-rc
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html4
-rw-r--r--doc/s6-rc.html25
-rw-r--r--doc/upgrade.html4
3 files changed, 27 insertions, 6 deletions
diff --git a/doc/index.html b/doc/index.html
index 582a506..7bd994d 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -51,7 +51,7 @@ scripts are also run in a controlled environment.
2.13.1.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="//skarnet.org/software/execline/">execline</a> version
-2.9.1.0 or later. It's a build-time <em>and</em> run-time requirement. </li>
+2.9.2.0 or later. It's a build-time <em>and</em> run-time requirement. </li>
<li> <a href="//skarnet.org/software/s6/">s6</a> version
2.11.3.0 or later. It's a build-time <em>and</em> run-time requirement. </li>
</ul>
@@ -67,7 +67,7 @@ requirement if you link against the shared version of the skalibs library. </li>
<ul>
<li> The current released version of s6-rc is
-<a href="s6-rc-0.5.3.4.tar.gz">0.5.3.4</a>. </li>
+<a href="s6-rc-0.5.4.0.tar.gz">0.5.4.0</a>. </li>
<li> Alternatively, you can checkout a copy of the
<a href="//git.skarnet.org/cgi-bin/cgit.cgi/s6-rc/">s6-rc
git repository</a>:
diff --git a/doc/s6-rc.html b/doc/s6-rc.html
index bccc1b5..d5013c4 100644
--- a/doc/s6-rc.html
+++ b/doc/s6-rc.html
@@ -220,6 +220,20 @@ a permanent failure - which means its
stopped trying to bring it back up.
</p>
+<h3> s6-rc start </h3>
+
+<p>
+ <tt>s6-rc start</tt> is equivalent to <tt>s6-rc -u change</tt>, see
+below. It will run the engine to start a set of services.
+</p>
+
+<h3> s6-rc stop </h3>
+
+<p>
+ <tt>s6-rc stop</tt> is equivalent to <tt>s6-rc -d change</tt>, see
+below. It will run the engine to stop a set of services.
+</p>
+
<h3> s6-rc change </h3>
<p>
@@ -235,7 +249,12 @@ machine to a state where:
</ul>
<p>
- To do so:
+ (Note that the <tt>-p</tt> option is inoperant when using the <tt>start</tt>
+or <tt>stop</tt> subcommands.)
+</p>
+
+<p>
+ To change the machine state, s6-rc does the following:
</p>
<ul>
@@ -388,13 +407,13 @@ oneshot service is in. </li>
<h2> Usage examples </h2>
-<pre> s6-rc change <em>myservicebundle</em> </pre>
+<pre> s6-rc start <em>myservicebundle</em> </pre>
<p>
Brings up all the services represented by <em>myservicebundle</em>,
bringing up all its dependencies first (recursively).
</p>
-<pre> s6-rc -bad change </pre>
+<pre> s6-rc -ba down </pre>
<p>
Waits for any pending program of the s6-rc family to stop using
the live database and current compiled service database, then
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 348fef0..13bfad5 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -30,11 +30,13 @@ minor and bugfix version changes.
<h1> What has changed in s6-rc </h1>
-<h2> in 0.5.3.4 </h2>
+<h2> in 0.5.4.0 </h2>
<ul>
<li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
dependency bumped to 2.13.1.0. </li>
+ <li> <a href="//skarnet.org/software/execline/">execline</a>
+dependency bumped to 2.9.2.0. </li>
<li> <a href="//skarnet.org/software/s6/">s6</a>
dependency bumped to 2.11.3.0. </li>
</ul>