From 34363647ad524e0cacb1615c0efbdca5855e3588 Mon Sep 17 00:00:00 2001 From: obarun <eric@obarun.org> Date: Tue, 31 Mar 2020 14:46:12 +1100 Subject: [PATCH] update doc --- doc/html/66-all.html | 4 +- doc/html/66-dbctl.html | 4 +- doc/html/66-disable.html | 4 +- doc/html/66-enable.html | 4 +- doc/html/66-env.html | 7 ++- doc/html/66-init.html | 3 +- doc/html/66-inservice.html | 10 ++-- doc/html/66-intree.html | 10 ++-- doc/html/66-parser.html | 7 ++- doc/html/66-scanctl.html | 8 ++-- doc/html/66-scandir.html | 8 ++-- doc/html/66-start.html | 4 +- doc/html/66-stop.html | 4 +- doc/html/66-svctl.html | 8 ++-- doc/html/66-tree.html | 4 +- doc/html/66-update.html | 11 ++--- doc/html/frontend.html | 95 +++++++++++++++++++++++++++++++------- doc/man/66-all.1.scd | 5 +- doc/man/66-boot.8.scd | 14 +++--- doc/man/66-dbctl.1.scd | 5 +- doc/man/66-disable.1.scd | 5 +- doc/man/66-enable.1.scd | 13 ++++-- doc/man/66-env.1.scd | 7 ++- doc/man/66-hpr.8.scd | 2 +- doc/man/66-init.1.scd | 5 +- doc/man/66-inservice.1.scd | 10 ++-- doc/man/66-intree.1.scd | 8 ++-- doc/man/66-parser.1.scd | 7 ++- doc/man/66-scanctl.1.scd | 5 +- doc/man/66-scandir.1.scd | 7 ++- doc/man/66-shutdown.8.scd | 6 +-- doc/man/66-shutdownd.8.scd | 4 +- doc/man/66-start.1.scd | 5 +- doc/man/66-stop.1.scd | 5 +- doc/man/66-svctl.1.scd | 5 +- doc/man/66-tree.1.scd | 5 +- doc/man/66-update.1.scd | 8 ++-- 37 files changed, 205 insertions(+), 121 deletions(-) diff --git a/doc/html/66-all.html b/doc/html/66-all.html index 0fa2fff2..d136b275 100644 --- a/doc/html/66-all.html +++ b/doc/html/66-all.html @@ -23,7 +23,7 @@ <h2> Interface </h2> <pre> - 66-all [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -T <em>timeout</em> ] [ -f ] [ -t <em>tree</em> ] <em>up/down</em> + 66-all [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -T <em>timeout</em> ] [ -f ] [ -t <em>tree</em> ] <em>up/down</em> </pre> <p> @@ -37,7 +37,7 @@ <ul> <li> <tt>-h </tt> : prints this help. </li> - + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-dbctl.html b/doc/html/66-dbctl.html index 52e1c4a8..13020d29 100644 --- a/doc/html/66-dbctl.html +++ b/doc/html/66-dbctl.html @@ -23,7 +23,7 @@ <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 | d | r ] <em>service(s)</em> + 66-dbctl [ -h ] [ -z ] [ -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> @@ -37,7 +37,7 @@ <ul> <li> <tt>-h </tt> : prints this help. </li> - + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-disable.html b/doc/html/66-disable.html index 6911fc7e..026c45f6 100644 --- a/doc/html/66-disable.html +++ b/doc/html/66-disable.html @@ -23,7 +23,7 @@ <h2> Interface </h2> <pre> - 66-disable [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -S ] <em>service(s)</em> + 66-disable [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -S ] <em>service(s)</em> </pre> <p> @@ -36,7 +36,7 @@ <ul> <li> <tt>-h </tt> : prints this help. </li> - + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-enable.html b/doc/html/66-enable.html index 798394b8..c61f5036 100644 --- a/doc/html/66-enable.html +++ b/doc/html/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|F ] [ -c|C ] [ -S ] <em>service(s)</em> + 66-enable [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -f|F ] [ -c|C ] [ -S ] <em>service(s)</em> </pre> <p> @@ -39,7 +39,7 @@ <ul> <li> <tt>-h </tt> : prints this help. </li> - + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-env.html b/doc/html/66-env.html index 6333b68b..7b39148c 100644 --- a/doc/html/66-env.html +++ b/doc/html/66-env.html @@ -25,7 +25,7 @@ <h2>Interface</h2> <pre> - 66-env [ -h ] [ -v <em>verbosity</em> ] [ -t <em>tree</em> ] [ -d <em>dir</em> ] [ -L ] [ -e ] [ -r <em>key=value</em> ] <em>service</em> + 66-env [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -t <em>tree</em> ] [ -d <em>dir</em> ] [ -L ] [ -e ] [ -r <em>key=value</em> ] <em>service</em> </pre> <ul> @@ -56,9 +56,8 @@ <h2>Options</h2> <ul> - <li> - <tt><b>-h</b></tt> : print this help. - </li> + <li> <tt>-h </tt> : print this help.</li> + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-init.html b/doc/html/66-init.html index 14935763..3ab7cb03 100644 --- a/doc/html/66-init.html +++ b/doc/html/66-init.html @@ -23,7 +23,7 @@ <h2> Interface </h2> <pre> - 66-init [ -h help ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t tree ] <em>classic|database|both</em> + 66-init [ -h help ] [ -z ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t tree ] <em>classic|database|both</em> </pre> <p> @@ -36,6 +36,7 @@ <ul> <li> <tt>-h </tt> : prints this help. </li> + <li> <tt>-z </tt> : use color. </li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases diff --git a/doc/html/66-inservice.html b/doc/html/66-inservice.html index ae47e715..7802909d 100644 --- a/doc/html/66-inservice.html +++ b/doc/html/66-inservice.html @@ -23,7 +23,7 @@ <h2>Interface </h2> <pre> - 66-inservice [ -h ] [ -v verbosity ] [ -c ] [ -n ] [ -o name,intree,status,... ] [ -g ] [ -d depth ] [ -r ] [ -t tree ] [ -p nline ] <em>service</em> + 66-inservice [ -h ] [ -z ] [ -v verbosity ] [ -n ] [ -o name,intree,status,... ] [ -g ] [ -d depth ] [ -r ] [ -t tree ] [ -p nline ] <em>service</em> </pre> <h2>Options </h2> @@ -32,7 +32,10 @@ <li> <tt>-h </tt> : prints this help. </li> - <li> + <li> + <tt>-z </tt> : use color. + </li> + <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. <tt>1(Default)</tt>: Only print error messages. @@ -40,9 +43,6 @@ <tt>3</tt>: Also prints tracing messages. <tt>4</tt>: Also prints debugging messages. </li> - <li> - <tt>-c </tt> : enable colorization. - </li> <li> <tt>-n </tt> : do not display the field name(s) specified. </li> diff --git a/doc/html/66-intree.html b/doc/html/66-intree.html index ec272c08..21c02c33 100644 --- a/doc/html/66-intree.html +++ b/doc/html/66-intree.html @@ -24,15 +24,14 @@ <h2>Interface </h2> <pre> - 66-intree [ -h ] [ -v verbosity ] [ -l live ] [ -c ] [ -n ] [ -o name,init,enabled,... ] [ -g ] [ -d depth ] [ -r ] <em>tree</em> + 66-intree [ -h ] [ -z ] [ -v verbosity ] [ -l live ] [ -n ] [ -o name,init,enabled,... ] [ -g ] [ -d depth ] [ -r ] <em>tree</em> </pre> <h2>Options </h2> <ul> - <li> - <tt>-h </tt> : prints this help. - </li> + <li> <tt>-h </tt> : prints this help.</li> + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. @@ -47,9 +46,6 @@ 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>-c </tt> : enable colorization. - </li> <li> <tt>-n </tt> : do not display the field name(s) specified. </li> diff --git a/doc/html/66-parser.html b/doc/html/66-parser.html index 2d26b4d6..98d4e046 100644 --- a/doc/html/66-parser.html +++ b/doc/html/66-parser.html @@ -24,7 +24,7 @@ <h2>Interface</h2> <pre> - 66-parser [ -h ] [ -v <em>verbosity</em> ] [ -f ] [ -c|C ] service destination</em> + 66-parser [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -f ] [ -c|C ] service destination</em> </pre> <ul> @@ -45,9 +45,8 @@ <h2>Options</h2> <ul> - <li> - <tt><b>-h</b></tt> : print this help. - </li> + <li> <tt>-h </tt> : print this help.</li> + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-scanctl.html b/doc/html/66-scanctl.html index 83688f69..ee5a7ac1 100644 --- a/doc/html/66-scanctl.html +++ b/doc/html/66-scanctl.html @@ -24,7 +24,7 @@ <h2>Interface</h2> <pre> - 66-scanctl [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -o <em>owner</em> ] signal + 66-scanctl [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -o <em>owner</em> ] signal </pre> <p> @@ -34,10 +34,8 @@ <h2>Options</h2> <ul> - <li> - <tt><b>-h</b></tt> : print this help. - </li> - + <li> <tt>-h </tt> : print this help.</li> + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-scandir.html b/doc/html/66-scandir.html index c2bf1e6c..c091fb3a 100644 --- a/doc/html/66-scandir.html +++ b/doc/html/66-scandir.html @@ -23,7 +23,7 @@ <h2> Interface </h2> <pre> - 66-scandir [ -h help ] [ -v <em>verbosity</em> ] [ -b ] [ -l <em>live</em> ] [ -d notif ][ -t <em>rescan</em> ] [ -L <em>log_user</em> ] [ -s <em>skel</em> ] [ -e <em>environment</em> ] [ -c | r | u ] owner + 66-scandir [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -b ] [ -l <em>live</em> ] [ -d notif ][ -t <em>rescan</em> ] [ -L <em>log_user</em> ] [ -s <em>skel</em> ] [ -e <em>environment</em> ] [ -c | r | u ] owner </pre> <p> @@ -33,10 +33,8 @@ <h2>Options</h2> <ul> - <li> - <tt><b>-h</b></tt> : print this help. - </li> - + <li> <tt>-h </tt> : print this help.</li> + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-start.html b/doc/html/66-start.html index b9e44487..f4ea5a7d 100644 --- a/doc/html/66-start.html +++ b/doc/html/66-start.html @@ -23,7 +23,7 @@ <h2> Interface </h2> <pre> - 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> + 66-start [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -r | R ] <em>service(s)</em> </pre> <p> @@ -36,7 +36,7 @@ <ul> <li> <tt>-h </tt> : prints this help. </li> - + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-stop.html b/doc/html/66-stop.html index f3dc9b3e..7da277c8 100644 --- a/doc/html/66-stop.html +++ b/doc/html/66-stop.html @@ -23,7 +23,7 @@ <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(s)</em> + 66-stop [ -h ] [ -z ] [ -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> @@ -36,7 +36,7 @@ <ul> <li> <tt>-h </tt> : prints this help. </li> - + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-svctl.html b/doc/html/66-svctl.html index c40bdb83..4b968c41 100644 --- a/doc/html/66-svctl.html +++ b/doc/html/66-svctl.html @@ -24,7 +24,7 @@ <h2>Interface</h2> <pre> - 66-svctl [ -h ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -n <em>death</em> ] [ -u | d | r | K | X ] <em>service(s)</em> + 66-svctl [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -t <em>tree</em> ] [ -T <em>timeout</em> ] [ -n <em>death</em> ] [ -u | d | r | K | X ] <em>service(s)</em> </pre> <p> @@ -56,10 +56,8 @@ <h2>Options</h2> <ul> - <li> - <tt><b>-h</b></tt> : print this help. - </li> - + <li> <tt>-h </tt> : print this help.</li> + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-tree.html b/doc/html/66-tree.html index 7b0e3514..ac953ec2 100644 --- a/doc/html/66-tree.html +++ b/doc/html/66-tree.html @@ -23,7 +23,7 @@ <h2> Interface </h2> <pre> - 66-tree [ -h ] [ -v <em>verbosity</em> ] [ -l ] [ -n|R ] [ -a|d ] [ -c ] [ -S <em>after_tree</em> ] [ -E|D ] [ -U ] [ -C <em>clone</em> ] <em>tree</em> + 66-tree [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -l ] [ -n|R ] [ -a|d ] [ -c ] [ -S <em>after_tree</em> ] [ -E|D ] [ -U ] [ -C <em>clone</em> ] <em>tree</em> </pre> <p> @@ -38,7 +38,7 @@ <ul> <li> <tt>-h </tt> : prints this help. </li> - + <li> <tt>-z </tt> : use color.</li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. diff --git a/doc/html/66-update.html b/doc/html/66-update.html index 8c02e671..b5574e0e 100644 --- a/doc/html/66-update.html +++ b/doc/html/66-update.html @@ -32,7 +32,7 @@ <h2>Interface</h2> <pre> - 66-udpate [ -h ] [ -v <em>verbosity</em> ] [ -c ] [ -l <em>live</em> ] [ -d ] <em>tree</em> + 66-udpate [ -h ] [ -z ] [ -v <em>verbosity</em> ] [ -l <em>live</em> ] [ -d ] <em>tree</em> </pre> <p> If no tree is given, all trees of the owner (root or user) of the process will be processed. @@ -42,10 +42,8 @@ <h2>Options</h2> <ul> - <li> - <tt><b>-h</b></tt> : print this help. - </li> - + <li> <tt>-h </tt> : print this help.</li> + <li> <tt>-z </tt> : use color. </li> <li> <tt>-v <em>verbosity</em> </tt>: increases/decreases the verbosity of the command. @@ -66,9 +64,6 @@ </li> <li> - <tt>-c </tt> : enable colorization. - </li> - <li> <tt>-d </tt> : dry run. Performs operation without modify the current state of the system. All command's output will be prefixed by "dry run do: " sentence. It's a good idea to diff --git a/doc/html/frontend.html b/doc/html/frontend.html index 3c73fe37..c9ddf9f9 100644 --- a/doc/html/frontend.html +++ b/doc/html/frontend.html @@ -16,7 +16,7 @@ <h1>The frontend service file</h1> <p> - The <a href="https://skarnet.org/software/s6">s6</a> and <a href="https://skarnet.org/software/s6">s6-rc</a> programs each handle and use several kinds of services and different files. It is quite complex to understand and manage the relationship between all those files and services. If you're interested in the details you should read <a href="https://skarnet.org/software/s6/servicedir.html">the documentation for the s6 servicedir</a> and also about <a href="https://skarnet.org/software/s6/servicedir.html"><em>classic</em></a>, <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html"> <em>oneshot</em>, <em>longrun</em> (also called <em>atomic</em> services), <em>bundle</em></a> and <em>module</em> services on Obarun. The frontend service file of 66 tools allows you to deal with all these different services in a centralized manner in one single place. + The <a href="https://skarnet.org/software/s6">s6</a> and <a href="https://skarnet.org/software/s6">s6-rc</a> programs each handle and use several kinds of services and different files. It is quite complex to understand and manage the relationship between all those files and services. If you're interested in the details you should read <a href="https://skarnet.org/software/s6/servicedir.html">the documentation for the s6 servicedir</a> and also about <a href="https://skarnet.org/software/s6/servicedir.html"><em>classic</em></a>, <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html"> <em>oneshot</em>, <em>longrun</em> (also called <em>atomic</em> services), <em>bundle</em></a> and <a href="#module"><em>module</em></a> services on Obarun. The frontend service file of 66 tools allows you to deal with all these different services in a centralized manner in one single place. <br> By default 66 tools expects to find any service files in <tt>%%service_system%%</tt> although this can be changed at compile time by passing the <tt>--with-service-path=<em>DIR</em></tt> option to <tt>./configure.</tt> </p> @@ -253,8 +253,8 @@ MYKEY=MYVALUE</pre> <p><em><tt><strong>Note:</strong></tt></em> If you don't care about dependencies between services or if you don't need specific tasks to get done before running the daemon, "classic" is the best pick.</p><br> - <br><hr style="border: 1px dashed #000000"> - + <br><hr style="border: 1px dashed #000000"> + <li><h4>@name</h4></li> <h5>Corresponds to the <em>name of the service directory</em> of s6 and s6-rc programs.</h5> <p>Name of the service.</p> @@ -275,6 +275,18 @@ MYKEY=MYVALUE</pre> </li> </ul> + <br><hr style="border: 1px dashed #000000"> + + <li><h4>@version</h4></li> + <h5>Without equivalent, this key is unique to 66 tools.</h5> + <p>Version number of the service.</p> + <p><tt>mandatory</tt> : yes (!)</p> + <p><tt>syntax</tt> : inline</p> + <p><tt>valid values</tt> :</p> + <ul> + <li>Any valid number</li> + </ul> + <br><hr style="border: 1px dashed #000000"> <li><h4>@description</h4></li> @@ -316,7 +328,7 @@ MYKEY=MYVALUE</pre> <p><tt>valid values</tt> :</p> <ul> <li>The <em>name</em> of any valid service with type - <tt>bundle</tt>, <tt>longrun</tt> or <tt>oneshot</tt>. Services of type <tt>classic</tt> + <tt>bundle</tt>, <tt>longrun</tt>, <tt>oneshot</tt> or <tt>module</tt>. Services of type <tt>classic</tt> are not allowed. <br>The <em>order is of importance</em> (!). If fooA depends on fooB and fooB depends on fooC the order needs to be: @@ -335,6 +347,11 @@ MYKEY=MYVALUE</pre> </li> </ul> + <p>A service can be commented out by placing the number sign '#' at the + begin of the name like this:</p> + <pre>@depends = ( fooA #fooB fooC)</pre> + + <br><hr style="border: 1px dashed #000000"> <li><h4>@optsdepends</h4></li> <h5>Without equivalent, this key is unique to 66 tools.</h5> @@ -345,7 +362,7 @@ MYKEY=MYVALUE</pre> <p><tt>valid values</tt> :</p> <ul> <li>The <em>name</em> of any valid service with type - <tt>bundle</tt>, <tt>longrun</tt> or <tt>oneshot</tt>. Services of type <tt>classic</tt> + <tt>bundle</tt>, <tt>longrun</tt>, <tt>oneshot</tt> or <tt>module</tt>. Services of type <tt>classic</tt> are not allowed. A service declared as optional dependencies is not mandatory. The parser will look at all trees if the corresponding service is @@ -373,6 +390,11 @@ MYKEY=MYVALUE</pre> treeB then treeA. <tt><a href="66-intree.html">66-intree</a></tt> can give you the start order with the field <tt>Start after</tt>. </p> + <p>A service can be commented out by placing the number sign '#' at the + begin of the name like this:</p> + <pre>@optsdepends = ( fooA #fooB fooC)</pre> + +<br><hr style="border: 1px dashed #000000"> <li><h4>@extdepends</h4></li> <h5>Without equivalent, this key is unique to 66 tools.</h5> @@ -383,7 +405,7 @@ MYKEY=MYVALUE</pre> <p><tt>valid values</tt> :</p> <ul> <li>The <em>name</em> of any valid service with type - <tt>bundle</tt>, <tt>longrun</tt> or <tt>oneshot</tt>. Services of type <tt>classic</tt> + <tt>bundle</tt>, <tt>longrun</tt>, <tt>oneshot</tt> or <tt>module</tt>. Services of type <tt>classic</tt> are not allowed. A service declared as an external dependencies is mandatory. The parser will search through all trees whether the corresponding service is @@ -411,22 +433,28 @@ MYKEY=MYVALUE</pre> declared on treeB, it's the responsibility of the sysadmin to start first treeB then treeA. <tt><a href="66-intree.html">66-intree</a></tt> will give you the start order with the field <tt>Start after</tt>.</p> - + + <p>A service can be commented out by placing the number sign '#' at the + begin of the name like this:</p> + <pre>@extdepends = ( fooA #fooB fooC)</pre> + <br><hr style="border: 1px dashed #000000"> <li><h4>@contents</h4></li> <h5>Corresponds to the file "<em>contents</em>" of s6-rc programs.</h5> <p>Declare the contents of a bundle service.</p> <p><tt>mandatory</tt> : yes (!)—for services of type <tt>bundle</tt>. - <em>Optional</em> for services of type <tt>oneshot</tt> or <tt>longrun</tt>. - No effect at all for services of type <tt>classic</tt>.</p> + Not allowed for all other services type.</p> <p><tt>syntax</tt> : bracket</p> <p><tt>valid values</tt> :</p> <ul> - <li>The name of any valid service of type <tt>bundle</tt>, <tt>longrun</tt> or <tt>oneshot</tt>. Services of type <tt>classic</tt> + <li>The name of any valid service of type <tt>bundle</tt>, <tt>longrun</tt>, <tt>oneshot</tt> or <tt>module</tt>. Services of type <tt>classic</tt> are not allowed. </li> - </ul> + </ul> + <p>A service can be commented out by placing the number sign '#' at the + begin of the name like this:</p> + <pre>@contents = ( fooA #fooB fooC)</pre> <br><hr style="border: 1px dashed #000000"> @@ -753,8 +781,8 @@ same behaviour. --> <li>Any valid path on the system.</li> <p>The directory where to save the log file. This directory is automatically created. The current user of the process needs to have sufficient permissions on the destination directory - to be able to create it. The default directory is <tt>/var/log/66/servicename</tt> for <tt>root</tt> and - <tt>$HOME/.66/log/servicename</tt> for any regular user. The default can also be changed at compile-time by + to be able to create it. The default directory is <tt>%%system_log%%/servicename</tt> for <tt>root</tt> and + <tt>$HOME/%%user_log%%/servicename</tt> for any regular user. The default can also be changed at compile-time by passing the <tt>--with-system-logpath=<em>DIR</em></tt> option for root and <tt>--with-user-logpath=<em>DIR</em></tt> for a user to <tt>./configure.</tt></p> </ul> @@ -1030,31 +1058,64 @@ for it in your <tt>@execute</tt> field.</p> </p> <br><hr> -<h2 id="module">Module service file creation</h2> +<h2 id="module">Module service creation</h2> <p>A module can be considered as an <tt><a href="#instance">instantiated</a></tt> service. It works as the same way concerning the frontend file but - allow to configure a set of differents kind of services before executing + allows to configure a set of differents kind of services before executing the enable process. Also, the set of the services can be configured with the conjonction of a script called <tt>configure</tt> which it can be made on any language.</p> <p>A module is define with two elements: an instantiated frontend service file at %%service_system%% and a directory at %%service_module%%. - The name of the frontend and the directory <b>must</b> be the same. + The name of the frontend and the name of the directory <b>must</b> be the same. For example if the frontend is named foo@, the directory of the module must be foo@.</p> <p>The module directory can contain a sub-directory named <tt>.configure</tt> with an <b>executable</b> file script named <tt>configure</tt> inside. For example, foo@/.configure/configure. The sub-directory <b>must</b> be named - <tt>.configure</tt> and the file scripts <b>must</b> be named <tt>configure</tt>.</p> + <tt>.configure</tt> and the file script <b>must</b> be named <tt>configure</tt>.</p> <p>It's up to you to write the <tt>configure</tt> script file with the language of your choice as long as you define a correct <tt>shebang</tt>.</p> <p>The <tt>configure</tt> script is launched after the parse of the frontend file meaning all regex on directories and files is already made.</p> + + <h3>A word about the <a href="#main">[main]</a> section with the module type</h3> + <p>The valid field in section <a href="#main">[main]</a> are:</p> + <ul> + <li> + @type + </li> + <li> + @description + </li> + <li> + @name + </li> + <li> + @version + </li> + <li> + @user + </li> + <li> + @depends + </li> + <li> + @optsdepends + </li> + <li> + @extdepends + </li> + <li> + @hiercopy + </li> + </ul> + <p>All other fields from <a href="#main">[main]</a> section are not allowed.</p> <br><hr> <h2 id="proto">Prototype of a frontend file</h2> diff --git a/doc/man/66-all.1.scd b/doc/man/66-all.1.scd index 7d87c7df..4ed15f14 100644 --- a/doc/man/66-all.1.scd +++ b/doc/man/66-all.1.scd @@ -6,7 +6,7 @@ # SYNOPSIS -66-all [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-T* _timeout_ ] [ *-f* ] [ *-t* _tree_ ] *up* | *down* +66-all [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-T* _timeout_ ] [ *-f* ] [ *-t* _tree_ ] *up* | *down* # DESCRIPTION @@ -19,6 +19,9 @@ It is a safe wrapper around *66-start(1)* and *66-stop*(1). *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ - *1* : (Default) Only print error messages.++ diff --git a/doc/man/66-boot.8.scd b/doc/man/66-boot.8.scd index 1ca09660..44da4891 100644 --- a/doc/man/66-boot.8.scd +++ b/doc/man/66-boot.8.scd @@ -17,9 +17,9 @@ Prints this help. *-s* _skel_ - Path of the skeleton files. By default this will be *%%sysconfdir%%*. + Path of the skeleton files. By default this will be *%%skel%%*. The default can also be changed at compile time by passing the - *--sysconfdir=*_DIR_ option to *./configure*. This directory *must* + *--with-skeleton=*_DIR_ option to *./configure*. This directory *must* contains the necessaries skeleton files to properly boot the machine, without it the system *will not boot*. _skel_ must be an absolute path. *-m* @@ -105,7 +105,7 @@ not arrive. Skeleton files are mandatories and must exist on your system to be able to boot and shutdown the machine properly. By default those files are installed at -*%%sysconfdir%%*. Use the *--sysconfdir=*_DIR_ option at compile time to change +*%%skel%%*. Use the *--with-skeleton=*_DIR_ option at compile time to change it. - *init*++ @@ -142,19 +142,19 @@ name of the _tree_ to start. This _tree_ should contain a set of _stage2_ will start all other kind of service defined into it. It's the responsability of the administrator to correctly set this tree. - - *RCINIT=*_/etc/66/rc.init_++ + - *RCINIT=*%%skel%%/rc.init_++ This file is launched at the end of the _stage1_ and run as _stage2_. It call *66-init*(1) to iniatiate all service of _TREE_ except 'classic' which are already initiated on the _stage1_ than invoke *66-dbctl*(1) to bring up the services. An absolute path is expected as value pointing to the name of the file to run. - - *RCSHUTDOWN=*/etc/66/rc.shutdown_++ + - *RCSHUTDOWN=*%%skel%%/rc.shutdown_++ This is launched when a shutdown is requested also called _stage3_. It invoke *66-all*(1) to bring down all services of _TREE_. An absolute path is expected as value pointing to the name of the file to run. - - *RCSHUTDOWNFINAL=*/etc/66/rc.shutdown_++ + - *RCSHUTDOWNFINAL=*%%skel%%/rc.shutdown_++ This file will be run at the very end of the shutdown procedure, after all processes have been killed and all filesystems have been unmounted, just before the system is rebooted or the power turned off. @@ -168,7 +168,7 @@ Ask at *s6-svscan* to perform a scan every _RESCAN_ milliseconds. It should be 0 at _stage1_ but its here just in case. It is strongly discouraged to set _RESCAN_ to a positive value under 500. - - *ISHELL=*_/etc/66/ishell_++ + - *ISHELL=*%%skel%%/ishell_++ Run _ISHELL_ in case of _stage2_ crash. This file try to run a *sulogin*. An absolute path is expected as value pointing to the name of the file to run. diff --git a/doc/man/66-dbctl.1.scd b/doc/man/66-dbctl.1.scd index e3140214..f8fe1ff7 100644 --- a/doc/man/66-dbctl.1.scd +++ b/doc/man/66-dbctl.1.scd @@ -6,7 +6,7 @@ # SYNOPSIS -66-dbctl [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-u* | *d* | *r* ] _service(s)_ +66-dbctl [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-u* | *d* | *r* ] _service(s)_ # DESCRIPTION @@ -26,6 +26,9 @@ given _tree_. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ - *1* : (Default) Only print error messages.++ diff --git a/doc/man/66-disable.1.scd b/doc/man/66-disable.1.scd index 36aeb4df..cf8bd3ce 100644 --- a/doc/man/66-disable.1.scd +++ b/doc/man/66-disable.1.scd @@ -6,7 +6,7 @@ # SYNOPSIS -66-disable [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-S* ] _service_... +66-disable [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-S* ] _service_... # DESCRIPTION @@ -30,6 +30,9 @@ recursively until all dependencies are disabled. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ - *1* : (Default) Only print error messages.++ diff --git a/doc/man/66-enable.1.scd b/doc/man/66-enable.1.scd index 1832ada4..f1090c1f 100644 --- a/doc/man/66-enable.1.scd +++ b/doc/man/66-enable.1.scd @@ -6,14 +6,14 @@ # SYNOPSIS -66-enable [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-f|F* ] [ *-c|C* ] [ *-S* ] _service_... +66-enable [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-f|F* ] [ *-c|C* ] [ *-S* ] _service_... # DESCRIPTION *66-enable* expects to find a corresponding _frontend service file_ (see *66-frontend*(5)), a _directory name_ or a _service instance_, by default at -*%%service_sys%%* or *%%service_packager%%* in this order of precedence for -root user and *%%service_user%%*, *%%service_sys%%* or *%%service_packager%%* +*%%service_adm%%* or *%%service_system%%* in this order of precedence for +root user and *%%service_user%%*, *%%service_adm%%* or *%%service_system%%* in this order of precedence for a normal user. The default path can be changed at compile time by passing the --with-sys-service=_DIR_, \--with-packager-service=_DIR_ and --with-user-service=_DIR_ to *./configure.* @@ -31,6 +31,9 @@ Multiple _services_ can be enabled by seperating their names with a space. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ - *1* : (Default) Only print error messages.++ @@ -79,7 +82,7 @@ This works recursively until all necessary dependencies are enabled. # DIRECTORY NAME AS SERVICE When choosing to make a directory be recognised as service the path of the -directory must exist by default at *%%service_sys%%*, *%%service_packager%%* +directory must exist by default at *%%service_adm%%*, *%%service_system%%* or *$HOME/%%service_user%%* depending of the owner of the process. All _service_ files found in this directory will be enabled. This process is done recursively if a sub-directory is found till it not found other @@ -115,7 +118,7 @@ frontend service file. ## SERVICE CONFIGURATION FILE If the *[environment]* section is set on the frontend service file, the parse -result process can be found by default at *%%service_sysconf%%* for the root +result process can be found by default at *%%service_admconf%%* for the root user and *$HOME/%%service_userconf%%* for a normal user. The default path can be changed at compile time by passing the --with-sys-service-conf=_DIR_ for the root user and --with-user-service-conf=_DIR_ for a normal user. diff --git a/doc/man/66-env.1.scd b/doc/man/66-env.1.scd index e68a1362..009a1119 100644 --- a/doc/man/66-env.1.scd +++ b/doc/man/66-env.1.scd @@ -7,12 +7,12 @@ on the options passed. # SYNOPSIS -66-env [ *-h* ] [ *-v* _verbosity_ ] [ *-t* _tree_ ] [ *-d* _dir_ ] [ *-L* ] [ *-r* _key=value_ ] _service_ +66-env [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-t* _tree_ ] [ *-d* _dir_ ] [ *-L* ] [ *-r* _key=value_ ] _service_ # DESCRIPTION *66-env* open and read the configuration file of _service_ find at -*%%service_sysconf%%* by default. +*%%service_admconf%%* by default. It display the contain of the file or replace a _key=value_ pair if requested. @@ -21,6 +21,9 @@ It display the contain of the file or replace a _key=value_ pair if requested. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ *1* : (Default) Only print error messages.++ diff --git a/doc/man/66-hpr.8.scd b/doc/man/66-hpr.8.scd index 44047758..d24e773c 100644 --- a/doc/man/66-hpr.8.scd +++ b/doc/man/66-hpr.8.scd @@ -14,7 +14,7 @@ hardware shutdown with the *-f* option. It is normally invoked through *halt*, *poweroff* or *reboot* wrappers -installed by default at *%%sysconfdir%%*. +installed by default at *%%skel%%*. This program is a modified copy of *s6-linux-init-hpr* program. diff --git a/doc/man/66-init.1.scd b/doc/man/66-init.1.scd index a33dbc2d..4ae518be 100644 --- a/doc/man/66-init.1.scd +++ b/doc/man/66-init.1.scd @@ -5,7 +5,7 @@ # SYNOPSYS -66-init [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] *classic* | *database* | *both* +66-init [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] *classic* | *database* | *both* # DESCRIPTION @@ -20,6 +20,9 @@ Administrators should invoke *66-init* only once. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ - *1* : (Default) Only print error messages.++ diff --git a/doc/man/66-inservice.1.scd b/doc/man/66-inservice.1.scd index 3c404e02..26714196 100644 --- a/doc/man/66-inservice.1.scd +++ b/doc/man/66-inservice.1.scd @@ -6,7 +6,7 @@ # SYNOPSYS -66-inservice [ *-h* ] [ *-v* _verbosity_ ] [ *-c* ] -[ *-n* ] [ *-o* _name,intree,enabled,..._ ] [ *-g* ] [ *-d* _depth_ ] [ *-r* ] [ *-t* _tree_ ] [ *-p* _nline_ ] _service_ +66-inservice [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-n* ] [ *-o* _name,intree,enabled,..._ ] [ *-g* ] [ *-d* _depth_ ] [ *-r* ] [ *-t* _tree_ ] [ *-p* _nline_ ] _service_ # DESCRIPTION @@ -17,6 +17,9 @@ *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ *1* : (Default) Only prints error messages.++ @@ -24,9 +27,6 @@ *3* : Also prints tracing messages.++ *4* : Also prints debugging messages. -*-c* - enable colorization. - *-n* do not display the field name(s) specified. @@ -116,7 +116,7 @@ In tree : boot Status : enabled, nothing to display Type : bundle Description : Set the hostname and mount filesystem -Source : %%service_packager%%/boot/mount/00 +Source : %%service_system%%/boot/mount/00 Live : %%livedir%%/tree/0/boot/servicedirs/00 Dependencies : system-hostname mount-run populate-run mount-tmp populate-tmp mount-proc mount-sys populate-sys diff --git a/doc/man/66-intree.1.scd b/doc/man/66-intree.1.scd index cf5dc03f..4d4ab763 100644 --- a/doc/man/66-intree.1.scd +++ b/doc/man/66-intree.1.scd @@ -6,7 +6,7 @@ # SYNOPSYS -66-intree [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-c* ] [ *-n* ] [ *-o* name,init,enabled,... ] [ *-g* ] [ *-d* _depth_ ] [ *-r* ] _tree_ +66-intree [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-n* ] [ *-o* name,init,enabled,... ] [ *-g* ] [ *-d* _depth_ ] [ *-r* ] _tree_ # DESCRIPTION @@ -17,6 +17,9 @@ *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ *1* : (Default) Only prints error messages.++ @@ -31,9 +34,6 @@ existing absolute path is expected and should be within a writable filesystem - likely a RAM filesystem. See *66-scandir*(1). -*-c* - enable colorization. - *-n* do not display the field name(s) specified. diff --git a/doc/man/66-parser.1.scd b/doc/man/66-parser.1.scd index c7057012..39755ba4 100644 --- a/doc/man/66-parser.1.scd +++ b/doc/man/66-parser.1.scd @@ -6,7 +6,7 @@ # SYNOPSIS -66-parser [ *-h* ] [ *-v* _verbosity_ ] [ *-f* ] [ *-c* | *-C* ] _service destination_ +66-parser [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-f* ] [ *-c* | *-C* ] _service destination_ # DESCRIPTION @@ -21,6 +21,9 @@ An absolute path is expected for _service_ and _destination_. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ - *1* : (Default) Only print error messages.++ @@ -43,7 +46,7 @@ An absolute path is expected for _service_ and _destination_. key of the given frontend file. This tool is maily intended for debugging purpose and to see the result of a parsing process before actually enabling the service on the system. This tool use the exact same parser as *66-enable* -which by default writes the configuration file to *%%service_sysconf%%*/_service_name_. +which by default writes the configuration file to *%%service_admconf%%*/_service_name_. That's mean that a corresponding file will be overwritten. To avoid this, it writes the configuration file at _destination/env/_ directory and adjust the resulting *run/finish* file to match the configuration file path. diff --git a/doc/man/66-scanctl.1.scd b/doc/man/66-scanctl.1.scd index f5e3dfc2..a366a738 100644 --- a/doc/man/66-scanctl.1.scd +++ b/doc/man/66-scanctl.1.scd @@ -6,7 +6,7 @@ # SYNOPSIS -66-scanctl [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-o* _owner_ ] _signal_ +66-scanctl [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-o* _owner_ ] _signal_ # DESCRIPTION @@ -22,6 +22,9 @@ the current process will be used instead. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ - *1* : (Default) Only print error messages.++ diff --git a/doc/man/66-scandir.1.scd b/doc/man/66-scandir.1.scd index d5291f18..f9e6df2b 100644 --- a/doc/man/66-scandir.1.scd +++ b/doc/man/66-scandir.1.scd @@ -6,7 +6,7 @@ # SYNOPSYS -66-scandir [ *-h* ] [ *-v* _verbosity_ ] [ *-b* ] [ *-l* _live_ ] [* -t* _rescan_ ] [ *-L* _log_user_ ] [ *-s* _skel_ ] [ *-e* _environment_ ] [ *-c* | *-r* | *-u* ] _owner_ +66-scandir [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-b* ] [ *-l* _live_ ] [* -t* _rescan_ ] [ *-L* _log_user_ ] [ *-s* _skel_ ] [ *-e* _environment_ ] [ *-c* | *-r* | *-u* ] _owner_ # DESCRIPTION @@ -22,6 +22,9 @@ explicitely set then the user of the current process will be used instead. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ *1* : (Default) Only print error messages.++ @@ -56,7 +59,7 @@ explicitely set then the user of the current process will be used instead. *-s* _skel_ An absolute path. Directory containing _skeleton_ files. This option is not meant to be used directly even with root. *66-boot*(8) program calls it - at during the boot process. + at during the boot process. Default is %%skel%%. *-L* _log_user_ Will run as the catch-all logger as _log_user_ user. Default is *%%s6log_user%%*. diff --git a/doc/man/66-shutdown.8.scd b/doc/man/66-shutdown.8.scd index 5ef33998..ca600ae6 100644 --- a/doc/man/66-shutdown.8.scd +++ b/doc/man/66-shutdown.8.scd @@ -49,8 +49,8 @@ _time_ must follow the following format: [ *now* | [+]_mins_ | _hh_:_mm_ ] *-a* Access control. The shutdown sequence will only be launched if one of the - users listed in */etc/shutdown.allow* is currently logged in (as tracked by - utmp). */etc/shutdown.allow* is a text file which accepts one user per + users listed in *%%skel%%/shutdown.allow* is currently logged in (as tracked by + utmp). *%%skel%%/shutdown.allow* is a text file which accepts one user per line. Lines starting with *#* are comments. *-t* _sec_ @@ -87,7 +87,7 @@ _time_ must follow the following format: [ *now* | [+]_mins_ | _hh_:_mm_ ] - The *66-shutdown* binary is not meant to be called directly. It shuold always be referenced by the *shutdown* _skeloton_ file installed by default - at *%%sysconfdir%%* directory. The binary *should be copied or symlinked* by + at *%%skel%%* directory. The binary *should be copied or symlinked* by the administrator into the binary directory of your system. - *-f* and *-F* options are only accepted for compatibility. LSB says they are diff --git a/doc/man/66-shutdownd.8.scd b/doc/man/66-shutdownd.8.scd index eb3bc652..f25971dc 100644 --- a/doc/man/66-shutdownd.8.scd +++ b/doc/man/66-shutdownd.8.scd @@ -17,7 +17,7 @@ It is not meant to be called directly by the user. This program is a modified co they are told to trigger the shutdown procedure. - When it receives a command to shut down, *66-shutdownd* parses the _skel_ - file _rc.init_ define by default at *%%sysconfdir%%* directory and reads the + file _rc.init_ define by default at *%%skel%%* directory and reads the value of *RCSHUTDOWN* variable to be able to spawns the _rc.shutdown_ script. - When said script exits, *66-shutdownd* kills all processes with a @@ -42,7 +42,7 @@ It is not meant to be called directly by the user. This program is a modified co *-s* _skel_ An abdolute path. Directory of the skeleton file _rc.init_. Default is - *%%sysconfdir%%*. + *%%skel%%*. *-g* _gracetime_ Specify a grace time between the SIGTERM and the SIGKILLin milliseconds if diff --git a/doc/man/66-start.1.scd b/doc/man/66-start.1.scd index f94678c6..1dcc9966 100644 --- a/doc/man/66-start.1.scd +++ b/doc/man/66-start.1.scd @@ -6,7 +6,7 @@ # SYNOPSYS -66-start [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-r* | *-R* ] _service..._ +66-start [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-r* | *-R* ] _service..._ # DESCRIPTION @@ -22,6 +22,9 @@ Multiple _services_ can be started by seperating their names with a space. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ *1* : (Default) Only print error messages.++ diff --git a/doc/man/66-stop.1.scd b/doc/man/66-stop.1.scd index c3750ba5..f46d7dce 100644 --- a/doc/man/66-stop.1.scd +++ b/doc/man/66-stop.1.scd @@ -6,7 +6,7 @@ # SYNOPSYS -66-stop [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-u* ] [ *-X* ] [ *-K* ] _service..._ +66-stop [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-u* ] [ *-X* ] [ *-K* ] _service..._ # DESCRIPTION @@ -21,6 +21,9 @@ Multiple _services_ can be stopped by seperating their names with a space. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ *1* : (Default) Only print error messages.++ diff --git a/doc/man/66-svctl.1.scd b/doc/man/66-svctl.1.scd index ff851a4d..b5c48d9e 100644 --- a/doc/man/66-svctl.1.scd +++ b/doc/man/66-svctl.1.scd @@ -6,7 +6,7 @@ # SYNOPSYS -66-svctl [ *-h* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-n* _death_ ] [ *-u* | *-d* | *-r* | *-K* | *-X* ] _service..._ +66-svctl [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-t* _tree_ ] [ *-T* _timeout_ ] [ *-n* _death_ ] [ *-u* | *-d* | *-r* | *-K* | *-X* ] _service..._ # DESCRIPTION @@ -24,6 +24,9 @@ The command is sent to the _selection_ asynchronously. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ *1* : (Default) Only print error messages.++ diff --git a/doc/man/66-tree.1.scd b/doc/man/66-tree.1.scd index 2d781fce..e05ef764 100644 --- a/doc/man/66-tree.1.scd +++ b/doc/man/66-tree.1.scd @@ -6,7 +6,7 @@ # SYNOPSYS -66-tree [ *-h* ] [ *-v* _verbosity_ ] [ -l ] [ *-n* | *-R* ] [ *-a* | *-d* ] [ *-c* _clone_ ] [ *-S* _after_tree_ ] [ *-E* | *-D* ] [ *-U* ] [ *-C* ] _tree_ +66-tree [ *-h* ] [ *-z* ] [ *-v* _verbosity_ ] [ -l ] [ *-n* | *-R* ] [ *-a* | *-d* ] [ *-c* _clone_ ] [ *-S* _after_tree_ ] [ *-E* | *-D* ] [ *-U* ] [ *-C* ] _tree_ # DESCRIPTION @@ -20,6 +20,9 @@ what trees are currently available on the system use the *66-intree*(1) tool. *-h* Prints this help. +*-z* + use color. + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ *1* : (Default) Only prints error messages.++ diff --git a/doc/man/66-update.1.scd b/doc/man/66-update.1.scd index 410a3dfd..a0b425e1 100644 --- a/doc/man/66-update.1.scd +++ b/doc/man/66-update.1.scd @@ -6,7 +6,7 @@ # SYNOPSYS -66-update [ *-h* ] [ *-v* _verbosity_ ] [* -c* ] [ *-l* _live_ ] [ *-d* ] _tree_ +66-update [ *-h* ] [*-z* ] [ *-v* _verbosity_ ] [ *-l* _live_ ] [ *-d* ] _tree_ # DESCRIPTION @@ -25,6 +25,9 @@ without needing a reboot. *-h* Prints this help. +*-z* + use color + *-v* _verbosity_ Increases/decreases the verbosity of the command.++ *1* : (Default) Only prints error messages.++ @@ -32,9 +35,6 @@ without needing a reboot. *3* : Also prints tracing messages.++ *4* : Also prints debugging messages. -*-c* - enable colorization - *-l* _live_ An absolute path. Create the scandir at _live_. Default is *%%livedir%%*. The default can also be changed at compile-time by passing the -- GitLab