From: Stephen L Johnson <sjohnson@monsters.org>
Date: Tue, 19 Dec 2000 21:11:30 +0000 (+0000)
Subject: added documentation on new %HUMANS 'group' attribute
X-Git-Tag: spong-2_7_2~28
X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1f14df83a316ba08d5c00c0bb4667ee7cf153d1f;p=spong.git

added documentation on new %HUMANS 'group' attribute
---

diff --git a/pod/spong.hosts.pod b/pod/spong.hosts.pod
index 0148a97..1d41ec3 100755
--- a/pod/spong.hosts.pod
+++ b/pod/spong.hosts.pod
@@ -111,6 +111,10 @@ teletouch pager number
 
 teletouch pager number for small alpha pagers
 
+=item * group
+
+A group of $HUMANS to contact.
+
 =back
 
 These attributes are messaging modules names for sending out notifications to
@@ -119,6 +123,29 @@ modules. The attributes listed above are the messaging modules that are part of
 the current Spong distribution.  New messaging modules can be easily be
 developed. See L<spong-message> and the L<developer-guide> for more details).
 
+The I<group> attribute designates a group contact. It is a string that holds a
+list of one or more %HUMANS entries seperated by spaces or comma. The
+L<spong-message> program will expand each entry in the I<group> attribute
+to a seperate contact in the current L<spong.message> file context. For
+example:
+
+ spong.hosts:
+   %HUMANS = ( 
+     'bob'   => { name => 'Bob Smith', email => 'bob@example.com', },
+     'ray'   => { name => 'Ray R.',    pager => '8145551234', }
+     'admins' => { name => 'Unix Admins', group => 'bob,ray' },
+   );
+
+ spong.message:
+   $MESSAGING_RULES = [
+     { hosts => ['dns.*'], services => ['dns'], 
+       contacts => [ { rcpts='admins', delay => 600, repeat=> 600 } ],
+     },
+   ]; 
+
+If the $MESSAGEING_RULES rule triggers, it will add 'bob' and 'ray' as contacts
+with attributes of 'delay => 600' and 'repeat => 600'.
+
 =head1 FORMAT
 
 The F<spong.conf> file is simply Perl code that gets imported by each spong