
+-----------------------------------------------------------------------------+
| Synchronet Caller Stats, Ver 1.0  Copyright 2007 Philip Brown              |
+-----------------------------------------------------------------------------+

This program was written to read the Synchronet log files and create a bulletin
showing daily, monthly, and yearly BBS usage.

This program was written to run on MSDOS and Windows platforms.  It has been tested
on Windows XP Home edition and Windows 98 SE.

Below is a example of the DAILY.ASC file it creates.

   +-----------------------------------+
   :       BBS Usage for 05/26/07      :
   :     +------------------------+    :
   :     :012345678901234567890123:    :
   :     :   *     **** * *   * * :    :
   :     +------------------------+    :
   : +-------------+ +---------------+ :
   : :File Usage:  : :Node Usage:    : :
   : :  D/L: 2     : : Node 1: 20    : :
   : :  U/L: 0     : : Node 2: 1     : :
   : +-------------+ : Node 3: 0     : :
   : +-------------+ : Node 4: 0     : :
   : :Doors Usage: : : Node 5: 0     : :
   : : Used: 6     : +---------------+ :
   : +-------------+ +---------------+ :
   : +-------------+ :Echomail Usage:+ :
   : :E-Mail Usage:: : Posted: 1     : :
   : : Read: 6     : : QWK DL: 1     : :
   : : Sent: 5     : : QWK UL: 0     : :
   : +-------------+ +---------------+ :
   +[SyncStat v1.0 Philip Brown @ 2007]+

FILES USED BY THIS PROGRAM:

SYNCSTAT.EXE	Program used to create bulletins.
SETUP.EXE       Program used to setup bulletin paths, colors.
SETUP.DBF       Data file used to store program information.
TEMP.DBF        Temporary file used to read log file.
SYNCSTAT.DBF    Temporary file used to process log file.
BULLETIN.DBF    Temporary file used to write bulletins.
DAILY.BAT       Batch file to use when setting up a event.
EVENT.BAT       Batch file to use when setting up a event.

FILES CREATED BY THIS PROGRAM:

DAILY.ASC 	.ASC Bulletin created by SYNCSTAT Program.
DAILY.ANS       .ANS Bulletin created by SYNCSTAT Program.
MONTHLY.ASC 	.ASC Bulletin created by SYNCSTAT Program.
MONTHLY.ANS     .ANS Bulletin created by SYNCSTAT Program.
YEARLY.ASC 	.ASC Bulletin created by SYNCSTAT Program.
YEARLY.ANS      .ANS Bulletin created by SYNCSTAT Program.
LOCKED.MEM      Temporary file used by SYNCSTAT Program.

EXECUTING THE PROGRAM:

Step 1:

Run the setup.exe program and you will see four menu choices:

1) Log Path                      Path of the log file.

2) Bulletin Path                 Path of the bulletin it creates.

3) Bulletin Color Selection      Menu with three boxes (Daily, Monthly, Yearly)

        After you select one of the three boxes, you will be given a
        selection of color choices.  Using your arrow keys, move to the desired
        color and press enter to make your choice. An example is displayed
        at the top of the screen as you try the colors.  When you're satisfied,
        select 'Exit Color Selector' and move to the next box and repeat the
        process.  When you're finished, select 'Exit Color Selection' and you
        will return to the menu.

4)Exit Setup Program             Exit Program.

        Before exiting, check the values and colors you have selected.


Step 2:

Run the syncstat.exe program. It will read the setup data file for the
information it needs to process the log and create both ASCII and ANSI
bulletins.


If you run the syncstat.exe program without running setup.exe, you will get
the following error:

Error:
  Please Run Setup.exe To Configure Program.


Once you have run the setup program and given it the information it needs, then
run syncstat.exe again and it will read the setup information and process the
log and create both ASCII and ANSI bulletins.

The syncstat program has three command line options you can use:

  syncstat daily       This will create a bulletin based on daily BBS usage.

  syncstat monthly     This will create a bulletin based on monthly BBS usage.

  syncstat yearly      This will create a bulletin based on yearly BBS usage.


MODIFYING BULLSEYE.CFG/BULLSEYE.ASC:

To show the new bulletin, you will need to modify the BULLSEYE.CFG file located
in the sbbs\text folder.

For Example:

0
../text/system.msg
../text/newuser.msg
../text/sbbs.msg
../docs/dove-net.txt
c:/sbbs/syncstat/daily.ans  (change path to reflect bulletin location)
c:/sbbs/syncstat/monthly.ans(change path to reflect bulletin location)
c:/sbbs/syncstat/yearly.ans (change path to reflect bulletin location)



Then modify the BULLSEYE.ASC file in the sbbs\text folder.

For Example:

l0nc4k0
4c  hyBulletins  nk40
4ckb0

 hy1 ngStatistics for h@BBS-L....................................@nb
 hy2 ngNew user instructions                                     b
 hy3 ngAbout this version of Synchronet BBS Software             b
 hy4 ngWhat is DOVE-Net?                                         b
 hy5 ngDaily BBS Statistics for h@BBS-L..........................@nb
 hy6 ngMonthly BBS Statistics for h@BBS-L........................@nb
 hy7 ngYearly BBS Statistics for h@BBS-L.........................@nb
n


LOGON/TIMED EVENTS:

You should set up a timed event to run syncstat for you.

You can set up a event to run when users log on or log off, or you can create
an event to run any time you would like.  Bulletins created using logon/logoff
events will not include current log data for that user because the log data
is not written to the log until the logon/logoff event is finished.


Below is an example of a logoff event.

+[][?]----------------------------------------------------------------+
 Logout Event: c:\sbbs\syncstat\daily.bat                             
+----------------------------------------------------------------------+

You can create a batch file as shown below. (Change paths to match your BBS)

	cd\sbbs\syncstat
	syncstat daily
	cd\


Below is an example of a timed event.

+[][?]--------------------------------------------------------------+
                          EVENT Timed Event                         
--------------------------------------------------------------------
 Internal Code                   EVENT                             
 Start-up Directory              c:\sbbs\syncstat                  
 Command Line                    event.bat                         
 Enabled                         Yes                               
 Execution Node                  4                                 
 Execution Days of Month         Any                               
 Execution Days of Week          All                               
 Execution Frequency             6 times a day                     
 Requires Exclusive Execution    No                                
 Force Users Off-line For Event  No                                
 Native (32-bit) Executable      No                                
 Use Shell to Execute            No                                
 Background Execution            Yes                               
 Always Run After Init/Re-init   No                                
+--------------------------------------------------------------------+

You can create a batch file as shown below. (change paths to match your BBS)

	cd\sbbs\syncstat
	syncstat monthly
	syncstat yearly
	cd\


CONTACT INFORMATION:

+-----------------------------------------------------------------------------+
     By Philip Brown  The Flaming Star BBS  http://www.flamingstar.com     
+-----------------------------------------------------------------------------+

    Email: pbmountaincat@flamingstar.no-ip.info
   TELNET: telnet://flamingstar.no-ip.info
   TELNET: telnet://flamings.synchro.net
      FTP: ftp://flamingstar.no-ip.info
      WWW: http://www.flamingstar.com

NOTES:

If you like this program, or have a suggestion, please send me an email.

Thanks,
Philip Brown aka Pbmountaincat
The Flaming Star BBS
