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

update index.html page

parent 16e9c36f
Branches
Tags
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 75 additions and 80 deletions
doc/index.html
+ 75
− 80
View file @ 9f2bc0eb
......@@ -14,104 +14,99 @@
<a href="//obarun.org/">obarun.org</a>
</p>
<h1> 66 </h1>
<h2> What is it&nbsp;? </h2>
<p>
66 is a collection of tools builded around <a href="http://skarnet.org/software/s6">s6</a>
and <a href="http://skarnet.org/software/s6-rc">s6-rc</a> programs to
facilitate the implementations and manipulation of services file on your
machine. It is meant to be a toolbox for service declaration, implementation
and administration, and that can be assembled together to achieve powerful
functionality with a very small amount of code.
</p>
<p>
Examples of things you can do by assembling together several programs
provided by 66 :
</p>
<ul>
<li> Frontend service files declaration. </li>
<li> Handling all kind of services coming from s6 and s6-rc program. </li>
<li> Backup a complete set of divers sort of kind of services.</li>
<li> Controlling the environment of the init file. </li>
<li> Controlling permissions use of service and <a href="https://skarnet.org/software/s6/scandir.html">scandir</a>
or a complete set of services. </li>
<li> Nested supervision tree. </li>
</ul>
<p>
The 66 documentation tries to be complete and self-contained; however,
if you have never heard of s6/s6-rc programs, you might be
confused at first. See the <a href="https://skarnet.org/software/">skarnet</a> program documentation
to understand the basics in particular the <a href="http://skarnet.org/software/s6">s6</a>
and <a href="http://skarnet.org/software/s6-rc">s6-rc</a> programs.
</p>
<h1><br> What is 66? </h1>
<p>
Sixty-six is a collection of system tools built around
<a href="http://skarnet.org/software/s6">s6</a> and
<a href="http://skarnet.org/software/s6-rc">s6-rc</a> created to
make the implementation and manipulation of service files on your
machine easier. It is meant to be a toolbox for the declaration,
implementation and administration of services where seperate programs
can be joined to achieve powerful functionality with small amounts of code.
</p>
<p>
Examples of what can be achieved by assembling different programs provided by 66:
</p>
<ul>
<li> Frontend service files declaration. </li>
<li> Handling of any s6 and s6-rc service </li>
<li> Backup a complete set of services.</li>
<li> Controlling the environment of the init file. </li>
Controlling permissions for the use of services and <a href="https://skarnet.org/software/s6/scandir.html">scandir</a>.
</li>
<li> Nested supervision tree. </li>
</ul>
<p>
<strong>Note</strong>: This documentation tries to be complete
and self-contained. However, if you have never heard of s6 or
s6-rc you might be confused at first. Please refer to the
<a href="https://skarnet.org/software/">skarnet</a> documentation
if in doubt.
</p>
<h2> Installation </h2>
<h3> Requirements </h3>
<h3> Requirements </h3>
<p>
Please refer to the <a href="https://framagit.org/Obarun/66">INSTALL</a> file for details.
</p>
<ul>
<li> See the <a href="https://framagit.org/Obarun/66">INSTALL</a> file.</li>
</ul>
<h3> Licensing </h3>
<h3> Licensing </h3>
<p>
66 is free software. It is available under the
<a href="http://opensource.org/licenses/ISC">ISC license</a>.
</p>
<p>
66 is free software. It is available under the
<a href="http://opensource.org/licenses/ISC">ISC license</a>.
</p>
<hr />
<h2> Reference </h2>
<h3> Commands </h3>
<h2> Commands </h2>
<h4> Admin tools </h4>
<h3> Admin tools </h3>
<ul>
<li><a href="66-scandir.html">The <tt>66-scandir</tt> program</a></li>
<li><a href="66-init.html">The <tt>66-init</tt> program</a></li>
<li><a href="66-svctl.html">The <tt>66-svctl</tt> program</a></li>
<li><a href="66-dbctl.html">The <tt>66-dbctl</tt> program</a></li>
<li><a href="66-all.html">The <tt>66-all</tt> program</a></li>
</ul>
<ul>
<li><a href="66-scandir.html"><tt>66-scandir</tt></a></li>
<li><a href="66-init.html"><tt>66-init</tt></a></li>
<li><a href="66-svctl.html"><tt>66-svctl</tt></a></li>
<li><a href="66-dbctl.html"><tt>66-dbctl</tt></a></li>
<li><a href="66-all.html"><tt>66-all</tt></a></li>
</ul>
<h4> User tools </h4>
<h3> User tools </h3>
<ul>
<li><a href="frontend.html">The <tt>frontend</tt> service file</a></li>
<li><a href="66-tree.html">The <tt>66-tree</tt> program</a></li>
<li><a href="66-enable.html">The <tt>66-enable</tt> program</a></li>
<li><a href="66-disable.html">The <tt>66-disable</tt> program</a></li>
<li><a href="66-start.html">The <tt>66-start</tt> program</a></li>
<li><a href="66-stop.html">The <tt>66-stop</tt> program</a></li>
</ul>
<ul>
<li><a href="frontend.html"><tt>frontend</a> <em>(service file)</em></tt></li>
<li><a href="66-tree.html"><tt>66-tree</tt></a></li>
<li><a href="66-enable.html"><tt>66-enable</tt></a></li>
<li><a href="66-disable.html"><tt>66-disable</tt></a></li>
<li><a href="66-start.html"><tt>66-start</tt></a></li>
<li><a href="66-stop.html"><tt>66-stop</tt></a></li>
</ul>
<h2> Miscellaneous </h2>
<p>
Implementations and handling services file coming from s6 and s6-rc programs
can be complex and difficult to understand, that's why 66 tools was born.
</p>
<h2> Why is 66 necessary? </h2>
<h3> Why "66"&nbsp;? </h3>
<p>
Implementation and handling of service files based on s6 and s6-rc can be complex and difficult to understand. This led to the creation of the 66 tools.
</p>
<p>
s<strong>6</strong> + s<strong>6</strong>-rc, so 66. Moreover 66- is really
quick and easier to write with the keyboard numpad :).
</p>
<h3> Why the name </h3>
<p>
Also, 66 is a nice command name prefix to have: it identifies the origin of the
software, and it's short. Expect more use of 66- in future obarun.org software
releases. And please avoid using that prefix for your own projects.
</p>
<p>
66 is the result of the combination of the former s<strong>6</strong> and s<strong>6</strong>-rc.<br>
It is a lot faster and easier to write and remember when writing.
Apart from that it is a nice command prefix to have.
It identifies the origin of the software and it's short.
</p>
<p>
Expect more use of the <tt>66-</tt> prefix in future obarun.org
software releases and please avoid using it for your own projects.
</p>
</body>
</html>
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment