From ff2b249abad73dae4df2e68c628a0d1684d29ec5 Mon Sep 17 00:00:00 2001 From: Stephen L Johnson Date: Thu, 14 Sep 2000 17:20:10 +0000 Subject: [PATCH] various documentation updates --- pod/spong-message.pod | 2 +- pod/spong.conf.pod | 4 ++-- pod/spong.message.pod | 33 +++++++++++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 3 deletions(-) diff --git a/pod/spong-message.pod b/pod/spong-message.pod index 794d27a..443f0dc 100644 --- a/pod/spong-message.pod +++ b/pod/spong-message.pod @@ -133,7 +133,7 @@ L for information on the file format. B alerts people via the messaging modules that are installed. New messaging functions can be easily created. See the L section in the I. +Modules|developer-guide/"MESSAGE MODULES"> section in the I. =head1 CONFIGURATION diff --git a/pod/spong.conf.pod b/pod/spong.conf.pod index 73594df..75d197e 100644 --- a/pod/spong.conf.pod +++ b/pod/spong.conf.pod @@ -233,7 +233,7 @@ must use the Reload/Refresh button on their web browser to update the Spong web pages. See the L 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 diff --git a/pod/spong.message.pod b/pod/spong.message.pod index ed2f68f..dd49a17 100755 --- a/pod/spong.message.pod +++ b/pod/spong.message.pod @@ -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 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: -- 2.30.2