diff --git a/doc/66-all.html b/doc/66-all.html
index 04e93b6bb405263a8203cee3e839c1f091261774..4eec743b5eb7785e21ac1fd8f8bbb4fa55df1e07 100644
--- a/doc/66-all.html
+++ b/doc/66-all.html
@@ -23,11 +23,11 @@
<h2> Interface </h2>
<pre>
- 66-all [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T timeout ] <em>up/down</em>
+ 66-all [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -T <em>timeout</em> ] [ -f ] [ -t <em>tree</em> ] <em>up/down</em>
</pre>
<p>
- 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,
+ 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>-o</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>
@@ -51,15 +51,19 @@
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> : only handles <em>service(s)</em> for <em>tree</em>.
- </li>
-
+
<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>.
By default the timeout is set to 0 (infinite).
</li>
+ <li>
+ <tt>-f </tt> : fork the process and lose the controlling terminal. This option should be used only for a shutdown process.
+ </li>
+ <li>
+ <tt>-t <em>tree</em></tt> : only handles <em>service(s)</em> for <em>tree</em>.
+ </li>
+
<li>
<tt>up </tt> : sends an <em>up</em> signal to every <em>service</em> inside any <em>tree</em> processed by the command.
</li>
@@ -69,6 +73,6 @@
</ul>
<h2> Initialization phase </h2>
-<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>
+<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 -o option.</p>
</body>
</html>
diff --git a/doc/66-dbctl.html b/doc/66-dbctl.html
index 718f91a71b79ed3a58f13ba7849aa0e23d68defb..2f1500561d8f1883fc16426da980cd6621164031 100644
--- a/doc/66-dbctl.html
+++ b/doc/66-dbctl.html
@@ -23,14 +23,15 @@
<h2> Interface </h2>
<pre>
- 66-dbctl [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -u up ] [ -d down ] <em>service(s)</em>
+ 66-dbctl [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -u | d | r ] <em>service(s)</em>
</pre>
<p>
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>.
+ <br><b>(!)</b> This tool <b>only</b> deals with <b><em>'bundle'</em></b> and <b><em>'atomic'</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 separating their names with a space. <tt>66-dbctl</tt> gathers the services passed as argument in a list called <em>selection</em>.</p>
+ <p>If <em>service</em> is not given, 66-dbctl deals with all <b><em>'atomic'</em></b> services of the given <em>tree</em>.</p>
<h2> Options </h2>
@@ -67,6 +68,9 @@
<li>
<tt>-d </tt> : sends a <em>down</em> signal to the <em>service</em>.
</li>
+ <li>
+ <tt>-r </tt> : reload the <em>service</em>. It sends a <em>down</em> signal then a <em>up</em> signal to the <em>service</em>.
+ </li>
</ul>
<h2> Note </h2>
diff --git a/doc/66-disable.html b/doc/66-disable.html
index 6020a2621388bc6b6230a5a860b8524fb86f64a1..6e75a6a0444b6654adc3ab5dd00e7cd089eac55e 100644
--- a/doc/66-disable.html
+++ b/doc/66-disable.html
@@ -23,7 +23,7 @@
<h2> Interface </h2>
<pre>
- 66-disable [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -S stop ] <em>service(s)</em>
+ 66-disable [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -S ] <em>service(s)</em>
</pre>
<p>
@@ -65,12 +65,8 @@
<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 automatically resolved.
+<p>In case of <tt><em>'bundle'</em></tt> or <tt><em>'atomic'</em></tt> services, any dependency chain will be automatically resolved.
It is unnecessary to manually define chained sets of dependencies. If FooA has a declared dependency on FooB, FooB will be automatically disabled as well when disabling FooA.
This will run recursively until all dependencies are disabled.</p>
-<!-- ...but only if the chained services do not have other processes running that require it. -->
-
-<!-- Is the before commented sentence true? Would make sense to mention it if it was. -->
-
</body>
</html>
diff --git a/doc/66-enable.html b/doc/66-enable.html
index f0e20eb3c869ea0d8a016ae05d5e1d1c1dacd1f4..9eb6b9ca639c934c8d5ab115c7238087b2ada525 100644
--- a/doc/66-enable.html
+++ b/doc/66-enable.html
@@ -23,12 +23,12 @@
<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 ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -f ] [ -S ] <em>service(s)</em>"
</pre>
<p>
- 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
+ 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/sysadmin/service</tt> or <tt>/etc/66/service</tt> in this order of precedence for root user and <tt>$HOME/.66/service</tt> or <tt>/etc/66/service</tt> in this order of precedence for a normal user. The default path can be changed at compile time
+ by passing the <tt>--with-sys-service=<em>DIR</em></tt>, <tt>--with-packager-service=<em>DIR</em></tt> and <tt>--with-user-service=<em>DIR</em></tt> 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
<em>tree</em>. The targeted service(s) can also be started on the fly when enabling it with the <tt>-S</tt> option.
@@ -60,7 +60,7 @@
</li>
<li>
- <tt>-f </tt> : reenables an already enabled <em>service</em> with the given options.
+ <tt>-f </tt> : reenables an already enabled <em>service</em> with the given options. This option will run again the process from the start and overwrite all existing files.
</li>
<li>
@@ -70,14 +70,13 @@
</ul>
<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.
+<p>For <em>services</em> of type <tt><em>'bundle'</em></tt> or <tt><em>'atomic'</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>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>When choosing to make a directory be recognised as service the path of the directory must exist by default at <tt>/etc/66/sysadmin/service</tt>, <tt>/etc/66/service</tt> or <tt>$HOME/.66/service</tt> depending of the owner of the process and 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> and <tt><em>atomic</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>
@@ -89,6 +88,8 @@ This works recursively until all necessary dependencies are enabled.</p>
—see <a href="frontend.html#instance"><tt>frontend service file</tt></a>.</p>
<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>
-
+ <p>Also an instanced <em>service</em> can be declared on the <em>@depends</em> field of the frontend service file.</p>
+<h2 id="configuration"><em>Service</em> configuration file</h2>
+ <p>If the <a href="frontend.html#environment">environment</a> section is set on the frontend service file, the parse result process can be found by default at <tt>/etc/66/conf</tt> for the root user and <tt>$HOME/.66/conf</tt> for a normal user. The default path can be changed at compile time by passing the <tt>--with-sys-service-conf=<em>DIR</em></tt> for the root user and <tt>--with-user-service-conf=<em>DIR</em></tt> for a normal user.</p>
</body>
</html>
diff --git a/doc/66-envfile.html b/doc/66-envfile.html
new file mode 100644
index 0000000000000000000000000000000000000000..cfb74a4780882e2110b6ad3cb8d575d2f9c5a90a
--- /dev/null
+++ b/doc/66-envfile.html
@@ -0,0 +1,58 @@
+<html>
+ <head>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>The 66 Suite: 66-envfile</title>
+ <meta name="Description" content="Detailed documentation for the 66-envfile command which is part of the 66 software suite" />
+ <meta name="Keywords" content="66 command 66-envfile service supervision execute script execline environment importas" />
+ <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">66</a><br />
+<a href="//obarun.org/">www.obarun.org</a>
+</p>
+
+<h1>66-envfile</h1>
+
+ <p>
+ This command is a mix of <a href="https://skarnet.org/software/s6/s6-envdir.html"><tt>s6-envdir</tt></a> and <a href="https://skarnet.org/software/execline/importas.html"><tt>importas</tt></a> <em>program</em>.
+ It reads file containing variable assignments on the given directory, adds the variables to the environment, then executes a program.
+ </p>
+
+
+<h2> Interface </h2>
+ <pre>
+ 66-envfile [ -h ] [ -f <em>file</em> ] [ -l ] <em>dir</em> <em>prog</em>
+ </pre>
+
+ <p>
+ This tool expects to find a regular file(s) in <em>dir</em> containing one or multiple <tt>key=value</tt> pair. For earch files found, it will parse the file, import the <tt>key=value</tt> then execs <em>prog</em> with the modified environment.
+ </p>
+
+<h2> Options </h2>
+
+ <ul>
+ <li> <tt>-h </tt> : prints this help. </li>
+ <li>
+ <tt>-f <em>file</em> </tt> : only parse <em>file</em> found in <em>dir</em>.
+ </li>
+ <li>
+ <tt>-l </tt> : loose. do nothing and executes <em>prog</em> directly if <em>dir</em> do not contain any regular file(s) or <em>dir</em> doesn't exist.
+ </li>
+
+ </ul>
+
+<h2> File syntax </h2>
+ <p><em>file</em> is a text file containing lines of the form <tt>key = value</tt>.Whitespace is permitted before and after <em>key</em>, and before or after <em>value</em>,
+ Quoting is also possible.
+ </p>
+ <p>Empty lines, or lines containing only whitespace, are ignored. Lines beginning with <tt>#</tt> (possibly after some whitespace) are ignored (and typically used for comments). Comments are not possible at the end of lines:
+ <tt>key = value # comment</tt> is not a valid comment.
+ </p>
+ <p>Empty <em>value</em> is <strong>not</strong> permitted.</p>
+ <p>If <tt>key</tt>begin by a <tt>'!'</tt> character: <tt>!key=value</tt> the <tt>key</tt> will be removed from the environment after the substitution.</p>
+</body>
+</html>
diff --git a/doc/66-info.html b/doc/66-info.html
index 9b817f16f594ba20af0ca66453545f11135b80ee..a7c52952be0ed07c4c1bfec89c99cec8f6bc9301 100644
--- a/doc/66-info.html
+++ b/doc/66-info.html
@@ -64,7 +64,7 @@
</li>
<li>
- <tt>-r </tt> : shows the dependency graph of <em>tree</em>.
+ <tt>-r </tt> : shows the dependency graph of <em>tree</em> in reverse mode.
</li>
<li>
@@ -95,7 +95,7 @@
<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> : shows the dependency graph of <em>service</em>.
+ <tt>-r </tt> : shows the dependency graph of <em>service</em> in reverse mode.
</li>
<li>
<tt>-d <em>depth</em> </tt> : limits the depth of the dependency graph visualisation; defaults to 1.
@@ -107,86 +107,134 @@
<p>The command <tt>66-info -T boot</tt> as root user on the <em>Obarun</em> default system displays the following where <em>boot</em>
is the tree used to properly boot the machine:
<pre>
- [Name:boot,Current:no,Enabled:no]
- ├─All :bundle
- ├─boot-extra :oneshot
- ├─all-Rwfs :bundle
- ├─rwfs-tmpfiles :oneshot
- ├─rwfs-66local :oneshot
- ├─rwfs-dmesglog :oneshot
- ├─rwfs-end :oneshot
- ├─rwfs-logfiles :oneshot
- ├─rwfs-random :oneshot
- ├─rwfs-localtime :oneshot
- ├─rwfs-nofilesystem :oneshot
- ├─rwfs-loopback :oneshot
- ├─rwfs-ip6tables :oneshot
- ├─rwfs-iptables :oneshot
- ├─rwfs-tmpdir :oneshot
- ├─rwfs-fsrw :oneshot
- ├─all-Rofs :bundle
- ├─rofs-kernruntime :oneshot
- ├─rofs-swap :oneshot
- ├─rofs-modules :oneshot
- ├─rofs-Checkfs :bundle
- ├─checkfs-fscheck :oneshot
- |─checkfs-lvm :oneshot
- ├─checkfs-btrfs :oneshot
- ├─checkfs-dmraid :oneshot
- ├─rofs-hardclock :oneshot
- ├─rofs-console :oneshot
- ├─rofs-Udevd :bundle
- ├─udevd-udevadm :oneshot
- ├─udevd-udev :longrun
- ├─rofs-kernmod :oneshot
- ├─rofs-cgroups :oneshot
- ├─00 :bundle
- ├─hostname :oneshot
- ├─conf :oneshot
- ├─filesystem :oneshot
- └─tty12 :classic
+ [Name:boot_backup-2019-02-28-40,Current:no,Enabled:no]
+ ├─(250,classic) tty12
+ ├─(0,oneshot) filesystem
+ ├─(0,oneshot) hostname
+ ├─(0,bundle) 00
+ ├─(0,oneshot) rofs-cgroups
+ ├─(0,oneshot) rofs-kernmod
+ ├─(419,longrun) udevd-udev
+ ├─(0,oneshot) udevd-udevadm
+ ├─(0,bundle) rofs-Udevd
+ ├─(0,oneshot) rofs-console
+ ├─(0,oneshot) rofs-hardclock
+ ├─(0,oneshot) checkfs-dmraid
+ ├─(0,oneshot) checkfs-btrfs
+ ├─(0,oneshot) checkfs-lvm
+ ├─(0,oneshot) checkfs-fscheck
+ ├─(0,bundle) rofs-Checkfs
+ ├─(0,oneshot) rofs-modules
+ ├─(0,oneshot) rofs-swap
+ ├─(0,oneshot) rofs-kernruntime
+ ├─(0,bundle) all-Rofs
+ ├─(0,oneshot) rwfs-fsrw
+ ├─(0,oneshot) rwfs-tmpdir
+ ├─(0,oneshot) rwfs-iptables
+ ├─(0,oneshot) rwfs-ip6tables
+ ├─(0,oneshot) rwfs-loopback
+ ├─(0,oneshot) rwfs-nofilesystem
+ ├─(0,oneshot) rwfs-localtime
+ ├─(0,oneshot) rwfs-random
+ ├─(0,oneshot) rwfs-logfiles
+ ├─(0,oneshot) rwfs-end
+ ├─(0,oneshot) rwfs-dmesglog
+ ├─(0,oneshot) rwfs-66local
+ ├─(0,oneshot) rwfs-tmpfiles
+ ├─(0,bundle) all-Rwfs
+ ├─(0,oneshot) boot-extra
+ └─(0,bundle) All
+
</pre>
</p>
+ <p>By default the first service displayed is the first service started, the second one is the second started and so on.</p>
<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.
+ For each service the first number found between '()' bracket is the corresponding pid of the service, the type of the service is shown next to it. Finally the name of the service is displayed.
</p>
<p>
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.
+ service and <em>'classic' tty12</em> is the first one executed. You can reverse the rendered order with the <tt>-r</tt> option.</p>
</p>
<h2>Service output display example</h2>
<p>The command <tt>sudo 66-info -S -d3 00</tt> displays the following where <em>00</em>
is the name of the service:
- <pre> [00]
- tree : boot
- status : nothing to display
- type : bundle
- description : mount filesystem, parse the 66.conf file, set the hostname
- contents :
- └─00 :bundle
- ├─filesystem :oneshot
- ├─conf :oneshot
- │ └─filesystem :oneshot
- └─hostname :oneshot
- └─conf :oneshot
+ <pre>
+ [00]
+ on tree : boot
+ status : nothing to display
+ type : bundle
+ description : mount filesystem and set the hostname
+ source : /etc/66/service/boot
+ run at : /run/66/tree/0/boot/servicedirs/00
+ [contents:2]
+ └─(0,bundle) 00
+ ├─(0,oneshot) filesystem
+ └─(0,oneshot) hostname
+
</pre>
</p>
<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
- type : classic
- description : ntpd daemon
- logger at : /var/log/66/ntpd
- 2018-12-14 17:56:11.876483500 peer 43.245.48.27 now valid
- 2018-12-14 17:56:11.876508500 reply from 43.245.48.27: offset -0.000546 delay 0.035899, next query 5s
- 2018-12-14 17:56:12.946922500 reply from 103.106.66.123: offset 0.018069 delay 0.069026, next query 8s
- 2018-12-14 17:56:12.947754500 reply from 103.239.8.22: offset 0.001671 delay 0.069848, next query 6s
+ <pre>
+ [ntpd]
+ on tree : root
+ status : up (pid 808) 6386 seconds
+ type : classic
+ description : ntpd daemon
+ source : /etc/66/service/
+ run at : /run/66/scandir/0/ntpd
+ start script : foreground { mkdir -p -m 0755 ${RUNDIR} }
+ execl-cmdline -s { ntpd ${CMD_ARGS} }
+ [dependencies:1]
+ └─(808,classic) ntpd
+ └─(807,classic) ntpd-log
+ logger associated : ntpd-log
+ log destination : /var/log/66/ntpd
+
+ 2019-03-01 07:28:15.592154500 adjtimex returns frequency of 0.000000ppm
+ 2019-03-01 07:28:15.601109500 ntp engine ready
+ 2019-03-01 07:28:15.770395500 adjtimex adjusted frequency by 16.428986ppm
+ 2019-03-01 07:28:15.770433500 set local clock to Fri Mar 1 07:28:15 +11 2019 (offset 0.000000s)
</pre>
+ <p> In our case :
+ <ul>
+ <li>
+ <tt>[ntpd] </tt> : name of the service.
+ </li>
+ <li>
+ <tt>on tree </tt> : service enable on tree root.
+ </li>
+ <li>
+ <tt>status </tt> : status of the service.
+ </li>
+ <li>
+ <tt>type </tt> : type of the service.
+ </li>
+ <li>
+ <tt>description </tt> : short description of the service.
+ </li>
+ <li>
+ <tt>source </tt> : origin of the frontend service file used to enable the service.
+ </li>
+ <li>
+ <tt>runat </tt> : location of the service into the scandir.
+ </li>
+ <li>
+ <tt>start script </tt> : command line executed at start process. If a stop section was set an additionnal field called stop script will be displayed with the corresponding command line executed at stop process.
+ </li>
+ <li>
+ <tt>[dependencies:number] </tt> : number of direct dependencies of the service followed by the dependencies graph.
+ </li>
+ <li>
+ <tt>logger associated </tt> : name of the service logger.
+ </li>
+ <li>
+ <tt>log destination </tt> : destination of the logger file.
+ </li>
+ </ul>
</p>
</body>
</html>
diff --git a/doc/66-init.html b/doc/66-init.html
index d843c8c4c07ab7623256dd83e66bb5cc559c1ec6..d1d67539f8977795f1243d9575a95998ea8b30a5 100644
--- a/doc/66-init.html
+++ b/doc/66-init.html
@@ -23,7 +23,7 @@
<h2> Interface </h2>
<pre>
- 66-init [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -c classic ] [ -d database ] [ -B both ] <em>tree</em>
+ 66-init [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t tree ] <em>classic|database|both</em>
</pre>
<p>
@@ -50,19 +50,22 @@
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>
+ </ul>
+<h2> Arguments </h2>
+ <ul>
<li>
- <tt>-c </tt> : only initiate all <em>classic</em> services from <em>tree</em>
- at <em>live</em>.
+ <tt>classic </tt> : only initiate all <em>classic</em> services from <em>tree</em>
+ at <em>live</em> location.
</li>
<li>
- <tt>-d </tt> : only initiate service databases from <em>tree</em>
- at <em>live</em>.
+ <tt>database </tt> : only initiate all <em>bundle</em> and <em>atomic</em> services from <em>tree</em>
+ at <em>live</em> location.
</li>
<!-- are these meant to be single or plural? -->
<li>
- <tt>-B </tt> : initiate all <em>classic</em> services and service databases from <em>tree</em>
+ <tt>both </tt> : initiate all <em>classic</em> services and all <em>bundle</em> and <em>atomic</em> services from <em>tree</em>
at <em>live</em> location.
</li>
<!-- Again are there multiple services initiated or only one at a time? I read and understand this as if it were usually multiple. -->
@@ -71,15 +74,14 @@
<h2>Initiatlization process</h2>
<h3>Classic services</h3>
<p>The tool will make an exact copy of all classic service files and directories of the <em>tree</em> inside a <em>scandir</em> directory at <em>live</em>.
- By default <em>/run/66/scandir/UID</em> is created if it does not exist yet, where <em>UID</em> is the uid of the current owner of the process. The <em>scandir</em> does <strong>not</strong> need to be
+ By default <tt>/run/66/scandir/UID</tt> is created if it does not exist yet, where <tt>UID</tt> is the uid of the current owner of the process. The <em>scandir</em> does <strong>not</strong> need to be
necessarily running. This is useful at boot time to initiate an early service before starting the <em>scandir</em>. Once the <em>scandir</em>
starts—see <tt><a href="66-scandir.html">66-scandir -u</a></tt> option, the already present services start automatically.</p>
- <p>If the <em>scandir</em> is running, you should invoke a <tt>66-scandir -s reload</tt> command to inform it about the changes.</p>
-<h3>Bundle, longrun, oneshot services</h3>
+ <p>If the <em>scandir</em> is running, you should invoke a <tt><a href="66-scandir.html">66-scandir -s reload</a></tt> command to inform it about the changes.</p>
+<h3>Bundle, atomic services</h3>
<p>The tool will automatically invoke <tt><a href="https://skarnet.org/software/s6-rc/s6-rc-init.html">s6-rc-init -l <em>live</em> -c <em>compiled</em> - p <em>prefix</em></a></tt>,
where, by default, <em>live</em> translates to <tt>/run/66/tree/UID/<em>tree</em></tt> and <em>compiled</em> to <tt>/var/lib/66/system/<em>tree</em>/servicedirs/db/<em>tree</em></tt> or
<tt>$HOME/.66/system/<em>tree</em>/servicedirs/db/<em>tree</em></tt> depending on the owner of the process and the <em>prefix</em> of the name of the <em>tree</em>. If it doesn't exist yet <em>live</em>
- is created in the process. For these services the <em>scandir</em> <strong>must</strong> be running. In contrary to <tt>s6-rc-init</tt>, this tool like any other 66 tool can be invoked with
- user permissions.</p>
+ is created in the process. For these services the <em>scandir</em> <strong>must</strong> be running. This tool like any other 66 tool can be invoked with user permissions.</p>
</body>
</html>
diff --git a/doc/66-scandir.html b/doc/66-scandir.html
index aa133e0616c4dde68d5352c26666c2946e4e000a..f9efeef54d609a5b8a2d1d0dfa85d60b4c9ffbee 100644
--- a/doc/66-scandir.html
+++ b/doc/66-scandir.html
@@ -199,8 +199,8 @@
time by passing the following options to <tt>./configure</tt>:
</p>
<ul>
- <li><tt>--with-system-logpath=<em>DIR</em> </tt>: for root permissions</li>
- <li><tt>--with-user-logpath=<em>DIR</em> </tt>: for user permissions.</li>
+ <li><tt>--with-system-log=<em>DIR</em> </tt>: for root permissions</li>
+ <li><tt>--with-user-log=<em>DIR</em> </tt>: for user permissions.</li>
</ul>
<p>
If a <tt><em>scandir</em></tt> already exists for the given user
diff --git a/doc/66-start.html b/doc/66-start.html
index 81cba6277181f532936704035a1bc3c7c93a61ed..712886281a1a461dafad6a34ccb5653d6f893691 100644
--- a/doc/66-start.html
+++ b/doc/66-start.html
@@ -23,12 +23,12 @@
<h2> Interface </h2>
<pre>
- 66-start [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -r reload ] <em>service(s)</em>
+ 66-start [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -r | R ] <em>service(s)</em>
</pre>
<p>
This tool expects to find an already enabled service inside the given <em>tree</em> and an already running <em>scandir</em>.
- If the state of the <em>service</em> is already up, <tt>66-start</tt> does nothing except when passing the <tt>-r</tt> option—see <a href="#reload"><tt>reload transition</tt></a>.
+ If the state of the <em>service</em> is already up, <tt>66-start</tt> does nothing except when passing the <tt>-r</tt> or <tt>-R</tt>option—see <a href="#reload"><tt>reload transition</tt></a>.
</p>
<p>Multiple <em>services</em> can be started by seperating their names with a space.</p>
@@ -63,12 +63,14 @@
</li>
<li>
- <tt>-r </tt> : reload the <em>service</em>—see <a href="#reload"><tt>reload transition</tt></a>.
+ <tt>-r </tt> : If the service is up, restart it, by sending it a signal to kill it and letting s6-supervise start it again. By default, the signal is a SIGTERM; this can be configured via the <tt>@down-signal</tt> field in the frontend service file.
</li>
-
+ <li>
+ <tt>-R </tt> : reload the <em>service</em> entirely—see <a href="#reload"><tt>reload transition</tt></a>.
+ </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.
+<p>In case of <tt><em>'bundle'</em></tt> or <tt><em>'atomic'</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 started first when starting FooA.
This will run recursively until all dependencies are started.</p>
@@ -101,11 +103,11 @@ This will run recursively until all dependencies are started.</p>
</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>
-<h2>Bundle, longrun, oneshot transitions</h2>
+<h2>Bundle, atomic transitions</h2>
<p>
<ul>
<li>
- <tt>66-start</tt> gathers the bundle, longrun and/or oneshot service(s) passed as argument in a list called <em>selection</em>. <!-- Is this the same list as for classic services or a dedicated one that shares the same name space? -->
+ <tt>66-start</tt> gathers the bundle and/or atomic service(s) passed as argument in a list called <em>selection</em>. <!-- Is this the same list as for classic services or a dedicated one that shares the same name space? -->
</li>
<li>
The command first inspects this list to determine if any service database in question of the given <em>tree</em> was already written to it. If it was not then a <tt>66-init -v <em>verbosity</em> -l <em>live</em> -d <em>tree</em></tt> is automatically invoked and <tt>66-start</tt> will wait for the exit code of this automatic command. After that a reload signal
@@ -136,11 +138,11 @@ This will run recursively until all dependencies are started.</p>
</ul>
</p>
<p>If this process fails then as a result <tt>66-start</tt> fails too and exits with code 111.</p>
-<h3>For bundle, longrun and oneshot services</h3>
+<h3>For bundle, atomic services</h3>
<p>
<ul>
<li>
- <tt>66-start</tt> gathers the bundle, longrun and/or oneshot service(s) passed as argument in a list called <em>selection</em>.
+ <tt>66-start</tt> gathers the bundle and/or atomic service(s) passed as argument in a list called <em>selection</em>.
</li>
<li>
The command first makes a backup of the services database <em>live</em> within the given <em>tree</em> and switches to the backup with
diff --git a/doc/66-stop.html b/doc/66-stop.html
index 6151a9d6a08f02413ab3087200bc679af40c1b0a..f32e780f37bcd97812c0eb395f0ab1355ca393b2 100644
--- a/doc/66-stop.html
+++ b/doc/66-stop.html
@@ -20,10 +20,10 @@
<p>
This command stops one ore more <em>services</em> defined in <em>tree</em>.
</p>
-
+[ -h ] [ -v verbosity ] [ -T timeout ] [ -l live ] [ -t tree ] [ -u ] [ -X ] [ -K ] service(s)"
<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</em>"
+ 66-stop [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -u ] [ -X ] [ -K ]<em>service</em>"
</pre>
<p>
@@ -66,7 +66,12 @@
<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 option only applies to services of type <tt><em>'classic'</em></tt>.
</li>
-
+ <li>
+ <tt>-X </tt> : exit. The supervisor of the service will exit too. This command should normally never be used on a working system.
+ </li>
+ <li>
+ <tt>-K </tt> : sends a SIGKILL to the <em>service</em> and keep it down.
+ </li>
</ul>
<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.
diff --git a/doc/66-svctl.html b/doc/66-svctl.html
index ec47c0b11befbd51d328e1cc276252a61c88a52c..b43bf5e4ad0f81edf14987a21b1647e121fa0eca 100644
--- a/doc/66-svctl.html
+++ b/doc/66-svctl.html
@@ -23,7 +23,7 @@
<h2> Interface </h2>
<pre>
- 66-svctl [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -S <em>service timeout</em> ] [ -n <em>death</em> ] [ -u|U up ] [ -d|D down ] <em>service(s)</em>
+ 66-svctl [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -n <em>death</em> ] [ -u| U | d | D | r | R | K | X ] <em>service(s)</em>
</pre>
<p>
@@ -62,14 +62,6 @@
defaults to 0 (blocks indefinitely).
</li>
- <li>
- <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 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 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.
@@ -86,11 +78,22 @@
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>.
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>
+ <li>
+ <tt>-r|R </tt> : sends a <em>reload</em> signal to the <em>service</em>. By default, the signal is a SIGTERM; this can be configured via the <tt>@down-signal</tt> field in the <tt><a href="66-frontend.html">frontend</a></tt> service file. Uppercase <tt>R</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>.
+ If this file doesn't exist <tt>66-svctl</tt> will automatically change to lowercase <tt>r</tt> and warn the user about the change.
+ </li>
+ <li>
+ <tt>-X </tt> : exit. The supervisor of the service will exit too. This command should normally never be used on a working system.
+ </li>
+ <li>
+ <tt>-K </tt> : sends a SIGKILL to the <em>service</em> and keep it down.
+ </li>
</ul>
<h2> Note </h2>
<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>
+<p>As an extra convenience the <tt>-n</tt> options allow you to deal directly on the command line with
+<em>max-death-tally</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/66-tree.html b/doc/66-tree.html
index 4abf64930a41d32329fd6588c58eba706dac0128..cc937efe8da4cbcfe0b20e5d929f4c1116f67208 100644
--- a/doc/66-tree.html
+++ b/doc/66-tree.html
@@ -20,10 +20,10 @@
<p>
This command handles a directory containing a set of services.
</p>
-
+
<h2> Interface </h2>
<pre>
- 66-tree [ -h help ] [ -v <em>verbosity</em> ] [ -n new ] [ -a allow <em>user,user,...</em> ] [ -d deny <em>user,user,...</em> ] [ -c current ] [ -E enable ] [ -D disable ] [ -R remove ] [ -C <em>clone</em> ] <em>tree</em>
+ 66-tree [ -h ] [ -v <em>verbosity</em> ] [ -n|R ] [ -a|d ] [ -c ] [ -E|D ] [ -C <em>clone</em> ] <em>tree</em>
</pre>
<p>
@@ -123,11 +123,11 @@
<h4>When enabling a service</h4>
<p>By enabling a service its corresponding frontend service file is parsed and the result
- written to a sub directory of the trees path called <tt>servicedirs/svc</tt> for <tt><em>'classic'</em></tt> services and <tt>servicedirs/db/source</tt> for <tt><em>'bundle'</em></tt>, <tt><em>'longrun'</em></tt> or <tt><em>'oneshot'</em></tt> services.</p>
+ written to a sub directory of the trees path called <tt>servicedirs/svc</tt> for <tt><em>'classic'</em></tt> services and <tt>servicedirs/db/source</tt> for <tt><em>'bundle'</em></tt> or <tt><em>'atomic'</em></tt> services.</p>
<p>As an example for root the resulting files would, by default, be found at <tt>/usr/lib/66/system/<em>tree</em>/servicedirs/svc</tt>
for services of type <tt><em>'classic'</em></tt> and at <tt>/usr/lib/66/system/<em>tree</em>/servicedirs/db/source</tt>
- for any service of type <tt><em>'bundle'</em></tt>, <tt><em>'longrun'</em></tt> or <tt><em>'oneshot'</em></tt>.</p>
+ for any service of type <tt><em>'bundle'</em></tt> or <tt><em>'atomic'</em></tt>.</p>
<h4>When enabling a whole tree</h4>
@@ -135,7 +135,7 @@
<tt><a href="66-all.html">66-all</a></tt> tool, the directory
<tt>/usr/lib/66/system/<em>tree</em>/servicedirs/svc</tt> is opened and the command will start any service found inside of that directory.</p>
- <p>For services of type <tt><em>bundle</em></tt>, <tt><em>longrun</em></tt> and <tt><em>oneshot</em></tt>, instead of opening the directory <tt>/usr/lib/66/system/<em>tree</em>/servicedirs/db/source</tt>,
+ <p>For services of type <tt><em>bundle</em></tt> and <tt><em>atomic</em></tt>, instead of opening the directory <tt>/usr/lib/66/system/<em>tree</em>/servicedirs/db/source</tt>,
the corresponding compiled database found at
<tt>/usr/lib/66/system/<em>tree</em>/servicedirs/db/<em>tree</em></tt> is used. The
database found at this location is the result of an automatic use of the command <tt><a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html">s6-rc-compile</a></tt> when enabling such a service.
diff --git a/doc/index.html b/doc/index.html
index 2acf4bff9bb35aa7f9e72f3cd4567ef62243635d..b89a38ecc4eaacbd758377170004f810b6123f7d 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -93,6 +93,7 @@
<ul>
<li><a href="execl-cmdline.html"><tt>execl-cmdline</tt></a></li>
+ <li><a href="66-envfile.html"><tt>66-envfile</tt></a></li>
</ul>
<h2> Why is 66 necessary? </h2>