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

update doc

parent 0386a3cd
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
doc/html/66-inservice.html
+ 14
− 15
View file @ d508e212
...@@ -34,27 +34,27 @@ ...@@ -34,27 +34,27 @@
</li> </li>
<li> <li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>&nbsp;: increases/decreases <tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>&nbsp;: increases/decreases
the verbosity of the command. <tt>1(Default)</tt>: Only print the verbosity of the command. <tt>1(Default)</tt>: Only prints
error messages. <tt>2</tt>: Also print warning messages. error messages. <tt>2</tt>: Also prints warning messages.
<tt>3</tt>: Also print debugging messages. <tt>3</tt>: Also prints debugging messages.
</li> </li>
<li> <li>
<tt>-c&nbsp;</tt>&nbsp;: enable colorization. <tt>-c&nbsp;</tt>&nbsp;: enable colorization.
</li> </li>
<li> <li>
<tt>-o&nbsp;</tt>&nbsp;: comma separated list of field to display. If this option is not past, <tt>66-inservice</tt> will display all field. <tt>-o&nbsp;</tt>&nbsp;: comma separated list of field to display. If this option is not past, <tt>66-inservice</tt> will display all fields.
</li> </li>
<li> <li>
<tt>-g&nbsp;</tt>&nbsp;: shows the dependency list of <em>service</em> as graph instead of list. <tt>-g&nbsp;</tt>&nbsp;: shows the dependency list of <em>service</em> as graph instead of list.
</li> </li>
<li> <li>
<tt>-d&nbsp;<em>depth</em>&nbsp;</tt>&nbsp;: limits the depth of the dependency list visualisation; defaults to 1. This is implies <tt>-g</tt> options. <tt>-d&nbsp;<em>depth</em>&nbsp;</tt>&nbsp;: limits the depth of the dependency list visualisation; defaults to 1. This implies <tt>-g</tt> option.
</li> </li>
<li> <li>
<tt>-r&nbsp;</tt>&nbsp;: shows the dependency list of <em>service</em> in reverse mode. <tt>-r&nbsp;</tt>&nbsp;: shows the dependency list of <em>services</em> in reverse mode.
</li> </li>
<li> <li>
<tt>-t&nbsp;<em>tree</em>&nbsp;</tt>&nbsp;: only search the <em>service</em> at the specified <em>tree</em>. <tt>-t&nbsp;<em>tree</em>&nbsp;</tt>&nbsp;: only searches the <em>service</em> at the specified <em>tree</em>.
</li> </li>
<li> <li>
...@@ -72,10 +72,10 @@ ...@@ -72,10 +72,10 @@
<tt>intree</tt>&nbsp;: displays the <em>service's</em> tree name. <tt>intree</tt>&nbsp;: displays the <em>service's</em> tree name.
</li> </li>
<li> <li>
<tt>status</tt>&nbsp;: displays the status of the <em>service</em>. <tt>status</tt>&nbsp;: displays the status.
</li> </li>
<li> <li>
<tt>type</tt>&nbsp;: displays the type of the <em>service</em>. <tt>type</tt>&nbsp;: displays the <em>service</em> type.
</li> </li>
<li> <li>
<tt>description</tt>&nbsp;: displays the description. <tt>description</tt>&nbsp;: displays the description.
...@@ -99,7 +99,7 @@ ...@@ -99,7 +99,7 @@
<tt>envat</tt>&nbsp;: displays the source of the environment file. <tt>envat</tt>&nbsp;: displays the source of the environment file.
</li> </li>
<li> <li>
<tt>envfile</tt>&nbsp;: displays the contains of the environment file. <tt>envfile</tt>&nbsp;: displays the contents of the environment file.
</li> </li>
<li> <li>
<tt>logname</tt>&nbsp;: displays the logger's name. <tt>logname</tt>&nbsp;: displays the logger's name.
...@@ -108,15 +108,14 @@ ...@@ -108,15 +108,14 @@
<tt>logdst</tt>&nbsp;: displays the logger's destination. <tt>logdst</tt>&nbsp;: displays the logger's destination.
</li> </li>
<li> <li>
<tt>logfile</tt>&nbsp;: displays the contain of the log file. <tt>logfile</tt>&nbsp;: displays the contents of the log file.
</li> </li>
</ul> </ul>
<h2>Command and output examples</h2> <h2>Command and output examples</h2>
<p>The command <tt>66-inservice 00</tt> as root user on the <em>Obarun</em> default system displays the following where <em>00</em> <p>The command <tt>66-inservice 00</tt> as root user on <em>Obarun's</em> default system displays the following where <em>00</em> is a service contained in the tree <em>boot</em>:
is a service contained in the tree <em>boot</em>:
<pre> <pre>
Name : 00 Name : 00
In tree : boot In tree : boot
...@@ -137,8 +136,8 @@ ...@@ -137,8 +136,8 @@
</pre> </pre>
</p> </p>
<p> <p>
By default the dependency graph is rendered in order of execution. In this example the <em>'oneshot' system-hostname</em> is the first executed By default the dependency graph is rendered in the order of execution. In this example the <em>'oneshot' system-hostname</em> is the first executed
service and <em>'oneshot' mount-cgroups</em> is the last finished. You can reverse the rendered order with the <tt>-r</tt> option.</p> service and <em>'oneshot' mount-cgroups</em> is the last one when it finishes. You can reverse the rendered order with the <tt>-r</tt> option.</p>
</p> </p>
<p>You can display the status and depends field and only these fields of a service using the command <tt>66-inservice -o status,depends -g connmand</tt> where the dependency list is diplayed as a graph: <p>You can display the status and depends field and only these fields of a service using the command <tt>66-inservice -o status,depends -g connmand</tt> where the dependency list is diplayed as a graph:
......
doc/html/66-intree.html
+ 14
− 14
View file @ d508e212
...@@ -35,9 +35,9 @@ ...@@ -35,9 +35,9 @@
</li> </li>
<li> <li>
<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>&nbsp;: increases/decreases <tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>&nbsp;: increases/decreases
the verbosity of the command. <tt>1(Default)</tt>: Only print the verbosity of the command. <tt>1(Default)</tt>: Only prints
error messages. <tt>2</tt>: Also print warning messages. error messages. <tt>2</tt>: Also prints warning messages.
<tt>3</tt>: Also print debugging messages. <tt>3</tt>: Also prints debugging messages.
</li> </li>
<li> <li>
<tt>-l&nbsp;<em>live</em>&nbsp;</tt>&nbsp;: changes the supervision directory of <em>service</em> to <em>live</em>. By default this will be <tt>%%livedir%%</tt>. The default can <tt>-l&nbsp;<em>live</em>&nbsp;</tt>&nbsp;: changes the supervision directory of <em>service</em> to <em>live</em>. By default this will be <tt>%%livedir%%</tt>. The default can
...@@ -49,7 +49,7 @@ ...@@ -49,7 +49,7 @@
<tt>-c&nbsp;</tt>&nbsp;: enable colorization. <tt>-c&nbsp;</tt>&nbsp;: enable colorization.
</li> </li>
<li> <li>
<tt>-o&nbsp;</tt>&nbsp;: comma separated list of field to display. If this option is not past, <tt>66-intree</tt> will display all field. <tt>-o&nbsp;</tt>&nbsp;: comma separated list of field to display. If this option is not past, <tt>66-intree</tt> will display all fields.
</li> </li>
<li> <li>
<tt>-g&nbsp;</tt>&nbsp;: shows the dependency list of <em>tree</em> as graph instead of list. <tt>-g&nbsp;</tt>&nbsp;: shows the dependency list of <em>tree</em> as graph instead of list.
...@@ -84,7 +84,7 @@ ...@@ -84,7 +84,7 @@
</ul> </ul>
<h2>Command and output examples</h2> <h2>Command and output examples</h2>
<p>The command <tt>66-intree boot</tt> as root user on the <em>Obarun</em> default system displays the following where <em>boot</em> <p>The command <tt>66-intree boot</tt> as root user on <em>Obarun's</em> default system displays the following where <em>boot</em>
is the tree used to properly boot the machine: is the tree used to properly boot the machine:
<pre> <pre>
Name : boot Name : boot
...@@ -102,22 +102,22 @@ ...@@ -102,22 +102,22 @@
</pre> </pre>
</p> </p>
<p> <p>
The field <tt><em>name</em></tt> give you the name of the <em>tree</em>. The field <tt><em>name</em></tt> gives you the name of the <em>tree</em>.
</p> </p>
<p> <p>
The field <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. The field <tt><em>Initialized</em></tt> tells you if the <tree>tree</tree> was initialized with <tt><a href="66-init.html">66-init</a></tt> tool.
</p> </p>
<p> <p>
The field <tt><em>Enabled</em></tt> reveals the state of the tree&mdash;see <tt><a href="66-tree.html">66-tree -E</a></tt>. The field <tt><em>Enabled</em></tt> reveals the state of the tree&mdash;see <tt><a href="66-tree.html">66-tree -E</a></tt>.
</p> </p>
<p> <p>
The field <tt><em>Current</em></tt> tells if the <em>tree</em> is the current one or not&mdash;see <tt><a href="66-tree.html">66-tree -c</a></tt>. The field <tt><em>Current</em></tt> tells you if the <em>tree</em> is the current one or not&mdash;see <tt><a href="66-tree.html">66-tree -c</a></tt>.
</p> </p>
<p> <p>
The field <tt><em>Contains</em></tt> give you a list of all services enabled in the <em>tree</em>. The field <tt><em>Contains</em></tt> gives you a list of all services enabled in the <em>tree</em>.
</p> </p>
<p>You can display the contain list as a graph and only these fields using the command <tt>66-intree -o contains -g boot</tt>: <p>You can display the contents list as a graph and only these fields using the command <tt>66-intree -o contains -g boot</tt>:
<pre> <pre>
Contains : / Contains : /
├─(253,Enabled,classic) tty12 ├─(253,Enabled,classic) tty12
...@@ -169,12 +169,12 @@ ...@@ -169,12 +169,12 @@
└─(0,Enabled,bundle) All └─(0,Enabled,bundle) All
</pre> </pre>
<p> <p>
For each service the first number found between '()' bracket is the corresponding pid of the service, For each service the first number found between '()' parentheses 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. the second one is the state of the service, the type of the service is shown next to it, and finally the name of the service is displayed after the parenthesis ')'.
</p> </p>
<p> <p>
By default the dependency graph is rendered in order of execution. In this example the <em>'classic' tty12</em> is the first executed By default the dependency graph is rendered in the order of execution. In this example the <em>'classic' tty12</em> is the first executed
service and <em>'bundle' All</em> is the last finished. You can reverse the rendered order with the <tt>-r</tt> option.</p> service and <em>'bundle' All</em> is the last before it finishes. You can reverse the rendered order with the <tt>-r</tt> option.</p>
</p> </p>
<p>You can display the name and current field and only these fields for each tree using the command <tt>66-intree -o name,current</tt>: <p>You can display the name and current field and only these fields for each tree using the command <tt>66-intree -o name,current</tt>:
<pre> <pre>
......
doc/man/66-inservice.1.scd
+ 14
− 14
View file @ d508e212
...@@ -19,29 +19,29 @@ ...@@ -19,29 +19,29 @@
*-v* _verbosity_ *-v* _verbosity_
Increases/decreases the verbosity of the command.++ Increases/decreases the verbosity of the command.++
*1* : (Default) Only print error messages.++ *1* : (Default) Only prints error messages.++
*2* : Also print warning messages.++ *2* : Also prints warning messages.++
*3* : Also print debugging messages. *3* : Also prints debugging messages.
*-c* *-c*
enable colorization. enable colorization.
*-o* *-o*
comma separated list of field to display. If the option is not past, comma separated list of field to display. If the option is not past,
*66-inservice* will display all field. *66-inservice* will display all fields.
*-g* *-g*
shows the dependency list of _tree_ as graph instead of list. shows the dependency list of _service_ as graph instead of list.
*-d* _depth_ *-d* _depth_
Limits the depth of the dependency list visualisation; defaults to 1. Limits the depth of the dependency list visualisation; defaults to 1.
This implies the *-g* option. This implies the *-g* option.
*-r* *-r*
Shows the dependency list of _tree_ in reverse mode. Shows the dependency list of _service_ in reverse mode.
*-t* _tree_ *-t* _tree_
only search the _service_ at the specified _tree_. only searches the _service_ at the specified _tree_.
*-p* _nline_ *-p* _nline_
prints the _nline_ last lines from the log file of the _service_. prints the _nline_ last lines from the log file of the _service_.
...@@ -56,10 +56,10 @@ ...@@ -56,10 +56,10 @@
Displays the _service_'s tree name. Displays the _service_'s tree name.
*status* *status*
Displays the status of the _service_. Displays the status.
*type* *type*
Displays the type of the _service_. Displays the _service_ type.
*description* *description*
Displays the description of the _service_. Displays the description of the _service_.
...@@ -83,7 +83,7 @@ ...@@ -83,7 +83,7 @@
Displays the source of the environment file. Displays the source of the environment file.
*envfile* *envfile*
Displays the contain of the environment file. Displays the contents of the environment file.
*logname* *logname*
Displays the logger's name. Displays the logger's name.
...@@ -92,11 +92,11 @@ ...@@ -92,11 +92,11 @@
Displays the logger's destination. Displays the logger's destination.
*logfile* *logfile*
Displays the contain of the log file. Displays the contents of the log file.
# COMMAND AND OUTPUT EXAMPLE # COMMAND AND OUTPUT EXAMPLE
The command "66-inservice 00" as root user on the _Obarun_ default system The command "66-inservice 00" as root user on _Obarun_'s default system
displays the following where *00* is service contained in the tree *boot*: displays the following where *00* is service contained in the tree *boot*:
``` ```
...@@ -121,9 +121,9 @@ Log file : logger doesn't exist ...@@ -121,9 +121,9 @@ Log file : logger doesn't exist
``` ```
By default the dependency graph is rendered in order of execution. In By default the dependency graph is rendered in the order of execution. In
this example the *oneshot system-hostname* is the first executed service and this example the *oneshot system-hostname* is the first executed service and
*mount-cgroups* is the last finished. You can reverse the rendered order with *mount-cgroups* is the last one when it finishes. You can reverse the rendered order with
the *-r* option. the *-r* option.
You can display the status and depends field and only these fields of a You can display the status and depends field and only these fields of a
......
doc/man/66-intree.1.scd
+ 15
− 15
View file @ d508e212
...@@ -19,9 +19,9 @@ ...@@ -19,9 +19,9 @@
*-v* _verbosity_ *-v* _verbosity_
Increases/decreases the verbosity of the command.++ Increases/decreases the verbosity of the command.++
*1* : (Default) Only print error messages.++ *1* : (Default) Only prints error messages.++
*2* : Also print warning messages.++ *2* : Also prints warning messages.++
*3* : Also print debugging messages. *3* : Also prints debugging messages.
*-l* _live_ *-l* _live_
Changes the supervision directory of _service_ to _live_. Changes the supervision directory of _service_ to _live_.
...@@ -56,7 +56,7 @@ ...@@ -56,7 +56,7 @@
Displays the name of the _tree_. Displays the name of the _tree_.
*init* *init*
Display a boolean value of the initialization state. Displays a boolean value of the initialization state.
*enabled* *enabled*
Displays a boolean value of the enable state. Displays a boolean value of the enable state.
...@@ -69,7 +69,7 @@ ...@@ -69,7 +69,7 @@
# COMMAND AND OUTPUT EXAMPLE # COMMAND AND OUTPUT EXAMPLE
The command "66-intree boot" as root user on the _Obarun_ default system The command "66-intree boot" as root user on _Obarun_'s default system
displays the following where *boot* is the tree used to properly boot displays the following where *boot* is the tree used to properly boot
the machine: the machine:
...@@ -91,18 +91,18 @@ Contains : tty12 system-hostname mount-run populate-run mount-tmp ...@@ -91,18 +91,18 @@ Contains : tty12 system-hostname mount-run populate-run mount-tmp
all-Runtime All all-Runtime All
``` ```
The field *name* give you the name of the _tree_. The field *name* gives you the name of the _tree_.
The field *Initialized* tells if the _tree_ was initialized with "66-init" tool. The field *Initialized* tells you if the _tree_ was initialized with "66-init" tool.
The field *Enabled* reveals the state of the tree -- see "66-tree -E". The field *Enabled* reveals the state of the tree -- see "66-tree -E".
The field *Current* tells if the _tree_ is the current one or not -- see The field *Current* tells you if the _tree_ is the current one or not -- see
"66-tree -c". "66-tree -c".
The field *Contains* give you a list of all services enabled in the _tree_. The field *Contains* gives you a list of all services enabled in the _tree_.
You can display the contain list as a graph and only these fields using You can display the contents list as a graph and only these fields using
the command "66-intree -o contains -g boot": the command "66-intree -o contains -g boot":
``` ```
...@@ -156,14 +156,14 @@ Contains : / ...@@ -156,14 +156,14 @@ Contains : /
└─(0,Enabled,bundle) All └─(0,Enabled,bundle) All
``` ```
For each service the first number found between *()* bracket is the For each service the first number found between *()* parentheses is the
corresponding pid of the service, the second one is the state of 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 service, the type of the service is shown next to it, and finally the name
of the service is displayed. of the service is displayed after the parenthesis ')'.
By default the dependency graph is rendered in order of execution. In By default the dependency graph is rendered in the order of execution. In
this example the *classic tty12* is the first executed service and this example the *classic tty12* is the first executed service and
*bundle All* is the last finished. You can reverse the rendered order with *bundle All* is the last before it finishes. You can reverse the rendered order with
the *-r* option. the *-r* option.
You can display the name and current field and only these fields for each You can display the name and current field and only these fields for each
......
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