home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / WILDCAT / CATS50AU.ZIP / CATSTAT.DOC < prev    next >
Text File  |  1994-02-19  |  10KB  |  232 lines
  1.  ---------------------------------------------------------------------------
  2.                                CATSTAT 5.0a (c)
  3.                     Wildcat! Activity Log Viewer/Analyzer
  4.                       Copyright (c) 1992 by Alan Monaghan
  5.                              All Rights Reserved
  6.                                    02/15/1994
  7.                              Author: Alan G. Monaghan
  8.  ---------------------------------------------------------------------------
  9.  
  10.                                    Purpose
  11.                                    -------
  12.  Catstat was written out of my own need for a tool to assist with creating
  13.  statistics from the activity log of my BBS. I wanted something also that
  14.  would list the names of the doors and the number of times they each were
  15.  entered.
  16.  I followed the format of the WCPRO utilities output, but cut it down a bit
  17.  to the things I wanted to know quickly. That is why they look so similar.
  18.  
  19.                                    Instructions
  20.                                    ------------
  21.  
  22.  1) Create a subdirectory for Catstat (MD T:\CATSTAT). Catstat must be run
  23.     from this subdirectory since it does not look down the PATH variable
  24.     for its configuration files.
  25.  
  26.  2) Copy all of the files from this Zip into that SubDirectory.
  27.  
  28.  3) Create a file called Catstat.cfg using the exact form below without the
  29.     comments.
  30.  
  31.  4) Delete the CatStat.His file that comes w/ this copy.
  32.  
  33.  5) Run Catstat /i from the Command Line to create a fresh copy of the
  34.     History File
  35.  
  36.  6) Set up Catstat to run from a batch file after each call.
  37.  
  38.  7) Insert a Line in your Nightly Maintenance Saying : Catstat /M
  39.  
  40. (*Note*)
  41.  Because of the History file that is kept, some stats may need to be inserted
  42.  or edited to show the true numbers. What I suggest is that you create a config
  43.  file that temporarily points to an Old Activity log with as much history as you
  44.  have. Run the Catstat /M and this will insert these into the calls per hour and
  45.  the calls per day variables. You can then edit the CatStat.His to reflect the
  46.  actual numbers. Please remember, the calls per hour grand total much match the
  47.  calls per day grand total or the information will be useless.
  48.  
  49.  
  50.  
  51.  That is all there is to it. Now for some of the small details.
  52.  
  53.  I have not included any tests for Today's date in the code. I am using
  54.  Lopper v3.0 to cut my logs down to size each night with the Maintenance
  55.  batch file that runs once a night.
  56.  
  57.  The code also assumes that all of the Activity Logs exist and doesn't test
  58.  for their existence, it just gives an error and bombs.
  59.  
  60.  The maximum number of Nodes is 255.
  61.  
  62.  The maximum number of Doors is 100.
  63.  
  64.  This version is only compatible with Wildcat v3.xx and Greater
  65.  
  66.  
  67.                       An example of the Catstat.cfg
  68.                       ----------------------------
  69.  
  70.   The Kingdom of Cormac mac Airt    <- Can be up to 63 characters in Length, Your BBs
  71.       -- Note: No Space Here --            Name, an ad, really anything you want..
  72.   3                                 <- The Number of Nodes Present
  73.   T:\WC30\ACTIVITY.001              <- The name and path to the 1st node's Activity Log
  74.   T:\WC30\ACTIVITY.002
  75.   T:\WC30\ACTIVITY.003
  76.   T:\WC30\WCPRO.BBS                 <- The name and full path of the OutPut file
  77.   23                                <- The Total Number of Doors
  78.   Add a Quote                       <- The Names of the Doors in the Order they
  79.   Esterian Conquest IV                     appear in the doors.bbs
  80.   Esterian Conquest - New -         <- Door3
  81.   Esterian Conquest III             <- Door4
  82.   Global Wars                       <- Door5
  83.   The Pit                               "
  84.   Robo Wars                             "
  85.   STS- Race for the Stars               "
  86.   Stack' Em                             "
  87.   Sub Attack                            "
  88.   Super SlotMachine                     "
  89.   SinBaud the Sailor                    "
  90.   TW 2002                               "
  91.   Tank Command                          "
  92.   Yankee Trader                         "
  93.   Advanced XORU (d&d)                   "
  94.   Bat Guy                               "
  95.   Stooge Mania                          "
  96.   HangMan Word Game                     "
  97.   Jail Break                            "
  98.   Add to the Story Here !!!             "
  99.   Evidence Murder Mystery               "
  100.   The Simpsons Door                     "
  101.  
  102.  
  103.                  An example of the way to call it after each call
  104.                  ------------------------------------------------
  105.  
  106.   Echo       Creating the System Statistics Screen WCPRO.BBS
  107.   t:
  108.   cd \wc30\catstat
  109.   catstat
  110.  
  111.                  An example of the way to call it each night
  112.                  ------------------------------------------------
  113.   ..... Your other programs ....
  114.   :-------------------------------------
  115.   : CatStat's Nightly Maintenance Run
  116.   :-------------------------------------
  117.     t:
  118.     cd \wc30
  119.     catstat /m
  120.     lopper /L1 /D1
  121.  
  122.      .... etc....
  123.  
  124.  
  125.                       An example of the Catstat.his
  126.                       ----------------------------
  127. The Kingdom of Cormac mac Airt  <- The Name of The BBS (From 1 to 36 Characters in Length)
  128. Alan                            <- The Sysop's First Name
  129. Monaghan                        <- The Sysop's Last Name
  130. 01-01-1989                      <- Date of the Beginning of the Stats (Suggest this format for Looks)
  131.  2481                           <- Total Uploads
  132.  57470                          <- Total Downloads
  133.  103                            <- Total of Sunday Calls           <---
  134.  37                             <- Total of Monday Calls              |
  135.  38                             <- Total of Tuesday Calls             |
  136.  64                             <- Total of Wednesday Calls           |- All of these must add
  137.  82                             <- Total of Thursday Calls            |  up to all of the following
  138.  88                             <- Total of Friday Calls              |  if the stats are to match at all.
  139.  93                             <- Total of Saturday Calls         <---
  140.  30                             <- Total of 12 am Calls
  141.  14                             <- Total of  1 am Calls
  142.  12                             <- Total of  2 am Calls
  143.  6                              <- Total of  3 am Calls
  144.  3                              <- Total of  4 am Calls
  145.  7                              <- Total of  5 am Calls
  146.  8                              <- Total of  6 am Calls
  147.  16                             <- Total of  7 am Calls
  148.  22                             <- Total of  8 am Calls
  149.  24                             <- Total of  9 am Calls
  150.  29                             <- Total of 10 am Calls
  151.  30                             <- Total of 11 am Calls
  152.  25                             <- Total of 12 pm Calls
  153.  23                             <- Total of  1 pm Calls
  154.  21                             <- Total of  2 pm Calls
  155.  25                             <- Total of  3 pm Calls
  156.  28                             <- Total of  4 pm Calls
  157.  24                             <- Total of  5 pm Calls
  158.  24                             <- Total of  6 pm Calls
  159.  22                             <- Total of  7 pm Calls
  160.  23                             <- Total of  8 pm Calls
  161.  25                             <- Total of  9 pm Calls
  162.  35                             <- Total of 10 pm Calls
  163.  29                             <- Total of 11 pm Calls
  164.  
  165.  
  166.                                    Liability
  167.                                    ---------
  168.  
  169.   Catstat has been tested on multiple machines using many different
  170.   configurations and no problems have occurred. However, if a problem does
  171.   arise due to CatStat, I cannot be held responsible. Use at your own risk.
  172.  
  173.  
  174.  
  175.                           Distribution and Registration
  176.                           -----------------------------
  177.  
  178.   Catstat may be freely distributed only as the following unaltered files:
  179.  
  180.         CATSTAT.EXE                <- The Main Executable
  181.         CATSTAT.CFG                <- The Configuration File
  182.         CATSTAT.HIS                <- History file (this must be deleted before you start!)
  183.         CATSTAT.DOC                <- What you are viewing now
  184.         REGISTER.DOC               <- If you wish to register
  185.         WCPRO.BBS                  <- An Example of the Output
  186.  
  187.  
  188.                    -------------------------------------------
  189.                      To Register Catstat, please send $10 to:
  190.  
  191.                                  Alan G. Monaghan
  192.                                Three Paws Productions
  193.                                  6501 Stewart Road
  194.                                     Suite H-1
  195.                                Cincinnati, OH 45236
  196.                    -------------------------------------------
  197.                                  See REGISTER.DOC
  198.  
  199.  
  200.  
  201.                             Contacting the Author
  202.                             ---------------------
  203.  
  204.  I can be reached for comments, questions, suggestions, complaints, etc., at
  205.  the following EMAIL boxes:
  206.  
  207.  
  208.            Mustang BBS     (ALAN MONAGHAN)      - mail checked weekly
  209.            The Kingdom of Cormac mac Airt       - I am the SysOp
  210.            (513) 745-0965  FidoNet Address - (1:108/180)
  211.            (513) 745-9043  FidoNet Address - (1:108/2) NetMail Only!
  212.  
  213.  
  214.  
  215. 2.0b Rev: Fixed the problem of erasing the Activity logs every so often
  216.           and stopping if it doesn't find a file.
  217.  
  218. 2.0d Rev: Fixed the Upload problem reading when and Upload too Place. A change
  219.           in WC v3.02 made this change necessary.
  220.  
  221. 3.0a Rev: Added color, background, and BBS Name to OutPut...
  222.  
  223. 4.0a Rev: Added a History Screen. Added command line input for the setup and
  224.           maintenance runs. Changed the Output format just slightly. Made the
  225.           Protocol screen dynamic. Also added a TomCat Stats Screen and
  226.           added the option that if there were no downloads or uploads, then
  227.           there would be no protocol screen generated. The same is true with
  228.           the TomCat Screen. If there is no activity w/ Tomcat, that screen
  229.           will not be produced.
  230.  
  231. 5.0a Rev: Added RIP Detection and fixed the infinite loop problem with the
  232.           TomCat Section.