From fd9d30bda545ae80d97bac3e180788d19d7fa765 Mon Sep 17 00:00:00 2001
From: obarun <eric@obarun.org>
Date: Tue, 2 Apr 2019 09:06:46 +1100
Subject: [PATCH] update doc
---
doc/66-all.html | 5 ++-
doc/66-enable.html | 2 +-
doc/66-envfile.html | 2 +-
doc/66-info.html | 107 ++++++++++++++++++++++----------------------
doc/66-stop.html | 4 +-
doc/66-tree.html | 3 +-
6 files changed, 63 insertions(+), 60 deletions(-)
diff --git a/doc/66-all.html b/doc/66-all.html
index 4eec743b..6fa0864d 100644
--- a/doc/66-all.html
+++ b/doc/66-all.html
@@ -27,7 +27,7 @@
</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>-o</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>-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>
@@ -73,6 +73,7 @@
</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 -o 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 <tt>-t</tt> option.</p>
</body>
</html>
diff --git a/doc/66-enable.html b/doc/66-enable.html
index 9eb6b9ca..1dc2e84c 100644
--- a/doc/66-enable.html
+++ b/doc/66-enable.html
@@ -23,7 +23,7 @@
<h2> Interface </h2>
<pre>
- 66-enable [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -f ] [ -S ] <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>
diff --git a/doc/66-envfile.html b/doc/66-envfile.html
index 1b268ae0..a99d19a4 100644
--- a/doc/66-envfile.html
+++ b/doc/66-envfile.html
@@ -47,7 +47,7 @@
<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.
+ Quoting is also possible. In this case, the quoting field is treated as one word.
</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 <strong>not</strong> possible at the end of lines:
<tt>key = value # comment</tt> is not a valid comment.
diff --git a/doc/66-info.html b/doc/66-info.html
index a206f764..e437f510 100644
--- a/doc/66-info.html
+++ b/doc/66-info.html
@@ -121,53 +121,54 @@
boot
Initialized: yes | Current: no
Contains: | Enabled: no
- ├─(253,classic) tty12
- ├─(0,oneshot) filesystem
- ├─(0,oneshot) hostname
- ├─(0,bundle) 00
- ├─(0,oneshot) rofs-cgroups
- ├─(0,oneshot) rofs-kernmod
- ├─(421,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
+ ├─(0,Enabled,oneshot) filesystem
+ ├─(0,Enabled,oneshot) hostname
+ ├─(0,Enabled,bundle) 00
+ ├─(0,Enabled,oneshot) rofs-cgroups
+ ├─(0,Enabled,oneshot) rofs-kernmod
+ ├─(421,Enabled,longrun) udevd-udev
+ ├─(0,Enabled,oneshot) udevd-udevadm
+ ├─(0,Enabled,bundle) rofs-Udevd
+ ├─(0,Enabled,oneshot) rofs-console
+ ├─(0,Enabled,oneshot) rofs-hardclock
+ ├─(0,Enabled,oneshot) checkfs-dmraid
+ ├─(0,Enabled,oneshot) checkfs-btrfs
+ ├─(0,Enabled,oneshot) checkfs-lvm
+ ├─(0,Enabled,oneshot) checkfs-fscheck
+ ├─(0,Enabled,bundle) rofs-Checkfs
+ ├─(0,Enabled,oneshot) rofs-modules
+ ├─(0,Enabled,oneshot) rofs-swap
+ ├─(0,Enabled,oneshot) rofs-kernruntime
+ ├─(0,Enabled,bundle) all-Rofs
+ ├─(0,Enabled,oneshot) rwfs-fsrw
+ ├─(0,Enabled,oneshot) rwfs-tmpdir
+ ├─(0,Enabled,oneshot) rwfs-iptables
+ ├─(0,Enabled,oneshot) rwfs-ip6tables
+ ├─(0,Enabled,oneshot) rwfs-loopback
+ ├─(0,Enabled,oneshot) rwfs-nofilesystem
+ ├─(0,Enabled,oneshot) rwfs-localtime
+ ├─(0,Enabled,oneshot) rwfs-random
+ ├─(0,Enabled,oneshot) rwfs-logfiles
+ ├─(0,Enabled,oneshot) rwfs-end
+ ├─(0,Enabled,oneshot) rwfs-dmesglog
+ ├─(0,Enabled,oneshot) rwfs-66local
+ ├─(0,Enabled,oneshot) rwfs-tmpfiles
+ ├─(0,Enabled,bundle) all-Rwfs
+ ├─(0,Enabled,oneshot) boot-extra
+ ├─(0,Enabled,bundle) All
+ └─(254,Enabled,classic) tty12
+
</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 give you the name of the <em>tree</em>, <tt><em>Initialized</em></tt> tells if the <tree>tree</tree> was initialized with <tt><a href="66-init.html">66-init</a></tt> tool,
<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>.
- 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.
+ For each service the first number found between '()' bracket is the corresponding pid of the service, the second one is the state 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. You can reverse the rendered order with the <tt>-r</tt> option.</p>
+ By default the dependency graph is rendered in order of execution. In this example the <em>'classic' tty12</em> is the last finished
+ service and <em>'oneshot' filesystem</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>
@@ -175,41 +176,41 @@
<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
+ <u> 00 </u>
on tree : boot
- status : nothing to display
+ status : Enabled, 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
- ├─(0,oneshot) filesystem
- └─(0,oneshot) hostname
+ <u> contents </u>
+ ├─(0,Enabled,oneshot) filesystem
+ └─(0,Enabled,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
+ <pre>
+ <u> ntpd </u>
on tree : root
- status : up (pid 786) 2380 seconds
+ status : Disabled, up (pid 786) 2380 seconds
type : classic
description : ntpd daemon
source : /etc/66/service/
run at : /run/66/scandir/0/ntpd
- dependencies
- └─(785,classic) ntpd-log
- scripts
+ <u> dependencies </u>
+ └─(785,Disabled,classic) ntpd-log
+ <u> scripts </u>
start script : foreground { mkdir -p -m 0755 ${RUNDIR} }
execl-cmdline -s { ntpd ${CMD_ARGS} }
- environment
+ <u> environment </u>
!RUNDIR=/run/openntpd
!CMD_ARGS=-d -s
- logger
+ <u> logger </u>
logger associated : ntpd-log
log destination : /var/log/66/ntpd
-
+ <u> log file </u>
2019-03-18 06:50:21.749572500 adjtimex returns frequency of 0.000000ppm
2019-03-18 06:50:21.764241500 ntp engine ready
2019-03-18 06:50:21.847440500 adjtimex adjusted frequency by 16.428986ppm
diff --git a/doc/66-stop.html b/doc/66-stop.html
index f32e780f..87c498fe 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 ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -u ] [ -X ] [ -K ]<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(s)</em>
</pre>
<p>
diff --git a/doc/66-tree.html b/doc/66-tree.html
index 2f1ae5d0..7909c03d 100644
--- a/doc/66-tree.html
+++ b/doc/66-tree.html
@@ -82,7 +82,8 @@
<li>
<tt>-R </tt> : deletes <em>tree</em>. Can not be undone! This will completely remove the given tree
from the system! You will not be able
- to retrieve any information of the deleted <em>tree</em> after deleting it. Services currently running on <em>tree</em> will be bringed down before remove it.
+ to retrieve any information of the deleted <em>tree</em> after deleting it. Services currently running on <em>tree</em> will be <strong>not</strong> bringed down before remove it. To do so, use the <tt>-U</tt> option
+ in conjonction e.g. <tt><em>66-tree -UR <em>tree</em></em></tt>.
</li>
<li>
<tt>-U </tt> : unsupervise <em>tree</em>. Bring down all services contained into the <em>tree</em> and remove the corresponding directory of the service from the scandir.
--
GitLab