doc/html: roverlay-status script

1 files changed, 50 insertions, 9 deletions

diff --git a/doc/html/usage.html b/doc/html/usage.html
index 54ddc38..c00960a 100644
--- a/doc/html/usage.html
+++ b/doc/html/usage.html
@@ -1035,7 +1035,8 @@ most cases, but fine-tuning can be done via <a class="reference internal" href="
 </div>
 <div class="section" id="roverlay-helpers">
 <h2><a class="toc-backref" href="#contents">3.4&nbsp;&nbsp;&nbsp;roverlay helpers</a></h2>
-<p>An installation of roverlay includes some helper programs:</p>
+<p>An installation of roverlay includes some helper programs, most of them
+can also be found in <tt class="docutils literal">&lt;R overlay src <span class="pre">directory&gt;/bin/</span></tt>:</p>
 <dl class="docutils">
 <dt><em>roverlay-sh</em></dt>
 <dd><p class="first">a wrapper around /bin/sh that runs a shell or shell script in roverlay's
@@ -1072,6 +1073,37 @@ removes a hook (referenced by name) from one or more (or all) <em>events</em></l
 </li>
 </ul>
 </dd>
+<dt><em>roverlay-status</em></dt>
+<dd><p class="first">A script that generates status reports based on <a class="reference external" href="http://www.makotemplates.org/">mako templates</a>
+and roverlay's stats (<a class="reference internal" href="#stats-db-file">STATS_DB_FILE</a>). Supported output formats include
+html, cgi (html with cgi header) and plain text.</p>
+<p>Notable options accepted by <em>roverlay-status</em>:</p>
+<table class="docutils option-list" frame="void" rules="none">
+<col class="option" />
+<col class="description" />
+<tbody valign="top">
+<tr><td class="option-group" colspan="2">
+<kbd><span class="option">--output <var>&lt;file|&quot;-&quot;&gt;</var></span>, <span class="option">-O <var>&lt;file|&quot;-&quot;&gt;</var></span></kbd></td>
+</tr>
+<tr><td>&nbsp;</td><td>output file/stream, defaults to stdout (&quot;-&quot;)</td></tr>
+<tr><td class="option-group" colspan="2">
+<kbd><span class="option">--template <var>&lt;file|name&gt;</var></span>, <span class="option">-t <var>&lt;file|name&gt;</var></span></kbd></td>
+</tr>
+<tr><td>&nbsp;</td><td>name of or path to the mako template file. A <tt class="docutils literal"><span class="pre">--mode</span></tt> specific
+file extension is automatically appended when searching for the template
+file.</td></tr>
+<tr><td class="option-group" colspan="2">
+<kbd><span class="option">--mode <var>&lt;&quot;cli&quot;|&quot;cgi&quot;|&quot;html&quot;&gt;</var></span></kbd></td>
+</tr>
+<tr><td>&nbsp;</td><td>Sets the output format. Defaults to <em>cli</em> (plain text).</td></tr>
+<tr><td class="option-group" colspan="2">
+<kbd><span class="option">--config <var>&lt;file&gt;</var></span>, <span class="option">-c <var>&lt;file&gt;</var></span></kbd></td>
+</tr>
+<tr><td>&nbsp;</td><td>Path to roverlay's main config file.</td></tr>
+</tbody>
+</table>
+<p class="last">See <tt class="docutils literal"><span class="pre">roverlay-status</span> <span class="pre">--help</span></tt> for a full listing.</p>
+</dd>
 <dt><em>run-roverlay.sh</em></dt>
 <dd><p class="first">A script that safely runs overlay creation and repoman afterwards.
 Uses filesystem locks to ensure that it is run at most once at a time.
@@ -3095,15 +3127,24 @@ the distmap file.</p>
 </dl>
 <dl class="docutils" id="stats-db-file">
 <dt>STATS_DB</dt>
-<dd><p class="first">Path to the stats database file. This has to be a round-robin database
-file (rrdtool). <em>roverlay</em> creates it if necessary.</p>
-<p class="last">Defaults to &lt;not set&gt;, which disable database writing.</p>
+<dd><p class="first">Path to the stats database file. <em>roverlay</em> creates it if necessary.</p>
+<p class="last">Defaults to &lt;not set&gt;, which disables database writing.</p>
 </dd>
-<dt>STATS_INTERVAL</dt>
-<dd><p class="first">Database update interval, which should be set to the expected timespan
-between running overlay creation, in seconds. Only meaningful when
-creating a new database file.</p>
-<p class="last">Defaults to 7200 (2 hours).</p>
+</dl>
+<dl class="docutils" id="template-root">
+<dt>TEMPLATE_ROOT</dt>
+<dd><p class="first">List of directories with templates for generating status reports.</p>
+<p><em>/usr/share/roverlay/mako_templates</em> is automatically added to this list
+if roverlay has been installed.</p>
+<p>This option is <strong>required</strong> for <em>roverlay-status</em>, but doesn't need to be
+set if roverlay has been installed.</p>
+<p class="last">Defaults to &lt;not set&gt;.</p>
+</dd>
+</dl>
+<dl class="docutils" id="template-module-dir">
+<dt>TEMPLATE_MODULE_DIR</dt>
+<dd><p class="first">Directory for caching mako templates.</p>
+<p class="last">Defaults to <a class="reference internal" href="#cachedir">CACHEDIR</a>/mako_templates.</p>
 </dd>
 </dl>
 <dl class="docutils" id="distfiles">