                         ======== ======   =======
                            ==    ==   ==     ===
                            ==    ==   ===   ===
                            ==    ==   ==   ===
                            ==    ======   =======

                   =======================================
                   The DeAdZoNe Utilities for RemoteAccess
                   =======================================

                                     D-StAt
                      Top User Statistics for RemoteAccess
                           Version 5.20   May 24, 1993
                         Copyright Victor Magdic 1991-93
                               All Rights Reserved


What is it?
-----------
D-StAt is a program that generates top user bulletins for RemoteAccess BBS's.
This version (5.20) is written for RemoteAccess 2.00 (it will not work with
prior versions of RA).

IMPORTANT:    If you are upgrading from D-StAt version 5.00/5.10 be sure to
              follow these steps before using D-StAt for the first time:

              1. Run DSTAT /C
              2. Make any necessary changes to the configuration (there are
              several new options) and then save the configuration.

Features
--------
   *   Top User Statistics Generator. Provides complete system and user
       information in one easy to use program. Including:
   
             Top Callers, Top (message) Posters, Top Downloaders(in kilobytes
             and files), Top Uploaders (in kilobytes and files), as well as
             totals and Averages. Also gives you an easy to read breakdown of
             the age groups of the users on your BBS.
   
   *   Customizable bulletin names
   *   You can enable/disable specific bulletins
   *   Will use either Handles or Real names.
   *   InfoBar shows you the Total System Calls, Total Downloads,
       Uploads etc., as well as Averages (e.g. Average time used per day etc.)
   *   Can be configured to exclude certain users from the statistics.
   *   Colour of bulletins can be changed if desired (even a 3-d shadow effect
       is available).
   *   Built-in configuration program makes setting up D-StAt a snap!


 IMPORTANT: D-StAt 5.20 is written for RemoteAccess 2.00 and will not
            work on prior versions of RA.


How much does it cost?
----------------------
This utility is FREE!  If you like it you can continue to use it for as long as
you like free of charge!

If you do decide to use it, I would be excited to hear from you !!  I encourage
you to send me a postcard at the address listed below (see the end of this text
file), or a message via netmail. It will cost you practically nothing, and will
let me know you're enjoying the program. It will also give me incentive to keep
improving the program and make it even better!


Configuration
-------------
To configure D-StAt, type:

               DSTAT /C

This will bring up the configuration screen. Most of the options are self
explanatory and only a few will be described below:


Set Paths and Filenames  When you choose this option and you will be presented
                         with another menu where you can define:
                         
                         1. The directory where you want the bulletins created
                         (normally your RA textfiles directory)
                         2. The directory containing your user file (USERS.BBS)
                         3. The directory where the D-StAt exclusion file
                         (DSTAT.CTL) can be located (if you are using one)
                         4. The filenames of the bulletins which D-StAt will
                         create
                         
Enable/Disable           Choose this and you will be presented with another menu
Bulletins                were you can enable/disable any of the bulletins.
                         (Whatever you disable, D-StAt will not generate.)
                         
Include Sysop in         If you want the sysop to be included in the door
bulletin                 statistics turn this option on.
                         
Sysop Name in bulletin   If you want the sysop's name included at the top of the
header                   bulletin then turn this option. (Note: the name is use
                         is whatever you have specified under "sysop name".)
                         
Use Handles              Choose YES to use handles when generating the bulletins.
                         Choose NO to use real names.
                         
Generate Bar Graphs      By default D-StAt will generate bar graphs showing the
                         relative values between different users. If you do not
                         want bar graphs, turn this feature off.
                         
Honour Hidden Attribute  Turn this ON if you want D-StAt to honour the users
                         hidden attribute as set in their user record. When D-
                         StAt is set to `honour' the hidden attribute, it will
                         not put a user in the bulletins if their hidden
                         attribute is on.
                         
Generate Infobar         The `infobar' is a small bar attached to the bottom o
                         the bulletins which gives you overall system information
                         (e.g. total system calls, total uploads overall etc.)
                         
Use Exclusion File       If you want to use an exclusion file, turn this option
                         on (see discussion on exclusion file later in the docs).
                         
Colour Scheme            Choose the colour scheme for generating the bulletins.
                         Choose from Yellow/Red; Cyan/Magenta; 3-D shadow effect
                         


Generating Bulletins
--------------------
In order to generate the `Top User' bulletins, run D-StAt with the /G switch,

          DSTAT /G

  Comments
  --------
   *   D-StAt will handle up to *3000* users in the users file. If this
       number is exceeded D-StAt will abort with an error message.
   *   D-StAt will automatically exclude users who have been locked out i.e.
       security level 0) from the top-user bulletins.


Exclusion List
--------------
D-StAt supports an exclusion list which allows you to specify up to 100 users
which you do not want included in the bulletins. This is useful if have users
(or co-sysops) which you want to "hide" from the bulletins.

In order to use this feature you must create a plain ASCII text file called
DSTAT.CTL and simply list the name or handle of the user which you want excluded
(one entry per line). You must also enable "Exclusion File Checking" in the
configuration menu.
   
   Comments
   --------
   *   It is not necessary to specify both a user's real name and their handle
       as separate entries, one or the other will suffice.
   *   The entries in DSTAT.CTL are *not* case sensitive, so if you have "John
       Smith" in your DSTAT.CTL file, and the user's name is actually spelt
       "JoHn SmItH", the name will still be properly excluded.
   *   If you have more than 100 entries in DSTAT.CTL, D-DooR will tell you so
       and abort with an error message.
   
           Example of DSTAT.CTL:
   
                     John Smith
                     Jane Smith
                     The Punisher
   

Location of Files
-----------------
D-StAt can be run from any directory, just make sure you run it from the same
directory where the configuration file (DSTAT.CFG) is located.  Also, the
exclusion file, DSTAT.CTL (if you are using it), must be located in the same
directory that you run DSTAT.EXE from.

   Note: D-StAt does *not* write to the RemoteAccess user files at any time.


Bulletins Created
-----------------
D-StAt creates the following 12 default bulletins (6 ANSI and 6 ASCII) in the
directory you have specified as the Textfiles directory.  Listed here are the
default names given to these bulletins -you can change the names of any of these
bulletin names in the configuration.

     D_CALL.ANS  and  D_CALL.ASC       top callers
     D_POST.ANS  and  D_POST.ASC       top message posters
     D_UPLK.ANS  and  D_UPLK.ASC       top uploaders by kilobytes
     D_UPLF.ANS  and  D_UPLF.ASC       top uploaders by files
     D_DWLF.ANS  and  D_DWLF.ASC       top downloaders by files
     D_AGE.ANS   and  D_AGE.ASC        age statistics
     D_DWLK.ANS  and  D_DWLK.ASC       top downloaders by kilobytes

       
Legal Stuff and Disclaimer
--------------------------
"D-StAt" refers to the executables and documentation in the original
distribution archive. D-StAt is copyrighted material by the author, Victor
Magdic. All rights are reserved.  The author grants you a licence to use this
software free of charge.

The program is provided "as is", without warranty or guarantee of any kind,
either expressed or implied, as to its quality or performance. The author will
not be held liable to you or anyone for any direct, indirect, incidental or
consequential damages, including but not limited to any lost profits, or lost
savings which may result from the use or inability to use this program.

The author is in no way obligated to provide future versions of this software.

Your use of the program constitutes your agreement to these terms and to this
disclaimer.

All mentioned products are copyrighted by and/or trademarks of their respective
holders.


Credits
-------
Thanks to James FitzGibbon for helping me beta test D-StAt and for his numerous
suggestions and helpful criticism.  Thanks also to Jonathan Rapoport for his
invaluable bug reports.


Updates
-------
Please see the enclosed file DEADZONE.TXT for information on how to obtain the
latest version of D-StAt.

       
Suggestions always welcome!
---------------------------
If you have any suggestions for improvement or wish to report any bugs, you can
reach me via netmail:
       
       The DeAdZoNe
       Victor Magdic
       FidoNet: 1:259/427
       TeleNet Canada: 20:22/104
       
       or by writing to:
       
       Victor Magdic
       424 Camden Circle
       Mississauga, Ontario
       L4Z 2P4
       CANADA
       
------------------------------------------------------------------ end

