]> git.etc.gen.nz Git - spong.git/commitdiff
updated and corrected documenation. Added documenation for connection timeouts
authorStephen L Johnson <sjohnson@monsters.org>
Fri, 18 Feb 2000 20:35:45 +0000 (20:35 +0000)
committerStephen L Johnson <sjohnson@monsters.org>
Fri, 18 Feb 2000 20:35:45 +0000 (20:35 +0000)
www/docs/spong-server.html

index d563e10f241fb690f68af4506494f6e68c04a5e3..74bc7f264641caab688a9a97222cad86fd0cc1ff 100755 (executable)
@@ -25,28 +25,20 @@ spong clients (specifically the spong-network and various spong-client
 programs running). It takes the information reported by the various spong
 clients and does the following:
 <pre>
-&nbsp;&nbsp;&nbsp; * Check for valid messages, and discards any invalid ones.
-
-&nbsp;&nbsp;&nbsp; * If the message is something worth notifying someone about, it calls
-
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; the spong-message program and lets it determine how/if to contact&nbsp;
-
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; someone about the problem.
-
-&nbsp;&nbsp;&nbsp; * Check to see if the color of this message is different then it
-
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; used to be, and if so generate a history item indicating the change.
-
-&nbsp;&nbsp;&nbsp; * Save the information in the $SPONGSTATUS directory.
+    * Check for valid messages, and discards any invalid ones.
 
+    * If the message is something worth notifying someone about, it calls
+      the spong-message program and lets it determine how/if to contact
+      someone about the problem.
 
+    * Check to see if the color of this message is different then it
+      used to be, and if so generate a history item indicating the change.
 
+    * Save the information in the $SPONGDB directory.
 
+    * Answers database queries from Spong Interface Clients
 
 </pre>
-Each time a message comes in, a child process is forked off to handle the
-above tasks, while the main spong-server program goes back to waiting for
-more status reports.
 <p>You should start this program in your system startup file, and it should
 be running constantly. If you provide the --debug flag, then debugging
 information will be printed to stdout, otherwise output will only be produced
@@ -91,16 +83,29 @@ value is ``CHANGE'', then spong-message is only called when there is a
 change of state (going from green to red, and then again going from red
 to
 green). If its value is ``NONE'', then spong-message is never called.</dd>
-
+<p>
 <dt>
-<b>$SPONGPORT</b>, <b>$SPONGSTATUS</b>, <b>$SPONGHISTORY</b>, <b>$SPONGNOTES</b></dt>
+<b>$SPONG_UPDATE_PORT</b></dt>
 
 <dd>
-&nbsp;The port number that the server should be listening at, and some
-directory locations where status information, history information, and
-host specific documentation are kept.</dd>
+The port number that the server should be listening at for receiving update messages
+<P>
+<DT><B>$SPONG_QUERY_PORT</B>
+
+<DD>
+The port number that the server should be listening at for answering database queries from the various spong interface clients.
+<P>
+<DT><B>$SPONG_BB_UPDATE_PORT</B>
+<DD>The port that the server should be listeningat for receiving Big Brother status update messages. This is the Big Brother server emulation feature.
+<P>
+<DT><b>$SPONG_SPONG_ALARM</B>
+<DD>The is the amount of time (in seconds) a connection from a Spong Client to spong-server is allowed. After the timeout period
+elaspes the connection is closed.
+</DL>
+
+
 
-<br>
+<p><p>
 <hr WIDTH="100%">
 <h3>
 DATA&nbsp;MODULES</h3>
@@ -177,14 +182,16 @@ authentication to protect against bogus data.
 <hr>
 <h1>
 <a NAME="spong-server_see_0"></a>SEE ALSO</h1>
-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>,
-<i>spong.conf</i>
+the <i>spong-network</i> manpage , the <i>spong-client</i> manpage , the <i>spong-message</i> manpage ,
+<i>spong.hosts</i>, <i>spong.conf</i>
 <p>
 <hr>
 <h1>
-<a NAME="spong-server_author_0"></a>AUTHOR</h1>
-Ed Hill (<a href="MAILTO:ed-hill@uiowa.edu">ed-hill@uiowa.edu</a>), Unix
+<a NAME="spong-server_author_0"></a>AUTHORS</h1>
+<br>Stephen L Johnson (<a href="MAILTO:stephen.johnson@mail.state.ar.us">stephen.johnson@mail.state.ar.us</a>)
+or (<a href="MAILTO:sjohnson@monsters.org">sjohnson@monsters.org</a>),
+Unix System Administator, DIS - State of Arkansas
+<br>Ed Hill (<a href="MAILTO:ed-hill@uiowa.edu">ed-hill@uiowa.edu</a>), Unix
 System Administrator, The University of Iowa
 <p>Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong).
 </body>