home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / DSDSTA10.ZIP / DSD-STAT.DOC < prev    next >
Encoding:
Text File  |  1993-04-13  |  10.7 KB  |  294 lines
  1.  
  2.                  -=- Dominion Software Designers present -=-
  3.  
  4.                        DSD Statistics Generator V1.0
  5.  
  6.                (C) Copyright 1993, Dominion Software Designers
  7.                              All Rights Reserved
  8.  
  9.  
  10.     Introduction
  11.     ~~~~~~~~~~~~
  12.  
  13.     DSD-Stat is a user statistics generator for RemoteAccess V1.1 / 2.0.
  14.     DSD-Stat generates a selection of ANSI / ASCII text files that contain
  15.     a list of the top users in areas such as Number of calls, Number of 
  16.     Messages, Uploads and Downloads among other things.
  17.  
  18.     Disclaimer
  19.     ~~~~~~~~~~
  20.  
  21.     DSD-STAT COMES WITH NO GUARANTEES. USE OF THE STATISTICS GENERATOR IS 
  22.     AT YOUR OWN RISK. THE AUTHORS WILL NOT BE HELD RESPONSIBLE FOR ANY 
  23.     DAMAGE OF HARDWARE OR LOSS OF SOFTWARE.
  24.  
  25.     With this in mind we have made every effort to DSD-Stat as stable as 
  26.     possible. Our Beta testers have endevoured to find any bugs within the
  27.     program. If you yourself do find any we would appreciate you dropping us
  28.     a line to tell us about them.
  29.  
  30.     SHAREWARE
  31.     ~~~~~~~~~
  32.  
  33.     DSD-Stat is a Shareware product, this means that you may use the 
  34.     program as is but if you make regular use of the program you must
  35.     pay a registration fee.
  36.  
  37.     To register DSD-Stat please see the registration form included with
  38.     this archive.
  39.  
  40.     You may freely distibute DSD-Stat (Unregistered Version) to anyone you
  41.     like, as long as all the files in the archive are unchanged (including
  42.     this documentation), and are all included. You may also only charge a
  43.     small distribution fee for the program and it must not be included in
  44.     a commercial release without the authors permission.
  45.  
  46.     SETTING UP
  47.     ~~~~~~~~~~
  48.     You will require to run DSD-Stat.
  49.  
  50.     An IBM Compatible computer with at least 512k ram.
  51.  
  52.     MS-DOS 3.3 (or higher or compatible)
  53.  
  54.     A BBS Package that keeps RemoteAccess 1.11/2.0 compatible config and
  55.     user files.
  56.  
  57.     INSTALLATION
  58.     ~~~~~~~~~~~~
  59.  
  60.     Create a directory and extract the archive into it, or copy all the 
  61.     files from a diskette into the directory.
  62.  
  63.     You then will have to edit/create a configuration file. An example 
  64.     config file is included named DSD-STAT.CFG. 
  65.  
  66.     See seperate section on config file for a description of the config 
  67.     file.
  68.  
  69.     Edit / Create the user exclusion file.  An example file is included
  70.     named DSD-STAT.EXC.
  71.  
  72.     See the section on excluding users for more information.
  73.  
  74.     Run DSD-STAT with the "DATA" option. EG.
  75.     
  76.                 DSD-STAT.EXE [config file] DATA
  77.  
  78.     This will put you into data file definition mode. You can now define
  79.     the path and name of the 24 ANSI/ASCII files that DSD-Stat will create.
  80.     When you have done this a file called DSD-STAT.DAT or (Whatever you 
  81.     defined it as in the config file) will be saved containing the path 
  82.     names you have just defined.
  83.  
  84.     RUNNING DSD-STAT
  85.     ~~~~~~~~~~~~~~~~
  86.  
  87.     To run DSD-STAT at a command line prompt or in a batch file, use
  88.  
  89.                 DSD-STAT.EXE [config file]
  90.  
  91.     Where config file is the name of an optional config file to be used. If
  92.     it is not specified DSD-STAT.CFG will be used. There are two useful 
  93.     places to run DSD-STAT, one is in your daily maintenance batch file, and
  94.     the other is from a menu within the BBS. Eg (RA Type 7 Execute Sub 
  95.     Program Option).
  96.  
  97.     NOTE: You will not need any special checking for multitasking systems
  98.     as the program will create a file called DSD-STAT.LOK whilst it is 
  99.     updating the generated files. This will only cause a problem if your
  100.     system is reset while DSD-STAT is working as it would not have had a 
  101.     chance to delete the .LOK file and will think that a copy of itself is
  102.     already running. In this situation you will need to delete the .LOK
  103.     file manually.
  104.  
  105.     CONFIGURATION.
  106.     ~~~~~~~~~~~~~~
  107.     The first 8 lines of the configuration file must contain the eight 
  108.     configuration items below (In Order).
  109.  
  110.     1: Path and name of the USERS.BBS file that your BBS program stores 
  111.     its users information in. EG.
  112.  
  113.                 C:\BBS\USERS.BBS
  114.     
  115.     2: Path and name of the Remote Access Compatible config file. EG.
  116.  
  117.                 C:\BBS\CONFIG.RA
  118.  
  119.     3: Path and name of the DSD-STAT.DAT file which will contain the ANSI/
  120.     ASCII file name definitions (See Installation above). EG.
  121.  
  122.                 C:\BBS\DSD-STAT\DSD-STAT.DAT
  123.  
  124.     4: Path and name of the Exclusion file. This is a TEXT file that 
  125.     contains a list of users to be excluded from the user statistics.
  126.     (See seperate section on excluding users). EG.
  127.  
  128.                 C:\BBS\DSD-STAT\DSD-STAT.EXC
  129.  
  130.     5: Data file path. This is a path used for DSD to create temporary 
  131.     files and will use to look for the keyfile DSD-UTL1.KEY if you have
  132.     registered the program. EG.
  133.  
  134.                 C:\BBS\DSD-STAT\
  135.  
  136.     6: Number of users to list in each table generated by the Statistical
  137.     generator (DSD-STAT). This number may be from 1 to 20. EG.
  138.  
  139.                 10 
  140.  
  141.     NOTE: Will make all tables a list of top 10 users.
  142.  
  143.     7: This a True / False value ( 0/1 ) that signifies wether you wish to
  144.     have zero values included in the top / worst upload download ratio 
  145.     tables. The reason for this is that zero values give correct ratio's
  146.     but tend to domintate the tables. Where as excluding zero values will
  147.     exclude users who have uploaded / downloaded zero files and give a more
  148.     balanced table. EG.
  149.  
  150.                 0
  151.  
  152.     NOTE: Include zero values in tables, whilst a 1 would exclude zero values
  153.     in these tables.
  154.  
  155.     8: RemoteAccess compatibility flag. This will indicate whether your
  156.     USERS.BBS and CONFIG.RA files are compatible with remote access 1.11 or
  157.     RemoteAccess 2.00. EG.
  158.  
  159.                 1
  160.  
  161.     NOTE: This will give RA 1.11 compatibility, whilst a 2 would make the
  162.     program RA 2.00 Compatible.
  163.  
  164.     Different config files can be used by specifying name of the config file
  165.     on the DSD-STAT command line if a config file is not specified 
  166.     DSD-STAT.CFG will be used by default. 
  167.  
  168.     EXCLUDE FILE
  169.     ~~~~~~~~~~~~
  170.  
  171.     The exclude file is a text file containing one user name per line.
  172.     DSD-STAT will read in this file and consequently exclude any users who's
  173.     names are contained in this file from being included on any of the 
  174.     tables. These users will still appear on the list of birthdays and their
  175.     data will still be used in the general statistics. An example of this 
  176.     data file follows.
  177.  
  178.                 STEVEN HUNTER
  179.                 JAMES NOBES
  180.                 DAVID NEIGHBOUR
  181.                 CRAIG WESTBURY
  182.  
  183.     DISPLAYING FILES
  184.     ~~~~~~~~~~~~~~~~
  185.  
  186.     All of the files created by DSD-STAT can be displayed within your bbs 
  187.     for users to view using one of the standard menu options, or whatever
  188.     applies to your BBS Program. You will probably find it necessary to 
  189.     use one of the BBS options that prompts the user to press return after
  190.     the file has been displayed, so that the user has a chance to read it.
  191.  
  192.     The files that are created are:
  193.  
  194.     NOTE: (xx) is your selected number of users in the list.
  195.  
  196.                 TOP xx UPLOADERS BY KILOBYTE
  197.                 TOP xx UPLOADERS BY FILE
  198.                 TOP xx DOWNLOADERS BY KILOBYTE
  199.                 TOP xx DOWNLOADERS BY FILE
  200.  
  201.     These are the lists of the top U/L's and D/L's sorted accordingly.
  202.  
  203.                 TOP xx UPLOAD / DOWNLOAD RATIO BY KILOBYTE
  204.                 TOP xx UPLOAD / DOWNLOAD RATIO BY FILE
  205.  
  206.     This is the ratio of UPLOADS divided by DOWNLOADS. If the include ZERO
  207.     value has been set in the configuration file then users who have
  208.     downloaded zero files will generally be placed at the top of the list, 
  209.     because their ratio is infinity. If the exclude ZERO flag is set in 
  210.     the config file then users who have downloaded zero files will not be
  211.     considered for these statistics.
  212.  
  213.                 WORST xx UPLOAD DOWNLOAD RATIO BY KILOBYTE
  214.                 WORST xx UPLOAD DOWNLOAD RATIO BY FILE
  215.  
  216.     This is the ratio of DOWNLOADS divided by UPLOADS. The exclude and
  217.     include flags are treated the same as the above except that consideration
  218.     is made when a user has uploaded zero files.
  219.  
  220.                 TOP xx CALLERS
  221.  
  222.                 TOP xx MESSAGE POSTERS
  223.  
  224.                 GENERAL STATISICS
  225.  
  226.     The general statistics file will contain an over view of the statistics 
  227.     with user averages and percentages.
  228.  
  229.                 BIRTHDAYS
  230.  
  231.     The birthdays file creates a list of users having birthdays in the next
  232.     week. But not including the year of birth so they can continue to keep
  233.     their age a secret :) 
  234.  
  235.     ANSI and ASCII version of each of these files are created.
  236.  
  237.     NOTE: People running DSD stat in RA 1.11 Compatibility mode will find
  238.     that the birthday file is not created and the general statistics file
  239.     will not include the users male to female ratio.
  240.  
  241.     REGISTERING DSD-STAT
  242.     ~~~~~~~~~~~~~~~~~~~~
  243.  
  244.     If you register DSD-STAT the title of each list will no longer be:
  245.  
  246.                 TOP xx CALLERS for UNREGISTERED BBS
  247.  
  248.     instead you will see somthing LIKE:
  249.  
  250.                 TOP xx CALLERS for THE DOMINION BBS
  251.  
  252.     otherwise DSD-STAT is not crippled in any other way. 
  253.  
  254.     NOTE: DSD-STAT is included in the Dominion Software Designers BBS 
  255.     Utility pack one. This means that registering DSD-STAT will also 
  256.     register the other doors in the pack. See the registration form for
  257.     names, and details are contained in the DSD-DOOR.TXT file.
  258.  
  259.     To register DSD-STAT fill out the registration form. All registration 
  260.     details are contained in the form.
  261.  
  262.     After registering DSD-STAT, you will recieve a small key file called
  263.     DSD-UTL1.KEY which when placed in the data file directory of DSD-STAT
  264.     will register your copy. You will also recieve on this disk the latest 
  265.     version of DSD-STAT and other utilities.
  266.  
  267.     AUTHOR CONTACTS
  268.     ~~~~~~~~~~~~~~~
  269.  
  270.     Dominion Software Designers are:
  271.  
  272.                 Craig Westbury
  273.                 David Neighbour
  274.                 Steve Hunter
  275.                 James Nobes
  276.  
  277.     You can contact us (For any reason.. MONEY, DONATIONS, POSTCARDS, 
  278.     COMPUTERS..The list is endless) on/at:
  279.  
  280.         POSTAL:         PO BOX 664, BRIGHTON, SA, 5048, AUSTRALIA.
  281.  
  282.         BBS:            The Dominion Multi Line BBS, +61-8-377-1984
  283.         FIDONET:        3:800/863, 3:800/864
  284.         WORLDNET:       61:9000/517
  285.  
  286.         INTERNET:       cjwestbu@teaching.cs.adelaide.edu.au
  287.                         swhunter@ "above"
  288.                         jsnobes@  "above"
  289.                         dineighb@no.one.wants.to.give.dave.one
  290.  
  291.     Thanks for using DSD-STAT!
  292.  
  293.  
  294.