
           README for G0LGS's events notification for XFBB 7.0+
           =======================================================

COPYRIGHT

The scripts/software in this package are Copyright (c) 2005 by Stewart
Wilkinson G0LGS.

Distribution and use of the scripts/software is permitted provided that
all copies retain the above copyright notice and the Warranty disclaimer
below

WARRANTY

THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

PURPOSE

To change / manage logon messages to show event information, such as
notification of Radio Club Meetings / other Events of interest to users.

Why Did I write this ?

Because at recent a meeting one member said "I have not been to many
meetings recently, because I don't get any reminder about the dates, like
I used to each time I logon to the BBS, so I tend not to know about them
until its too late".

REQUIREMENTS

	PERL

INSTALLATION

1. Check the Paths in the Makefile, if necessary edit $FBBCONF in 'events'
script to suit your sysytem configuration.

	make install

This will install the script to be run at each housekeeping.

2.	make install-cfg

This will copy the sample configuration file to /etc/ax25/fbb/events.cfg
and the sample messages to /etc/ax25/fbb/events .

3.	Edit /etc/ax25/fbb/events.cfg and the files in /etc/ax25/fbb/events
to suit your requirements (See below)

4.	Check /etc/ax25/fbb/events.cfg using:

	/usr/lib/fbb/tool/events -check /etc/ax25/fbb/events.cfg

THE CFG FILE (/etc/ax25/fbb/events.cfg)

The CFG file contains a line for each Event message you want to
display, each line tells the 'events' program what message(s) to
display to the user at login (it creates a 'english.ent' file
in /etc/ax25/fbb/lang ).

Each line the file contains 4 or 5 parameters:

The 1st is the DATE of the Event in the format:

	YYYY/MM/DD

The 2nd is the TIME (24 Hour Clock) of the Event in the format:

	HH:MM

The 3rd is a filename which contains the message to be displayed
(See MESSAGE FILES for special Parameters that may be included
in the message).

The 4th is the number of days before the start of the event
when the message is to first appear.

The optional 5th parameter is the number of days after the
event for which the message will remain.

The sample file includes 2 lines:

#
# Public Holidays
#
2005/12/25	00:00	xmas.txt	2	1
2006/01/01	00:00	nyear.msg	0	10

Which will cause the program to include in the BBS logon message:

1. The 'xmas' message from 23 Dec 2005 to 27 Dec 2005.
2. The 'nyear' message from 1 Jan 2006 to 11 Jan 2006.

Actually the messages appear only between the Housekeeping session on
these dates, which means if you run housekeeping before 23:59 you may need
to adjust the 4th and 5th parameters to display the messages on the
correct days.

MESSAGE FILES

The Message files have the following special sequences which are replaced
with the values indicated:

	@DATE@		The Date of the start if the event in the
			format 'Sun 20 Feb 2005'
	@TIME@		The Time of the Event HH:MM
	@CALL@		BBS Callsign
	@SYSOP@		Sysop Callsign

	@HH@ 		Hour (24 Clock)
	@MM@ 		Minute

	@DD@ 		Day of Month (1-31) - 1, 2, 3
	@DDD@ 		Day of Month (1-31) - 1st, 2nd, 3rd
	@DAY@ 		Day of Week (short) - Mon
	@DOWK@ 		Day of Week (full)  - Monday

	@MN@ 		Month of Year (1-12)
	@MON@ 		Month of Year (short) - Jan
	@MONTH@ 	Month of Year (full)  - January

	@YY@ 		2 Digit Year - 05
	@YYYY@		4 Digit Year - 2005

---
Stewart G0LGS
