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

update doc

parent 56d59820
No related branches found
No related tags found
No related merge requests found
......@@ -31,7 +31,7 @@
<br>(!) This tool only deals with <em>'classic'</em> services&mdash;see <a href="66-dbctl.html"><tt>66-dbctl</tt></a> for other types of services.
</p>
<p>Multiple <em>services</em> can be handled by seperating their names with a space. <tt>66-svctl</tt> gathers each of these services in a list called <em>selection</em>.
It try to be quicker as possible and send command to the <em>selection</em> asynchronously.</p>
It tries to be as quick as possible and sends a command to the <em>selection</em> asynchronously.</p>
<h2>Exit codes</h2>
<p>
<ul>
......@@ -66,12 +66,12 @@
<li>
<tt>-T&nbsp;<em>timeout</em>&nbsp;</tt></tt>&nbsp;: specifies a timeout (in milliseconds)
after which <tt>66-svctl</tt> will stop to try to reach the desired state of the <em>service</em>; defaults to 3000. <em>timeout</em> is apply for each service of the selection. If you want to set <em>timeout</em> for each <em>service</em> separately use the <tt>@timeout-up</tt> or <tt>@timeout-down</tt> key into the <a href="frontend.html">frontend</a> service file instead. In such case this option has <strong>no effect</strong>.
after which <tt>66-svctl</tt> will stop to try to reach the desired state of the <em>service</em>; defaults to 3000. <em>timeout</em> is applied for each service of the selection. If you want to set <em>timeout</em> for each <em>service</em> separately use the <tt>@timeout-up</tt> or <tt>@timeout-down</tt> key into the <a href="frontend.html">frontend</a> service file instead. In such case this option has <strong>no effect</strong>.
</li>
<li>
<tt>-n&nbsp;<em>death</em>&nbsp;</tt>&nbsp;: specifies the maximum number of service death events that the supervisor will keep track of.
If the service dies more than this number of times, <tt>66-svctl</tt> will stop to try to reach the desired state of the <em>services</em>.
If the service dies more than this number of times, <tt>66-svctl</tt> will stop trying to reach the desired state of the <em>services</em>.
This option has <strong>no effect</strong> if a <tt>@maxdeath</tt> was defined for the given service at parsing time&mdash;see <tt><a href="66-frontend.html">frontend</a></tt>.
If this option is not specified and no <em>max-death-tally</em> file exists the maximum allowed deaths will default to 5.
</li>
......
......@@ -17,7 +17,7 @@
<h1> 66-umountall</h1>
<p>
<tt>66-umountall</tt> is an exact copy of <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-umountall.html">66-umountall</a> program. It only provide to avoid the dependencies of <a href="https://skarnet.org/software/s6-linux-init/">s6-linux-init</a> package at <tt>66</tt> tools compilation time. Refers to the <a href="https://skarnet.org/software/s6-linux-init/">s6-linux-init</a> documentation page for futher information.
<tt>66-umountall</tt> is an exact copy of <a href="https://skarnet.org/software/s6-linux-init/s6-linux-init-umountall.html">66-umountall</a> program. It is only provided as to avoid the dependencies of <a href="https://skarnet.org/software/s6-linux-init/">s6-linux-init</a> package at <tt>66</tt> tools compilation time. Refers to the <a href="https://skarnet.org/software/s6-linux-init/">s6-linux-init</a> documentation page for futher information.
</p>
......
......@@ -18,7 +18,7 @@
<h1>execl-envfile</h1>
<p>
This command is a mix of <a href="https://skarnet.org/software/s6/s6-envdir.html"><tt>s6-envdir</tt></a> and <a href="https://skarnet.org/software/execline/importas.html"><tt>importas</tt></a> <em>program</em>.
This command is a blend of <a href="https://skarnet.org/software/s6/s6-envdir.html"><tt>s6-envdir</tt></a> and <a href="https://skarnet.org/software/execline/importas.html"><tt>importas</tt></a> <em>program</em>.
It reads files containing variable assignments on the given directory, adds the variables to the environment, then executes a program.
</p>
......@@ -29,14 +29,14 @@
</pre>
<p>
This tool expects to find a regular file(s) in <em>dir</em> containing one or multiple <tt>key=value</tt> pair. For earch files found: it will parse the file, import the <tt>key=value</tt> then execs <em>prog</em> with the modified environment.
This tool expects to find a regular file(s) in <em>dir</em> containing one or multiple <tt>key=value</tt> pair. For each files found: it will parse the file, import the <tt>key=value</tt> then execs <em>prog</em> with the modified environment.
</p>
<ul>
<li>It open and read the file.</li>
<li>It parse the file.</li>
<li>It import the <tt>key=value</tt> pair.</li>
<li>It substitute each corresponding <tt>key</tt> by <tt>value</tt> into the file.</li>
<li>It unexport the variable if requested.</li>
<li>It opens and reads the file.</li>
<li>It parses the file.</li>
<li>It imports the <tt>key=value</tt> pair.</li>
<li>It substitutes each corresponding <tt>key</tt> by <tt>value</tt> into the file.</li>
<li>It unexports the variable if requested.</li>
<li>It execs <em>prog</em> with the modified environment.</li>
</ul>
<h2> Options </h2>
......@@ -44,10 +44,10 @@
<ul>
<li> <tt>-h&nbsp;</tt>&nbsp;: prints this help. </li>
<li>
<tt>-f&nbsp;<em>file</em>&nbsp;</tt>&nbsp;: only parse <em>file</em> found in <em>dir</em>.
<tt>-f&nbsp;<em>file</em>&nbsp;</tt>&nbsp;: only parses the <em>file</em> found in <em>dir</em>.
</li>
<li>
<tt>-l&nbsp;</tt>&nbsp;: loose. do nothing and executes <em>prog</em> directly if <em>dir</em> do not contain any regular file(s) or <em>dir</em> doesn't exist.
<tt>-l&nbsp;</tt>&nbsp;: loose. does nothing and executes <em>prog</em> directly if <em>dir</em> does not contain any regular file(s) or <em>dir</em> doesn't exist.
</li>
</ul>
......@@ -82,6 +82,6 @@
</pre>
<p>where <tt>/etc/66/conf</tt> directory contains two named files <tt>RUNDIR</tt> and <tt>CMD_ARGS</tt> written with <tt>/run/openntpd</tt> and <tt>-d -s</tt> respectively.</p>
<h2> limits</h2>
<p><em>dir</em> cannot exceed more than 100 files. Each file cannot contains more than 4095 bytes or more than 50 <em>key=value</em> pairs.</p>
<p><em>dir</em> cannot exceed more than 100 files. Each file cannot contain more than 4095 bytes or more than 50 <em>key=value</em> pairs.</p>
</body>
</html>
......@@ -18,7 +18,7 @@
<h1>execl-subuidgid</h1>
<p>
This command substitute a litteral GID UID term by the UID GID of the current owner of the process.
This command substitutes a litteral GID UID term by the UID GID of the current owner of the process.
</p>
......@@ -30,7 +30,7 @@
<ul>
<li>
<tt>execl-subuidgid</tt> reads the <em>command</em> and substitute the variable UID GID on <em>prog</em>.
<tt>execl-subuidgid</tt> reads the <em>command</em> and substitutes the variable UID GID on <em>prog</em>.
</li>
</ul>
......@@ -38,7 +38,7 @@
<ul>
<li>
<tt>-o&nbsp;<em>owner</em>&nbsp;</tt>: set UID GID of <em>owner</em> instead of the current one.
<tt>-o&nbsp;<em>owner</em>&nbsp;</tt>: sets UID GID of <em>owner</em> instead of the current one.
</li>
</ul>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment