]> git.etc.gen.nz Git - spong.git/commitdiff
various documentation updates
authorStephen L Johnson <sjohnson@monsters.org>
Thu, 14 Sep 2000 17:20:10 +0000 (17:20 +0000)
committerStephen L Johnson <sjohnson@monsters.org>
Thu, 14 Sep 2000 17:20:10 +0000 (17:20 +0000)
pod/spong-message.pod
pod/spong.conf.pod
pod/spong.message.pod

index 794d27a03138f28e8d28475015c3a56a0c049a3c..443f0dc46c9f5c6df3be1198f9f3fbb018ce8385 100644 (file)
@@ -133,7 +133,7 @@ L<spong.message/"MESSAGE TEMPLATES"> for information on the file format.
 
 B<spong-message> alerts people via the messaging modules that are installed.
 New messaging functions can be easily created.  See the L<Message
-Modules|developer-guide/"Messaging Modules"> section in the I<Developer Guide>.
+Modules|developer-guide/"MESSAGE MODULES"> section in the I<Developer Guide>.
 
 =head1 CONFIGURATION
 
index 73594df58c8a538298e5b47e16558e7daa34260e..75d197ea512c64369cafe372ab79dcb9fef263b4 100644 (file)
@@ -233,7 +233,7 @@ must use the Reload/Refresh button on their web browser to update the Spong web
 pages.  See the L<admin-guide/"$WWW_REFRESH Logic"> for more
 details.
 
-=item @WWWCONTACT
+=item $WWWCONTACT
 
 This is a partial URL to a CGI script that can do paging for systems. If it is
 used a "Contact" link will appear on Tool Bar on Spong Web Displays. Refer to
@@ -340,7 +340,7 @@ host by host basis.
 
 =over 
 
-=item $MESSAGE_PER_HOUR
+=item $MESSAGES_PER_HOUR
 
 This is the maximum number of messages that are sent to the same person
 in an hour. All message past this number are just logged to the history
index ed2f68f68ae2d974f96f097158e68b294606646d..dd49a17f2c22bd2afa25a66953d3503fd72173a7 100755 (executable)
@@ -9,6 +9,39 @@ for notifications. The rules consist of attributes which define criteria
 which events are matched against and a list of contacts to notify if all
 of the matching criteria are met.
 
+=head1 CONFIGURATION VARIABLES
+
+=head2 $RULES_MATCH
+
+The variable governs the matching rules are processed. The possible values
+are 'OLD', 'FIRST-MATCH', or 'ALL'.
+
+=over 8
+
+=item OLD
+
+This cause B<spong-message> to use the notification logical from Spong 2.1.
+This is intended an aid in migrating a Spong 2.1 installation to Spong 2.5
+and above. The existing notification scheme can be used until new messaging
+rules are developed and debugged.
+
+This functionality will be removed at some point in the future.
+
+=item FIRST-MATCH
+
+This value causes the rules matching engine to stop after the first successful
+match. The matching rule is processed, and then the spong-message program 
+terminates.
+
+=item ALL
+
+This values causes the rules matching engine to scan all rules. It will
+process all successful matches.
+
+=back
+
+=head2 $MESSAGING_RULES
+
 Each rule should have more of more of the following matching 
 terms: