document update

diff --git a/www/docs/spong_conf.html b/www/docs/spong_conf.html
index 2d892a67ce69dc1770aeb93647d06bc177749af7..c1d7bbc20b9448ebcb1050fb77562bcbc480b489 100755 (executable)
--- a/www/docs/spong_conf.html
+++ b/www/docs/spong_conf.html
@@ -110,13 +110,12 @@ updates. This spong-server only provides partial Big Brother emulation
 at present. It will only understand status updates,</dd>
 
 <dt>
-<a NAME="status-history"></a><b>$STATUS_HISTORY</b></dt>
-
-<dd>
-This flag is used to enable status updates to keep in the History. If active,
-any status update that generated a History event will be store with the
-event.&nbsp; This option can potentially generate a large amount of file
-data. The file system then the $SPONGDB resides should have a large capacity.</dd>
+<b>$SPONG_SERVER_ALARM</b></dt>
+<DD>
+This is the maximum amount of time (in seconds) that Spong Client can stay
+connected to the Spong Server status update ports. Set the value to '0' to
+disable the timeout.
+</DD>
 
 <dt>
 <a NAME="www-user-images"></a><b>$WWW_USE_IMAGES</b></dt>
@@ -177,18 +176,17 @@ staff. www-spong will generate "smart" links depending on the web page
 being displayed. for more information on this feature, please see the <a href="admin-guide.html#custom-contacts">Administrator
 Guide</a>.</dd>
 
-<dt>
-<a NAME="custom-actionbar"></a><b>$WWW_ACTIONBAR_CUSTOM</b></dt>
+<dt><A NAME="custom-actionbar"></a><b>$WWW_ACTIONBAR_CUSTOM<b>
 
 <dd>
-This parameter can be used to customize the Host/Service displays Action
-Bar of the Web Interface. Any HTML code in this parameter will be included
-on the Web Pages when they are displayed. This parameter is preprocessed
-by
-<i>eval</i>'ed before the contents is printed. Your can include complex
+This parameter can be used to customize the Host/Service displays Action Bar
+of the Web Interface. Any HTML code in this parameter will be included on
+the Web Pages when they are displayed. This parameter is preprocessed by
+<I>eval</i>'ed before the contents is printed. Your can include complex
 perl variables and simple Perl code in this parameter. NOTE: Use single
-quoted to enclose the parameter contents to prevent premature expansion
-of any perl variables defined.</dd>
+quoted to enclose the parameter contents to prevent premature expansion of
+any perl variables defined.
+</dd>
 
 <dt>
 <a NAME="www-refresh-allow"></a><b>@WWW_REFRESH_ALLOW</b></dt>
@@ -197,7 +195,7 @@ of any perl variables defined.</dd>
 A list of Perl regular expressions that are checked against the REMOTE_ADDR,
 REMOTE_HOST and REMOTE_USER enviornmental CGI varables. If there is a match
 on any of these variables, <i><a href="www-spong.html">www-spong </a></i>will
-attach a REFRESH meta tag to reload the web pages every <a href="#spongsleep">$SPONGSLEEP</a>
+attach a REFRESH meta tag to reload the web pages every <b><a href="#spongsleep">$SPONGSLEEP</a></b>
 seconds. See the <a href="admin-guide.html#autorefresh">Administrator Guide</a>
 for more details.</dd>
 
@@ -215,37 +213,35 @@ Guide</a> for more details.</dd>
 <br>&nbsp;</dl>
 
 <hr>
-<h1>
-<a NAME="spong-cleanup"></a><b>SPONG CLEANUP VARIABLES</b></h1>
+<h1><a name="spong-cleanup"></a>SPONG CLEANUP VARIABLES
 
 <dl>
-<dt>
-<b>$SPONG_ARCHIVE</b></dt>
+<dt><b>$SPONG_ARCHIVE</b>
 
 <dd>
-The directory where to put old history file entries for each host. Each
-host have it's own file in this directory</dd>
+The directory where to put old history file entries for each host. Each host have it's own file in this directory
+</dd>
 
-<dt>
-<b>$OLD_HISTORY</b></dt>
+<dt><b>$OLD_HISTORY</b>
 
-<dd>
-This is the number of days of history to keep for each host in the spong-server
-database. Any old history is append to the file for the host under the
-$SPONG_ARCHIVE directory.></dd>
+<dd>This is the number of days of history to keep for each host in the
+spong-server database. Any old history is append to the file for the host under
+the <b>$SPONG_ARCHIVE</b> directory.
+</dd>
 
-<dt>
-<b>$OLD_SERVICE</b></dt>
+<dt><b>$OLD_SERVICE<b>
 
-<dd>
-This is the number of days to retain stale service status (i.e. purple
+<dd>This is the number of days to retain stale service status (i.e. purple
 status) entries in the spong-server database. Any service service status
-entries older than $OLD_SERVICE days old are deleted from the database.</dd>
+entries older than <b>$OLD_SERVICE</b> days old are deleted from the
+database.
+</dd>
+
 </dl>
 
 <hr>
 <h1>
-<a NAME="service-threshold"></a><b>SERVICE THRESHOLD VARIABLES</b></h1>
+<a NAME="service-threshold"></a>SERVICE THRESHOLD VARIABLES</h1>
 
 <dl>
 <dt>
@@ -258,30 +254,31 @@ having ``:'' in this list will cause NFS file system mounts to be ignored.</dd>
 
 <br>&nbsp;
 <dt>
-<b>%DFWARN, %DFCRIT</b></dt>
+<b>%DFWARN</b>, <b>%DFCRIT</b></dt>
 
 <dd>
-A hash of file systems (or the word ``ALL''), and the percentage that should
-trigger a problem (%DFWARN triggers warnings - yellow, and %DFCRIT triggers
-alerts - red). If a file system is not explicitly listed in this hash then
-it will fall back to the value of the ``ALL'' entry.</dd>
+&nbsp;A hash of file systems (or the word ``ALL''), and the percentage
+that should trigger a problem (<b>%DFWARN</b> triggers warnings - yellow,
+and <b>%DFCRIT</b> triggers alerts - red). If a file system is not explicitly
+listed in this hash then it will fall back to the value of the ``ALL''
+entry.</dd>
 
 <br>&nbsp;
 <dt>
-<b>$CPUWARN, $CPUCRIT</b></dt>
+<b>$CPUWARN</b>, <b>$CPUCRIT</b></dt>
 
 <dd>
-A number indicating the CPU load that triggers a problem ($CPUWARN triggers
-warnings - yellow, and $CPUCRIT triggers alerts - red).</dd>
+&nbsp;A number indicating the CPU load that triggers a problem (<b>$CPUWARN</b>
+triggers warnings - yellow, and <b>$CPUCRIT</b> triggers alerts - red).</dd>
 
 <br>&nbsp;
 <dt>
-<b>@PROCSWARN, @PROCSCRIT</b></dt>
+<b>@PROCSWARN</b>, <b>@PROCSCRIT</b></dt>
 
 <dd>
-A list of processes that should be running, if they are not running, then
-trigger a problem (processes in @PROCSWARN trigger a warning - yellow,
-and processes in @PROCSCRIT trigger an alert - red).</dd>
+&nbsp;A list of processes that should be running, if they are not running,
+then trigger a problem (processes in <b>@PROCSWARN</b> trigger a warning
+- yellow, and processes in <b>@PROCSCRIT</b> trigger an alert - red).</dd>
 
 <br>&nbsp;
 <dt>
@@ -289,45 +286,47 @@ and processes in @PROCSCRIT trigger an alert - red).</dd>
 
 <dd>
 A list of hashes which defined checks to apply to log files. Each hash
-contains the fields logfile which is the full path to the log file to check
-and checks whch&nbsp; is a list of check to apply to the log file. Each
-check is a hash that contains the fields: pattern - a Perl regular expression
-to be scanned for, status - the status color to reported lines matching
-pattern, duration - the duration that each event is to be reported to the
-server, text - the text to reported back in the detailed message field
-of the status report (which can include match position variables from pattern)
-and id - an optional key field to associated with each event generated.&nbsp;
-See the <i><a href="check_logs.html">check_logs</a></i> documentation for
-more information and examples.</dd>
+contains the fields <b>logfile</b> which is the full path to the log file
+to check and <b>checks</b> whch&nbsp; is a list of check to apply to the
+log file. Each check is a hash that contains the fields: <b>pattern</b>
+- a Perl regular expression to be scanned for, <b>status</b> - the status
+color to reported lines matching pattern, duration - the duration that
+each event is to be reported to the server, <b>text </b>- the text to reported
+back in the detailed message field of the status report (which can include
+match position variables from <b>pattern</b>) and <b>id</b> - an optional
+key field to associated with each event generated.&nbsp; See the <i><a href="check_logs.html">check_logs</a></i>
+documentation for more information and examples.</dd>
 
 <br>&nbsp;
 <dt>
-<b>%HTTPDOCS, %HTTPPORT</b></dt>
+<b>%HTTPDOCS</b>, <b>%HTTPPORT</b></dt>
 
 <dd>
 These variables provide some parameters when checking http based servers.
-The %HTTPDOCS variable is keyed by host (or the string ``ALL'' for all
-hosts), and contains as a value, a list of documents to check on that host.
-The default setting is to search for the ``/robots.txt'' file on all hosts.</dd>
+The <b>%HTTPDOCS</b> variable is keyed by host (or the string ``ALL'' for
+all hosts), and contains as a value, a list of documents to check on that
+host. The default setting is to search for the ``/robots.txt'' file on
+all hosts.</dd>
 
 <dd>
-The %HTTPPORT variable contains the port number that web server on a given
-host is running on. By default the value is 80, but this can be overridden
-on a host by host basis</dd>
+The <b>%HTTPPORT</b> variable contains the port number that web server
+on a given host is running on. By default the value is 80, but this can
+be overridden on a host by host basis</dd>
 
 <br>&nbsp;
 <dt>
 <a NAME="spong.conf_send_message_0"></a><b>$SEND_MESSAGE</b></dt>
 
 <dd>
-$SEND_MESSAGE defines when spong-message is called by spong-server. This
-variable can contain one of four valid values. If it is ``RED'', then spong-message
+$SEND_MESSAGE defines when <b>spong-message</b> is called by spong-server.
+This variable can contain one of four valid values. If it is ``RED'', then
+<b>spong-message</b>
 is called for every time a system or service reports a problem. If its
-value is ``CHANGE'', then spong-message is only called when there is a
-change of state . If this values is "RED-CHANGE", then spong-message is
-called&nbsp; everytime a system of service reported a problem and when
+value is ``CHANGE'', then <b>spong-message</b> is only called when there
+is a change of state . If this values is "RED-CHANGE", then <b>spong-message</b>
+is called&nbsp; everytime a system of service reported a problem and when
 the condition is cleared. (going from green/yellow to red, and then again
-going from red to green/yellow). If its value is ``NONE'', then spong-message
+going from red to green/yellow). If its value is ``NONE'', then <b>spong-message</b>
 is never called.</dd>
 
 <br>&nbsp;
@@ -352,11 +351,12 @@ person in an hour. The default value is 3.</dd>
 
 <hr>
 <h1>
-<a NAME="spong.conf_os_0"></a><b>OS SPECIFIC VARIABLES</b></h1>
+<a NAME="spong.conf_os_0"></a>OS SPECIFIC VARIABLES</h1>
 
 <dl>
 <dt>
-<b>$DF, $UPTIME, $PS, $GREP, $PING, $TRACEROUTE, $MAILQ</b></dt>
+<b>$DF</b>, <b>$UPTIME</b>, <b>$PS</b>, <b>$GREP</b>, <b>$PING</b>, <b>$TRACEROUTE,
+$MAILQ</b></dt>
 
 <dd>
 These variables are OS specific variables, which are hopefully set correctly
@@ -366,7 +366,7 @@ what OS you are running on, and what the correct value should be.</dd>
 
 <hr>
 <h1>
-<a NAME="spong.conf_functions_0"></a><b>FUNCTIONS</b></h1>
+<a NAME="spong.conf_functions_0"></a>FUNCTIONS</h1>
 DEPRECIATED:&nbsp; <i><a href="spong-client.html">spong-client</a></i>
 checks are now modules. See <a href="developer-guide.html#client-modules">Client
 Modules</a> in the <a href="developer-guide.html">Developer Guide</a> documentation.
@@ -406,7 +406,7 @@ mail queue is not getting too large.
 
 <hr>
 <h1>
-<a NAME="files"></a><b>FILES</b></h1>
+<a NAME="files"></a>FILES</h1>
 
 <dl>
 <dt>
@@ -431,16 +431,16 @@ first, and then if it can not find it - it looks for the shorter name.</dd>
 
 <hr>
 <h1>
-<a NAME="spong.conf_see_0"></a><b>SEE ALSO</b></h1>
+<a NAME="spong.conf_see_0"></a>SEE ALSO</h1>
 the <i>perl</i> manpage , the <i>spong-server</i> manpage , the <i>spong-network</i>
 manpage , the <i>spong-client</i> manpage , the <i>spong-display</i> manpage
 , the <i>spong-message</i> manpage , <i>spong.hosts</i>
 <p>
 <hr>
 <h1>
-<a NAME="author"></a><b>AUTHOR</b></h1>
+<a NAME="author"></a>AUTHOR</h1>
 Ed Hill (<a href="MAILTO:ed-hill@uiowa.edu">ed-hill@uiowa.edu</a>), Unix
-System Administrator, The University of Iowa&lt;
+System Administrator, The University of Iowa
 <br>Stephen L Johnson (stephen.johnson@mail.state.ar.us) or (sjohnson@monsters.org),
 Unix System Administator, DIS - State of Arkansas
 <p>Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong).