From 0704a4435a207c4059699565cfda3a4ea5136455 Mon Sep 17 00:00:00 2001 From: André Erdmann Date: Mon, 23 Sep 2013 15:27:01 +0200 Subject: doc/html: roverlay-status script --- doc/html/usage.html | 59 +++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 50 insertions(+), 9 deletions(-) (limited to 'doc') 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

3.4   roverlay helpers

-

An installation of roverlay includes some helper programs:

+

An installation of roverlay includes some helper programs, most of them +can also be found in <R overlay src directory>/bin/:

roverlay-sh

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) events

+
roverlay-status
+

A script that generates status reports based on mako templates +and roverlay's stats (STATS_DB_FILE). Supported output formats include +html, cgi (html with cgi header) and plain text.

+

Notable options accepted by roverlay-status:

+ +++ + + + + + + + + + + + + + +
+--output <file|"-">, -O <file|"-">
 output file/stream, defaults to stdout ("-")
+--template <file|name>, -t <file|name>
 name of or path to the mako template file. A --mode specific +file extension is automatically appended when searching for the template +file.
+--mode <"cli"|"cgi"|"html">
 Sets the output format. Defaults to cli (plain text).
+--config <file>, -c <file>
 Path to roverlay's main config file.
+

See roverlay-status --help for a full listing.

+
run-roverlay.sh

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.

STATS_DB
-

Path to the stats database file. This has to be a round-robin database -file (rrdtool). roverlay creates it if necessary.

-

Defaults to <not set>, which disable database writing.

+

Path to the stats database file. roverlay creates it if necessary.

+

Defaults to <not set>, which disables database writing.

-
STATS_INTERVAL
-

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.

-

Defaults to 7200 (2 hours).

+
+
+
TEMPLATE_ROOT
+

List of directories with templates for generating status reports.

+

/usr/share/roverlay/mako_templates is automatically added to this list +if roverlay has been installed.

+

This option is required for roverlay-status, but doesn't need to be +set if roverlay has been installed.

+

Defaults to <not set>.

+
+
+
+
TEMPLATE_MODULE_DIR
+

Directory for caching mako templates.

+

Defaults to CACHEDIR/mako_templates.

-- cgit v1.2.3-65-gdbad