Skip to content
Snippets Groups Projects
Commit 34363647 authored by Eric Vidal's avatar Eric Vidal :speech_balloon:
Browse files

update doc

parent dc2ee97a
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 135 additions and 84 deletions
doc/html/66-all.html
+ 2
− 2
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help. </li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-dbctl.html
+ 2
− 2
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help. </li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-disable.html
+ 2
− 2
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help. </li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-enable.html
+ 2
− 2
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help. </li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-env.html
+ 3
− 4
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: print this help.</li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-init.html
+ 2
− 1
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help. </li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color. </li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
......
doc/html/66-inservice.html
+ 5
− 5
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help.
</li>
<li>
<li>
<tt>-z&nbsp;</tt>&nbsp;: use color.
</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</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&nbsp;</tt>&nbsp;: enable colorization.
</li>
<li>
<tt>-n&nbsp;</tt>&nbsp;: do not display the field name(s) specified.
</li>
......
doc/html/66-intree.html
+ 3
− 7
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help.
</li>
<li> <tt>-h&nbsp;</tt>&nbsp;: prints this help.</li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</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&mdash;see <tt><a href="66-scandir.html">66-scandir</a></tt>.
</li>
<li>
<tt>-c&nbsp;</tt>&nbsp;: enable colorization.
</li>
<li>
<tt>-n&nbsp;</tt>&nbsp;: do not display the field name(s) specified.
</li>
......
doc/html/66-parser.html
+ 3
− 4
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: print this help.</li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-scanctl.html
+ 3
− 5
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: print this help.</li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-scandir.html
+ 3
− 5
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: print this help.</li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-start.html
+ 2
− 2
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help. </li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-stop.html
+ 2
− 2
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help. </li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-svctl.html
+ 3
− 5
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: print this help.</li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-tree.html
+ 2
− 2
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: prints this help. </li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color.</li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......
doc/html/66-update.html
+ 3
− 8
View file @ 34363647
......@@ -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&nbsp;</tt>&nbsp;: print this help.</li>
<li> <tt>-z&nbsp;</tt>&nbsp;: use color. </li>
<li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases
the verbosity of the command.
......@@ -66,9 +64,6 @@
</li>
<li>
<tt>-c&nbsp;</tt>&nbsp;: enable colorization.
</li>
<li>
<tt>-d&nbsp;</tt>&nbsp;: 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
......
doc/html/frontend.html
+ 78
− 17
View file @ 34363647
......@@ -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 (!)&#8212;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>
......
doc/man/66-all.1.scd
+ 4
− 1
View file @ 34363647
......@@ -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.++
......
doc/man/66-boot.8.scd
+ 7
− 7
View file @ 34363647
......@@ -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.
......
doc/man/66-dbctl.1.scd
+ 4
− 1
View file @ 34363647
......@@ -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.++
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment