From e99f9eb75cf428c99f86415a87b807e13796ad23 Mon Sep 17 00:00:00 2001
From: obarun <eric@obarun.org>
Date: Mon, 7 Jan 2019 18:22:52 +1100
Subject: [PATCH] doc update
---
doc/66-all.html | 18 ++++++++--------
doc/66-dbctl.html | 22 +++++++++----------
doc/66-enable.html | 24 ++++++++++-----------
doc/66-info.html | 36 +++++++++++++++----------------
doc/66-stop.html | 49 +++++++++++++++++++++---------------------
doc/66-svctl.html | 49 +++++++++++++++++++++---------------------
doc/execl-cmdline.html | 20 ++++++++---------
doc/frontend.html | 2 +-
8 files changed, 110 insertions(+), 110 deletions(-)
diff --git a/doc/66-all.html b/doc/66-all.html
index 369808b8..04e93b6b 100644
--- a/doc/66-all.html
+++ b/doc/66-all.html
@@ -18,7 +18,7 @@
<h1>66-all</h1>
<p>
- This command handles all <em>service</em> for all <em>tree</em> define for the current user of the proccess.
+ This command handles all <em>services</em> for any <em>tree</em> defined for the current user of the proccess at once.
</p>
<h2> Interface </h2>
@@ -27,9 +27,9 @@
</pre>
<p>
- This tool expects to find an enabled <em>tree(s)</em>—see <a href="66-tree.html"><tt>66-tree -E</tt></a> option, or a specific one given by <tt>-t</tt> option of the current user of the process
- and an already running <em>scandir</em>.
- This tool is a safe wrapper build around <tt><a href="66-start.html">66-start</a></tt> and <tt><a href="66-stop.html">66-stop</a></tt> tools.
+ Any enabled <em>tree</em>—see <a href="66-tree.html"><tt>66-tree -E</tt></a>—or a specific one passed with the <tt>-t</tt> option,
+ and an already running <em>scandir</em> will be processed.
+ It is a safe wrapper around <tt><a href="66-start.html">66-start</a></tt> and <tt><a href="66-stop.html">66-stop</a></tt>.
</p>
@@ -57,18 +57,18 @@
<li>
<tt>-T <em>timeout</em></tt></tt> : specifies a general timeout (in milliseconds)
- passed to <tt>66-start</tt> or <tt>66-stop</tt> program.
- By default, the timeout is 0, which means infinite.
+ passed to <tt>66-start</tt> or <tt>66-stop</tt>.
+ By default the timeout is set to 0 (infinite).
</li>
<li>
- <tt>up </tt> : sends a up signal to the all <em>service</em> of all <em>tree</em>.
+ <tt>up </tt> : sends an <em>up</em> signal to every <em>service</em> inside any <em>tree</em> processed by the command.
</li>
<li>
- <tt>down </tt> : sends a down signal to the all <em>service</em> of all <em>tree</em>.
+ <tt>down </tt> : sends a <em>down</em> signal to every <em>service</em> inside any <em>tree</em> processed by the command.
</li>
</ul>
<h2> Initialization phase </h2>
-<p>In case of <tt>up</tt> signal, <tt>66-all</tt> will launch <tt><a href="66-init.html">66-init</a></tt> program to initiate <em>service(s)</em> of the <em>tree(s)</em>.</p>
+<p>In case <tt>up</tt> was passed as option, <tt>66-all</tt> will automatically launch <tt><a href="66-init.html">66-init</a></tt> to initiate all <em>services</em> of the <em>trees</em> processed by the command. As described above this means either any enabled tree for the user currently launching the process or just the tree passed with the -t option.</p>
</body>
</html>
diff --git a/doc/66-dbctl.html b/doc/66-dbctl.html
index ed01735e..718f91a7 100644
--- a/doc/66-dbctl.html
+++ b/doc/66-dbctl.html
@@ -18,7 +18,7 @@
<h1>66-dbctl</h1>
<p>
- This command is used to control an already supervised <em>services</em> in <em>live</em> defined in <em>tree</em>.
+ This command is used to control an already supervised <em>service</em> in <em>live</em> defined in <em>tree</em>.
</p>
<h2> Interface </h2>
@@ -27,10 +27,10 @@
</pre>
<p>
- This tool expects to find an already supervised <em>service</em> in <em>live</em> defined in the given <em>tree</em> and an already running <em>scandir</em>.
- This tool only deal with <em>'bundle'</em>, <em>'longrun'</em>, <em>'oneshot'</em> service—see <a href="66-svctl.html"><tt>66-svctl</tt></a> for <em>'classic'</em> services.
+ 66-dbctl expects to find an already supervised <em>service</em> in <em>live</em> defined in the given <em>tree</em> and an already running <em>scandir</em>.
+ <br><b>(!)</b> This tool <b>only</b> deals with <b><em>'bundle'</em></b>, <b><em>'longrun'</em></b> and <b><em>'oneshot'</em></b> services—for <em>'classic'</em> services see <a href="66-svctl.html"><tt>66-svctl</tt></a>.
</p>
- <p>Multiple <em>services</em> can be handled by seperating their names with a space. <tt>66-dbctl</tt> gathers the service(s) passed as argument in a list called <em>selection</em>.</p>
+ <p>Multiple <em>services</em> can be handled by separating their names with a space. <tt>66-dbctl</tt> gathers the services passed as argument in a list called <em>selection</em>.</p>
<h2> Options </h2>
@@ -51,26 +51,26 @@
should be within a writable filesystem - likely a RAM filesystem—see <tt><a href="66-scandir.html">66-scandir</a></tt>.
</li>
<li>
- <tt>-t <em>tree</em></tt> : handles the <em>selection</em> from
+ <tt>-t <em>tree</em></tt> : handles the <em>selection</em> of
the given <em>tree</em>. This option is mandatory
except if a tree was marked as 'current'—see <a href="66-tree.html"><tt>66-tree</tt></a>.
</li>
<li>
<tt>-T <em>timeout</em></tt></tt> : specifies a general timeout (in milliseconds)
- after which <tt>66-dbctl</tt> will exit 111 with an error message if the <em>selection</em> still hasn't reached the desired state for each <em>service</em>.
- By default, the timeout is 0, which means that <tt>66-dbctl</tt> will block indefinitely.
+ after which <tt>66-dbctl</tt> will exit 111 with an error message if the <em>selection</em> still hasn't reached the desired state for each <em>service</em>;
+ default is 0 (blocks indefinitely).
</li>
<li>
- <tt>-u </tt> : sends a up signal to the <em>service</em>.
+ <tt>-u </tt> : sends an <em>up</em> signal to the <em>service</em>.
</li>
<li>
- <tt>-d </tt> : sends a down signal to the <em>service</em>.
+ <tt>-d </tt> : sends a <em>down</em> signal to the <em>service</em>.
</li>
</ul>
<h2> Note </h2>
-<p>This tool is a safe wrapper built around <tt><a href="https://skarnet.org/software/s6-rc/s6-rc.html">s6-rc</a></tt>. It only handles <tt>66</tt> ecosystem files before sending the <em>selection</em> to
-<tt>s6-rc</tt> program.</p>
+<p>This tool is a safe wrapper around <tt><a href="https://skarnet.org/software/s6-rc/s6-rc.html">s6-rc</a></tt>. It exclusively handles files that form part of the <tt>66</tt> ecosystem before sending the <em>selection</em> list to
+<tt>s6-rc</tt>.</p>
</body>
</html>
diff --git a/doc/66-enable.html b/doc/66-enable.html
index 51af094b..f0e20eb3 100644
--- a/doc/66-enable.html
+++ b/doc/66-enable.html
@@ -23,11 +23,11 @@
<h2> Interface </h2>
<pre>
- 66-enable [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -f force ] [ -S start ] <em>service(s)</em>
+ 66-enable [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -f force ] [ -S start ] <em>service(s)</em>"
</pre>
<p>
- This tool expects to find a corresponding <a href="frontend.html">frontend service file</a> or a directory name—see <a href="#directory">below</a> or an instance <em>service</em>—see <a href="#instance">below</a>, by default at <tt>/etc/66/service</tt>. The default path can be changed at compile time
+ This tool expects to find a corresponding <a href="frontend.html">frontend service file</a>, a directory name (see <a href="#directory">below</a>) or a <em>service</em> instance (see <a href="#instance">below</a>), by default at <tt>/etc/66/service</tt>. The default path can be changed at compile time
by passing the <tt>--with-service-path=<em>DIR</em></tt> option to
<tt>./configure.</tt> It will run a parser on the frontend service file and write the result to the directory of the given <em>tree</em>—see <a href="66-tree.html">66-tree</a>. The <em>service</em> will then be available in the given
<em>tree</em> for the next boot depending on the state of the
@@ -69,25 +69,25 @@
</li>
</ul>
-<h2 id="dependencies">Dependencies handling</h2>
-<p>In case of <tt><em>'bundle'</em></tt>, <tt><em>'longrun'</em></tt> or <tt><em>'oneshot'</em></tt> services, the dependencies chain will be automatically resolves.
-It is unnecessary to manually define chained sets of dependencies. If FooA have a declared dependency FooB, FooB will be automatically added to the chain at FooA enabling process.
-This is done recursively.</p>
+<h2 id="dependencies">Dependency handling</h2>
+<p>For <em>services</em> of type <tt><em>'bundle'</em></tt>, <tt><em>'longrun'</em></tt> or <tt><em>'oneshot'</em></tt> any existing dependency chain will be automatically resolved.
+It is unnecessary to manually define chained sets of dependencies. If FooA has a declared dependency on another service with the name FooB then FooB will be automatically enabled too when enabling FooA.
+This works recursively until all necessary dependencies are enabled.</p>
<h2 id="directory">Directory name as <em>service</em></h2>
- <p>The name of the directory must exist by default at <tt>/etc/66/service</tt> depending on the option given at compile time. All <em>service</em> files found into the given directory will be enabled. The directory can contain a mixed set of <tt><em>bundle</em></tt>, <tt><em>longrun</em></tt> and <tt><em>oneshot</em></tt>
+ <p>When choosing to make a directory be recognised as service the path of the directory must exist by default at <tt>/etc/66/service</tt> depending on the option given at compile time. All <em>service</em> files found in this directory will be enabled. The directory can contain a mixed set of <tt><em>bundle</em></tt>, <tt><em>longrun</em></tt> and <tt><em>oneshot</em></tt>
services where some of those depend on each other. The directory option is not limited to these types though. Any available service type can be part of the set.</p>
<p>A good example is a set of services for the boot process. To achieve
this specific task a large number of <tt><em>oneshot</em></tt> services is used along with some <tt><em>classic</em></tt>
services.</p>
- <p>The parser resolves the <em>services</em> dependencies chain.</p>
- <p>This option and its mechanics can be subject to change in future releases of the 66-enable tool.</p>
+ <p>The parser automatically resolves any existing dependency chain for the processed <em>services</em> just as it would for any regular service.</p>
+ <p>(!) This option and its mechanics can be subject to change in future releases of the 66-enable tool.</p>
-<h2 id="instance">Instance <em>service</em></h2>
- <p>An instance <em>service</em> name from a service template can be passed as arguments where the name of <em>service</em> must end with a '@' (commercial at).
+<h2 id="instance">Instanced <em>service</em></h2>
+ <p>An instanced <em>service</em> name from a service template can be passed as argument where the name of the <em>service</em> must end with a '@' (commercial at).
—see <a href="frontend.html#instance"><tt>frontend service file</tt></a>.</p>
- <p>The name of the <em>service</em> template <strong>must be</strong> declared first immediately followed by the <em>service</em> name to create as the following example :
+ <p>(!) The name of the template must be declared first immediately followed by the instance name as shown in the following example :
<pre> 66-enable tty@tty1</pre></p>
</body>
diff --git a/doc/66-info.html b/doc/66-info.html
index a1e7a02d..9b817f16 100644
--- a/doc/66-info.html
+++ b/doc/66-info.html
@@ -18,7 +18,7 @@
<h1>66-info</h1>
<p>
- This command display information of trees and services.
+ This command displays information about trees and services.
</p>
<h2>Interface </h2>
@@ -35,7 +35,7 @@
66-info [ -S ] [ -h help ] [ -v <em>verbosity</em> ] [ -l live ] [ -p n lines ] [ -r recurse ] [ -d <em>depth</em> ] <em>service</em>
</pre>
<p>
- 66-info displays information about the <em>tree</em> or a specific <em>service</em> depending of the options passed.
+ 66-info displays detailed information about a <em>tree</em> or a specific <em>service</em> depending on the options passed.
</p>
<h2>Main Options </h2>
@@ -57,21 +57,21 @@
<tt>-h </tt> : prints this help.
</li>
<li>
- <tt>-v <em>verbosity</em> </tt>: increases/decreases
+ <tt>-v <em>verbosity</em> </tt> : increases/decreases
the verbosity of the command. <tt>1(Default)</tt>: Only print
error messages. <tt>2</tt>: Also print warning messages.
<tt>3</tt>: Also print debugging messages.
</li>
<li>
- <tt>-r </tt> : recurse the result of the service dependencies graph of the <em>tree</em>.
+ <tt>-r </tt> : shows the dependency graph of <em>tree</em>.
</li>
<li>
- <tt>-d <em>depth</em></tt> : limit the depth of the recursion service dependencies graph. By default this will be 1.
+ <tt>-d <em>depth</em> </tt> : limits the depth of the dependency graph visualisation; defaults to 1.
</li>
- <p>If <em>tree</em> is not specified, <tt>66-info</tt> displays information about all available tree for the current owner of the process.</p>
+ <p>(!) If <em>tree</em> is not specified <tt>66-info</tt> will display information about all available trees for the current owner of the process.</p>
</ul>
<h2>Service sub options </h2>
@@ -80,25 +80,25 @@
<tt>-h </tt> : prints this help.
</li>
<li>
- <tt>-v <em>verbosity</em> </tt>: increases/decreases
+ <tt>-v <em>verbosity</em> </tt> : increases/decreases
the verbosity of the command. <tt>1(Default)</tt>: Only print
error messages. <tt>2</tt>: Also print warning messages.
<tt>3</tt>: Also print debugging messages.
</li>
<li>
- <tt>-l <em>live</em></tt> : changes the supervision directory of <em>service</em> to <em>live</em>. By default this will be <tt>/run/66</tt>. The default can
+ <tt>-l <em>live</em> </tt> : changes the supervision directory of <em>service</em> to <em>live</em>. By default this will be <tt>/run/66</tt>. The default can
also be changed at compile time by passing the <tt>--livedir=<em>live</em></tt>
option to <tt>./configure</tt>. An existing absolute path is expected and
should be within a writable filesystem - likely a RAM filesystem—see <tt><a href="66-scandir.html">66-scandir</a></tt>.
</li>
<li>
- <tt>-p <em>n lines</em></tt> : prints the <em>n</em> last lines from the associated log file of the <em>service</em>.
+ <tt>-p <em>n lines</em> </tt> : prints the <em>n</em> last lines from the associated log file of the <em>service</em>.
</li>
<li>
- <tt>-r </tt> : recurse the result of the service dependencies graph of the <em>service</em>.
+ <tt>-r </tt> : shows the dependency graph of <em>service</em>.
</li>
<li>
- <tt>-d <em>depth</em></tt> : limit the depth of the recursion service dependencies graph. By default this will be 1.
+ <tt>-d <em>depth</em> </tt> : limits the depth of the dependency graph visualisation; defaults to 1.
</li>
</ul>
@@ -147,14 +147,14 @@
└─tty12 :classic
</pre>
</p>
- <p>The first line give you usefull information about the <em>tree</em> itself where <tt><em>Name</em></tt> is the name of the tree,
- <tt><em>Current</em></tt> if the <em>tree</em> is the current one or not—see <tt><a href="66-tree.html">66-tree -c</a></tt> option,
- <tt><em>Enabled</em></tt> the state of the tree—see <tt><a href="66-tree.html">66-tree -E</a></tt> option.
- In front of each service name, the type of the service is displayed.
+ <p>The first line gives you useful information about the <em>tree</em> itself where <tt><em>Name</em></tt> is the name of the tree,
+ <tt><em>Current</em></tt> tells if the <em>tree</em> is the current one or not—see <tt><a href="66-tree.html">66-tree -c</a></tt> and
+ <tt><em>Enabled</em></tt> reveals the state of the tree—see <tt><a href="66-tree.html">66-tree -E</a></tt>.
+ In addition to the name of each service the type of the service is shown next to it.
</p>
<p>
- By default the service dependencies graph is displayed by finished order of execution. In our case the <em>'bundle' All</em> is the last finished
- service and so, <em>'classic' tty12</em> is the first one executed.
+ By default the dependency graph is rendered in order of execution. In this example the <em>'bundle' All</em> is the last finished
+ service and <em>'classic' tty12</em> is the first one executed.
</p>
<h2>Service output display example</h2>
@@ -175,7 +175,7 @@
└─conf :oneshot
</pre>
</p>
- <p>Let's take an another example, the command sudo <tt>66-info -S -p5 ntpd</tt> displays the following:
+ <p>Let's take another example, the command sudo <tt>66-info -S -p5 ntpd</tt> displays the following:
<pre> [ntpd]
tree : root
status : up (pid 11458) 30 seconds
diff --git a/doc/66-stop.html b/doc/66-stop.html
index d6f9acc3..6151a9d6 100644
--- a/doc/66-stop.html
+++ b/doc/66-stop.html
@@ -23,13 +23,13 @@
<h2> Interface </h2>
<pre>
- 66-stop [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -u unsupervise ] <em>service(s)</em>
+ 66-stop [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -u unsupervise ] <em>service</em>"
</pre>
<p>
- This tool expects to find an already enabled service inside the given <em>tree</em> and started inside an already running <em>scandir</em>.
- If the state of the <em>service</em> is already down, <tt>66-stop</tt> does nothing.
- Generally speaking this command is the strict opposite of the <tt><a href="66-start.html">66-start</a></tt> tool.</p>
+ The <em>service</em> to be stopped is expected to be enabled inside the given <em>tree</em> and started inside an already running <em>scandir</em>.
+ If the state of the <em>service</em> is already down <tt>66-stop</tt> does nothing.
+ Generally speaking this command is the strict opposite of <tt><a href="66-start.html">66-start</a></tt>.</p>
<p>Multiple <em>services</em> can be stopped by seperating their names with a space.</p>
<h2> Options </h2>
@@ -38,41 +38,40 @@
<li> <tt>-h </tt> : prints this help. </li>
<li>
- <tt>-v <em>verbosity</em> </tt>: increases/decreases
+ <tt>-v <em>verbosity</em> </tt> : increases/decreases
the verbosity of the command. <tt>1(Default)</tt>: Only print
error messages. <tt>2</tt>: Also print warning messages.
<tt>3</tt>: Also print debugging messages.
</li>
<li>
- <tt>-l <em>live</em></tt> : changes the supervision directory of <em>service</em> to <em>live</em>. By default this will be <tt>/run/66</tt>. The default can
+ <tt>-l <em>live</em> </tt> : changes the supervision directory of <em>service</em> to <em>live</em>. By default this will be <tt>/run/66</tt>. The default can
also be changed at compile time by passing the <tt>--livedir=<em>live</em></tt>
option to <tt>./configure</tt>. An existing absolute path is expected and
should be within a writable filesystem - likely a RAM filesystem—see <tt><a href="66-scandir.html">66-scandir</a></tt>.
</li>
<li>
- <tt>-t <em>tree</em></tt> : stops the <em>service</em> from
+ <tt>-t <em>tree</em> </tt> : stops <em>service</em> in
the given <em>tree</em>. This option is mandatory
except if a tree was marked as 'current'—see <a href="66-tree.html"><tt>66-tree</tt></a>.
</li>
<li>
- <tt>-T <em>timeout</em></tt></tt> : specifies a timeout (in milliseconds)
- after which <tt>66-stop</tt> will exit 111 with an error message if the service still hasn't reached the up state.
- By default, the timeout is 1000.
+ <tt>-T <em>timeout</em> </tt></tt> : specifies a timeout (in milliseconds)
+ after which <tt>66-stop</tt> will exit 111 with an error message if the service still hasn't reached the up state;
+ defaults to 1000.
</li>
<li>
<tt>-u </tt> : unsupervise the <em>service</em>.
- Remove the <em>service</em> directory from the <em>scandir</em> at the end of the stop process. This options has only effect for service as <tt><em>'classic'</em></tt> type.
+ Remove the <em>service</em> directory from the <em>scandir</em> at the end of the stop process. This option only applies to services of type <tt><em>'classic'</em></tt>.
</li>
</ul>
-<h2 id="dependencies">Dependencies handling</h2>
-<p>In case of <tt><em>'bundle'</em></tt>, <tt><em>'longrun'</em></tt> or <tt><em>'oneshot'</em></tt> services, any dependency chain will be resolved automatically.
-It is unnecessary to manually define chained sets of dependencies. If FooA has a declared dependency on FooB,
-FooB will be automatically considered and stopped first when stopping FooA.
-This will run recursively until all dependencies are stopped.</p>
+<h2 id="dependencies">Dependency handling</h2>
+<p>For <em>services</em> of type <tt><em>'bundle'</em></tt>, <tt><em>'longrun'</em></tt> or <tt><em>'oneshot'</em></tt> any existing dependency chain will be resolved automatically.
+It is unnecessary to manually define chained sets of dependencies. If FooA has a declared dependency on another service with the name FooB then FooB will be automatically considered and stopped first when stopping FooA.
+This works recursively until all dependencies are stopped.</p>
<h2>Classic service transitions</h2>
@@ -82,36 +81,36 @@ This will run recursively until all dependencies are stopped.</p>
<tt>66-stop</tt> gathers the classic service(s) passed as argument in a list called <em>selection</em>.
</li>
<li>
- The <em>selection</em> is inspected and searched for any logger that needs to be associated with the passed <em>service</em>.
- If any such instruction was found the corresponding logger service will be added to the <em>selection</em> as well.
+ The <em>selection</em> is then inspected and searched for any logger that may be associated with the passed <em>service(s)</em>.
+ If any such instruction was found the corresponding logger will be added to the <em>selection</em> as well.
</li>
<li>
- The command sends a <tt>66-svctl -v <em>verbosity</em> -T <em>timeout</em> -l <em>live</em> -t <em>tree</em> -D <em>selection</em></tt>
+ The command continues issueing <tt>66-svctl -v <em>verbosity</em> -T <em>timeout</em> -l <em>live</em> -t <em>tree</em> -D <em>selection</em></tt>
and waits for the resulting exit code.
</li>
<li>
- Finally the <em>service</em> directory is removed from the <em>scandir</em> in case of <tt><em>'classic'</em></tt> service type.
+ Finally the <em>service</em> directory is removed from the <em>scandir</em>.
</li>
</ul>
</p>
<p>If any one of these processes fails then as a result <tt>66-stop</tt> fails too and exits with code 111.</p>
<h2>Bundle, longrun, oneshot transitions</h2>
- <p>
+ <p>The process for these service types is very similar to that of classic services except for the automated command that adapts accordingly.
<ul>
<li>
<tt>66-stop</tt> gathers the bundle, longrun and/or oneshot service(s) passed as argument in a list called <em>selection</em>.
</li>
<li>
- The <em>selection</em> is inspected and searched for any logger that needs to be associated with the passed <em>service</em>.
- If any such instruction was found the corresponding logger service will be added to the <em>selection</em> as well.
+ The <em>selection</em> is then inspected and searched for any logger that may be associated with the passed <em>service(s)</em>.
+ If any such instruction was found the corresponding logger will be added to the <em>selection</em> as well.
</li>
<li>
- Finally the command sends a <tt>66-dbctl -v <em>verbosity</em> -T <em>timeout</em> -l <em>live</em> -t <em>tree</em> -d <em>selection</em></tt>
+ Finally the command issues <tt>66-dbctl -v <em>verbosity</em> -T <em>timeout</em> -l <em>live</em> -t <em>tree</em> -d <em>selection</em></tt>
and waits for the resulting exit code.
</li>
</ul>
</p>
-<p>If any one of these processes fails then as a result <tt>66-start</tt> fails too and exits with code 111.</p>
+<p>If any one of these processes fails then as a result <tt>66-stop</tt> fails too and exits with code 111.</p>
</body>
</html>
diff --git a/doc/66-svctl.html b/doc/66-svctl.html
index b0368745..ec47c0b1 100644
--- a/doc/66-svctl.html
+++ b/doc/66-svctl.html
@@ -18,7 +18,7 @@
<h1>66-svctl</h1>
<p>
- This command is used to control an already supervised <em>services</em> in <em>live</em> defined in <em>tree</em>.
+ This command is used to control an already supervised <em>service</em> at <em>live</em> defined in a <em>tree</em>.
</p>
<h2> Interface </h2>
@@ -27,10 +27,10 @@
</pre>
<p>
- This tool expects to find an already supervised <em>service</em> in <em>live</em> defined in the given <em>tree</em> and an already running <em>scandir</em>.
- This tool only deal with <em>'classic'</em> service—see <a href="66-dbctl.html"><tt>66-dbctl</tt></a> for other kind of services.
+ This tool expects to find an already supervised <em>service</em> at <em>live</em> defined in the given <em>tree</em> and an already running <em>scandir</em>.
+ <br>(!) This tool only deals with <em>'classic'</em> services—see <a href="66-dbctl.html"><tt>66-dbctl</tt></a> for other types of services.
</p>
- <p>Multiple <em>services</em> can be handled by seperating their names with a space. <tt>66-svctl</tt> gathers the service(s) passed as argument in a list called <em>selection</em>.</p>
+ <p>Multiple <em>services</em> can be handled by seperating their names with a space. <tt>66-svctl</tt> gathers each of these services in a list called <em>selection</em>.</p>
<h2> Options </h2>
@@ -38,58 +38,59 @@
<li> <tt>-h </tt> : prints this help. </li>
<li>
- <tt>-v <em>verbosity</em> </tt>: increases/decreases
+ <tt>-v <em>verbosity</em> </tt> : increases/decreases
the verbosity of the command. <tt>1(Default)</tt>: Only print
error messages. <tt>2</tt>: Also print warning messages.
<tt>3</tt>: Also print debugging messages.
</li>
<li>
- <tt>-l <em>live</em></tt> : changes the supervision directory of <em>service</em> to <em>live</em>. By default this will be <tt>/run/66</tt>. The default can
+ <tt>-l <em>live</em> </tt> : changes the supervision directory of <em>service</em> to <em>live</em>. By default this will be <tt>/run/66</tt>. The default can
also be changed at compile time by passing the <tt>--livedir=<em>live</em></tt>
option to <tt>./configure</tt>. An existing absolute path is expected and
should be within a writable filesystem - likely a RAM filesystem—see <tt><a href="66-scandir.html">66-scandir</a></tt>.
</li>
<li>
- <tt>-t <em>tree</em></tt> : handles the <em>service</em> from
+ <tt>-t <em>tree</em> </tt> : handles the <em>service</em> from
the given <em>tree</em>. This option is mandatory
except if a tree was marked as 'current'—see <a href="66-tree.html"><tt>66-tree</tt></a>.
</li>
<li>
- <tt>-T <em>timeout</em></tt></tt> : specifies a general timeout (in milliseconds)
- after which <tt>66-svctl</tt> will exit 111 with an error message if the <em>selection</em> still hasn't reached the desired state for each <em>service</em>.
- By default, the timeout is 0, which means that <tt>66-svctl</tt> will block indefinitely.
+ <tt>-T <em>timeout</em> </tt></tt> : specifies a general timeout (in milliseconds)
+ after which <tt>66-svctl</tt> will exit 111 with an error message if the <em>selection</em> still hasn't reached the desired state for each <em>service</em>;
+ defaults to 0 (blocks indefinitely).
</li>
<li>
- <tt>-S <em>service timeout</em></tt> : specifies a timeout (in milliseconds)
+ <tt>-S <em>service timeout</em> </tt> : specifies a timeout (in milliseconds)
after which <tt>66-svctl</tt> will exit 111 with an error message if the <em>services</em> still hasn't reached the desired state.
- This option has <strong>no effects</strong> if a <em>timeout-up</em> (for <em>up</em> signal) or <em>timeout-down</em> (for <em>down</em> signal) was defined
- for the given service at the parsing time—see <tt><a href="66-frontend.html">frontend</a></tt>. In such case priority is given to those files.
- If the option is not given and the <em>timeout-up,timeout-down</em> files doesn't exist, 1000 is pick by default.
+ This option has <strong>no effect</strong> if a <em>timeout-up</em> (for <em>up</em> signal) or <em>timeout-down</em> (for <em>down</em> signal) was defined
+ for the given service at parsing time—see <tt><a href="66-frontend.html">frontend</a></tt>.
+ If this option is not specified and no <em>timeout-up</em> or <em>timeout-down</em> file exists the timeout will default to 1000.
</li>
<li>
- <tt>-n <em>death</em></tt> : specifies the maximum number of service death events that the supervisor will keep track.
+ <tt>-n <em>death</em> </tt> : specifies the maximum number of service death events that the supervisor will keep track of.
If the service dies more than this number of times, <tt>66-svctl</tt> will exit 111 with an error message if the <em>services</em> still hasn't reached the desired state.
- This option has <strong>no effects</strong> if a <em>maxdeath</em> was defined for the given service at the parsing time—see <tt><a href="66-frontend.html">frontend</a></tt>.
- In such case priority is given to this file. If the option is not given and the <em>max-death-tally</em> files doesn't exist, 3 is pick by default.
+ This option has <strong>no effect</strong> if a <em>maxdeath</em> was defined for the given service at parsing time—see <tt><a href="66-frontend.html">frontend</a></tt>.
+ If this option is not specified and no <em>max-death-tally</em> file exists the maximum allowed deaths will default to 3.
</li>
<li>
- <tt>-u|U </tt> : sends a up signal to the <em>service</em> where <tt>U</tt> asks for readiness notification. In case of <tt>U</tt>, <tt>66-svctl</tt> look after a <em>notification-fd</em>
+ <tt>-u|U </tt> : sends an <em>up</em> signal to the <em>service</em>. Uppercase <tt>U</tt> asks for readiness notification and searches for a <em>notification-fd</em>
file—see <tt><a href="https://skarnet.org/software/s6/notifywhenup.html">service startup notifications</a></tt> and <tt><a href="66-frontend.html">frontend</a></tt>.
- In such case priority is given to this file. If such file doesn't exist, <tt>66-svctl</tt> will change the <tt>U</tt> to <tt>u</tt> and warn the user about the change.
+ If this file doesn't exist <tt>66-svctl</tt> will automatically change to lowercase <tt>u</tt> and warn the user about the change.
</li>
<li>
- <tt>-d|D </tt> : sends a down signal to the <em>service</em> where <tt>D</tt> asks for readiness notification. In case of <tt>D</tt>, <tt>66-svctl</tt> look after a <em>notification-fd</em>
+ <tt>-d|D </tt> : sends a <em>down</em> signal to the <em>service</em>. Uppercase <tt>D</tt> asks for readiness notification and searches for a <em>notification-fd</em>
file—see <tt><a href="https://skarnet.org/software/s6/notifywhenup.html">service startup notifications</a></tt> and <tt><a href="66-frontend.html">frontend</a></tt>.
- In such case priority is given to this file. If such file doesn't exist, <tt>66-svctl</tt> will change the <tt>D</tt> to <tt>d</tt> and warn the user about the change.
+ If this file doesn't exist <tt>66-svctl</tt> will automatically change to lowercase <tt>d</tt> and warn the user about the change.
</li>
</ul>
<h2> Note </h2>
-<p>You can sends a signal to a <em>'classic'</em> service with the <tt><a href="https://skarnet.org/software/s6/s6-svc.html">s6-svc</a></tt> program. <tt>s6-svc</tt> has the philosophy <em>"launch and forget"</em>
-and do not take care of the exit status of the service when a signal is sends. <tt>s6-svctl</tt> does. Futhermore, the <tt>-S</tt> and <tt>-n</tt> allow you to deal directly on the command line with the
-<em>timeout-up</em> and <em>timeout-down</em> options even if those files doesn't exist.</p>
+<p>You can also send a signal in a similar fashion to a <em>'classic'</em> service with the <tt><a href="https://skarnet.org/software/s6/s6-svc.html">s6-svc</a></tt> tool which has the philosophy <em>"launch and forget"</em>.
+In contrast to <tt>s6-svctl</tt> this does not care for the exit status of the service when a signal is sent.</p>
+<p>As an extra convenience the <tt>-S</tt> and <tt>-n</tt> options allow you to deal directly on the command line with
+<em>timeout-up</em> and <em>timeout-down</em> even if these were not specified explicitely in the services frontend file and no corresponding files exist.</p>
</body>
</html>
diff --git a/doc/execl-cmdline.html b/doc/execl-cmdline.html
index c5874d60..06c17aaf 100644
--- a/doc/execl-cmdline.html
+++ b/doc/execl-cmdline.html
@@ -18,14 +18,14 @@
<h1>execl-cmdline</h1>
<p>
- This command parse a <em>command</em> line into an <a href="https://skarnet.org/software/execline"><tt>execline</tt></a> script.
+ This command parses a <em>command</em> line into an <a href="https://skarnet.org/software/execline"><tt>execline</tt></a> script.
</p>
<h2> Interface </h2>
<p>
- In an <a href="execlineb.html">execlineb</a> script:
+ As <a href="execlineb.html">execlineb</a> script:
</p>
<pre>
@@ -34,10 +34,10 @@
<ul>
<li>
- <tt>execl-cmdline</tt> reads the <em>command</em> and remove all space or 'no word' found before executing it.
+ <tt>execl-cmdline</tt> reads the <em>command</em> and removes all whitespace or 'no word' before executing.
</li>
<li>
- <tt>execl-cmdline</tt> will exit with the exit code of the <em>command</em>.
+ <tt>execl-cmdline</tt> exits with the exit code of the <em>command</em>.
</li>
</ul>
@@ -45,30 +45,30 @@
<ul>
<li>
- <tt>-S </tt> : split into separate words a command considered as one word by <em>execline</em> scripting language.
+ <tt>-S </tt> : splits a command considered by <em>execline</em> scripting language as one word into separate words.
</li>
</ul>
<h2> Note and usage examples </h2>
- <p><tt>execl-cmdline</tt> should be used at the end of the <em>execline</em> scripts. If you want run another program after the call of <tt>execl-cmdline</tt> you need to use e.g
+ <p><tt>execl-cmdline</tt> should be used at the end of <em>execline</em> scripts. If you want to run another program after the call of <tt>execl-cmdline</tt> you would need to use an
<a href="https://skarnet.org/software/execline/if.html"><tt>if</tt></a> command, <a href="https://skarnet.org/software/execline/foreground.html"><tt>foreground</tt></a>,
- <a href="https://skarnet.org/software/execline/background.html"><tt>background</tt></a>, ...</p>
+ <a href="https://skarnet.org/software/execline/background.html"><tt>background</tt></a> or the likes.</p>
<p>
The following <em>command</em>:
<pre>
execl-cmdline { /usr/bin/ntpd -d "" -S }
</pre>
- will give:
+ will result in:
<pre>
/usr/bin/ntpd "-d" "-S"
</pre>
</p>
<p>
- The following <em>command</em>:
+ This <em>command</em>:
<pre>
execl-cmdline -S { /usr/bin/ntpd "-d -S" }
</pre>
- will give:
+ will result in:
<pre>
/usr/bin/ntpd "-d" "-S"
</pre>
diff --git a/doc/frontend.html b/doc/frontend.html
index a3e923b5..90c0450c 100644
--- a/doc/frontend.html
+++ b/doc/frontend.html
@@ -511,7 +511,7 @@ MYVALUE</pre>
<p>This will create the file <tt>down-signal</tt> which is
used to kill the supervised process when a <tt><a href="66-start.html">66-start -r</a></tt> or
<tt><a href="66-stop.html">66-stop</a></tt> command is used.
- If the file does not exist, SIGTERM will be used by default. </p>
+ If the file does not exist SIGTERM will be used by default. </p>
</li>
</ul>
</ul>
--
GitLab