home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / ra / dstat520.zip / DSTAT.TXT < prev    next >
Text File  |  1993-05-22  |  11KB  |  248 lines
  1.                          ======== ======   =======
  2.                             ==    ==   ==     ===
  3.                             ==    ==   ===   ===
  4.                             ==    ==   ==   ===
  5.                             ==    ======   =======
  6.  
  7.                    =======================================
  8.                    The DeAdZoNe Utilities for RemoteAccess
  9.                    =======================================
  10.  
  11.                                      D-StAt
  12.                       Top User Statistics for RemoteAccess
  13.                            Version 5.20   May 24, 1993
  14.                          Copyright Victor Magdic 1991-93
  15.                                All Rights Reserved
  16.  
  17.  
  18. What is it?
  19. -----------
  20. D-StAt is a program that generates top user bulletins for RemoteAccess BBS's.
  21. This version (5.20) is written for RemoteAccess 2.00 (it will not work with
  22. prior versions of RA).
  23.  
  24. IMPORTANT:    If you are upgrading from D-StAt version 5.00/5.10 be sure to
  25.               follow these steps before using D-StAt for the first time:
  26.  
  27.               1. Run DSTAT /C
  28.               2. Make any necessary changes to the configuration (there are
  29.               several new options) and then save the configuration.
  30.  
  31. Features
  32. --------
  33.    *   Top User Statistics Generator. Provides complete system and user
  34.        information in one easy to use program. Including:
  35.    
  36.              Top Callers, Top (message) Posters, Top Downloaders(in kilobytes
  37.              and files), Top Uploaders (in kilobytes and files), as well as
  38.              totals and Averages. Also gives you an easy to read breakdown of
  39.              the age groups of the users on your BBS.
  40.    
  41.    *   Customizable bulletin names
  42.    *   You can enable/disable specific bulletins
  43.    *   Will use either Handles or Real names.
  44.    *   InfoBar shows you the Total System Calls, Total Downloads,
  45.        Uploads etc., as well as Averages (e.g. Average time used per day etc.)
  46.    *   Can be configured to exclude certain users from the statistics.
  47.    *   Colour of bulletins can be changed if desired (even a 3-d shadow effect
  48.        is available).
  49.    *   Built-in configuration program makes setting up D-StAt a snap!
  50.  
  51.  
  52.  IMPORTANT: D-StAt 5.20 is written for RemoteAccess 2.00 and will not
  53.             work on prior versions of RA.
  54.  
  55.  
  56. How much does it cost?
  57. ----------------------
  58. This utility is FREE!  If you like it you can continue to use it for as long as
  59. you like free of charge!
  60.  
  61. If you do decide to use it, I would be excited to hear from you !!  I encourage
  62. you to send me a postcard at the address listed below (see the end of this text
  63. file), or a message via netmail. It will cost you practically nothing, and will
  64. let me know you're enjoying the program. It will also give me incentive to keep
  65. improving the program and make it even better!
  66.  
  67.  
  68. Configuration
  69. -------------
  70. To configure D-StAt, type:
  71.  
  72.                DSTAT /C
  73.  
  74. This will bring up the configuration screen. Most of the options are self
  75. explanatory and only a few will be described below:
  76.  
  77.  
  78. Set Paths and Filenames  When you choose this option and you will be presented
  79.                          with another menu where you can define:
  80.                          
  81.                          1. The directory where you want the bulletins created
  82.                          (normally your RA textfiles directory)
  83.                          2. The directory containing your user file (USERS.BBS)
  84.                          3. The directory where the D-StAt exclusion file
  85.                          (DSTAT.CTL) can be located (if you are using one)
  86.                          4. The filenames of the bulletins which D-StAt will
  87.                          create
  88.                          
  89. Enable/Disable           Choose this and you will be presented with another menu
  90. Bulletins                were you can enable/disable any of the bulletins.
  91.                          (Whatever you disable, D-StAt will not generate.)
  92.                          
  93. Include Sysop in         If you want the sysop to be included in the door
  94. bulletin                 statistics turn this option on.
  95.                          
  96. Sysop Name in bulletin   If you want the sysop's name included at the top of the
  97. header                   bulletin then turn this option. (Note: the name is use
  98.                          is whatever you have specified under "sysop name".)
  99.                          
  100. Use Handles              Choose YES to use handles when generating the bulletins.
  101.                          Choose NO to use real names.
  102.                          
  103. Generate Bar Graphs      By default D-StAt will generate bar graphs showing the
  104.                          relative values between different users. If you do not
  105.                          want bar graphs, turn this feature off.
  106.                          
  107. Honour Hidden Attribute  Turn this ON if you want D-StAt to honour the users
  108.                          hidden attribute as set in their user record. When D-
  109.                          StAt is set to `honour' the hidden attribute, it will
  110.                          not put a user in the bulletins if their hidden
  111.                          attribute is on.
  112.                          
  113. Generate Infobar         The `infobar' is a small bar attached to the bottom o
  114.                          the bulletins which gives you overall system information
  115.                          (e.g. total system calls, total uploads overall etc.)
  116.                          
  117. Use Exclusion File       If you want to use an exclusion file, turn this option
  118.                          on (see discussion on exclusion file later in the docs).
  119.                          
  120. Colour Scheme            Choose the colour scheme for generating the bulletins.
  121.                          Choose from Yellow/Red; Cyan/Magenta; 3-D shadow effect
  122.                          
  123.  
  124.  
  125. Generating Bulletins
  126. --------------------
  127. In order to generate the `Top User' bulletins, run D-StAt with the /G switch,
  128.  
  129.           DSTAT /G
  130.  
  131.   Comments
  132.   --------
  133.    *   D-StAt will handle up to *3000* users in the users file. If this
  134.        number is exceeded D-StAt will abort with an error message.
  135.    *   D-StAt will automatically exclude users who have been locked out i.e.
  136.        security level 0) from the top-user bulletins.
  137.  
  138.  
  139. Exclusion List
  140. --------------
  141. D-StAt supports an exclusion list which allows you to specify up to 100 users
  142. which you do not want included in the bulletins. This is useful if have users
  143. (or co-sysops) which you want to "hide" from the bulletins.
  144.  
  145. In order to use this feature you must create a plain ASCII text file called
  146. DSTAT.CTL and simply list the name or handle of the user which you want excluded
  147. (one entry per line). You must also enable "Exclusion File Checking" in the
  148. configuration menu.
  149.    
  150.    Comments
  151.    --------
  152.    *   It is not necessary to specify both a user's real name and their handle
  153.        as separate entries, one or the other will suffice.
  154.    *   The entries in DSTAT.CTL are *not* case sensitive, so if you have "John
  155.        Smith" in your DSTAT.CTL file, and the user's name is actually spelt
  156.        "JoHn SmItH", the name will still be properly excluded.
  157.    *   If you have more than 100 entries in DSTAT.CTL, D-DooR will tell you so
  158.        and abort with an error message.
  159.    
  160.            Example of DSTAT.CTL:
  161.    
  162.                      John Smith
  163.                      Jane Smith
  164.                      The Punisher
  165.    
  166.  
  167. Location of Files
  168. -----------------
  169. D-StAt can be run from any directory, just make sure you run it from the same
  170. directory where the configuration file (DSTAT.CFG) is located.  Also, the
  171. exclusion file, DSTAT.CTL (if you are using it), must be located in the same
  172. directory that you run DSTAT.EXE from.
  173.  
  174.    Note: D-StAt does *not* write to the RemoteAccess user files at any time.
  175.  
  176.  
  177. Bulletins Created
  178. -----------------
  179. D-StAt creates the following 12 default bulletins (6 ANSI and 6 ASCII) in the
  180. directory you have specified as the Textfiles directory.  Listed here are the
  181. default names given to these bulletins -you can change the names of any of these
  182. bulletin names in the configuration.
  183.  
  184.      D_CALL.ANS  and  D_CALL.ASC       top callers
  185.      D_POST.ANS  and  D_POST.ASC       top message posters
  186.      D_UPLK.ANS  and  D_UPLK.ASC       top uploaders by kilobytes
  187.      D_UPLF.ANS  and  D_UPLF.ASC       top uploaders by files
  188.      D_DWLF.ANS  and  D_DWLF.ASC       top downloaders by files
  189.      D_AGE.ANS   and  D_AGE.ASC        age statistics
  190.      D_DWLK.ANS  and  D_DWLK.ASC       top downloaders by kilobytes
  191.  
  192.        
  193. Legal Stuff and Disclaimer
  194. --------------------------
  195. "D-StAt" refers to the executables and documentation in the original
  196. distribution archive. D-StAt is copyrighted material by the author, Victor
  197. Magdic. All rights are reserved.  The author grants you a licence to use this
  198. software free of charge.
  199.  
  200. The program is provided "as is", without warranty or guarantee of any kind,
  201. either expressed or implied, as to its quality or performance. The author will
  202. not be held liable to you or anyone for any direct, indirect, incidental or
  203. consequential damages, including but not limited to any lost profits, or lost
  204. savings which may result from the use or inability to use this program.
  205.  
  206. The author is in no way obligated to provide future versions of this software.
  207.  
  208. Your use of the program constitutes your agreement to these terms and to this
  209. disclaimer.
  210.  
  211. All mentioned products are copyrighted by and/or trademarks of their respective
  212. holders.
  213.  
  214.  
  215. Credits
  216. -------
  217. Thanks to James FitzGibbon for helping me beta test D-StAt and for his numerous
  218. suggestions and helpful criticism.  Thanks also to Jonathan Rapoport for his
  219. invaluable bug reports.
  220.  
  221.  
  222. Updates
  223. -------
  224. Please see the enclosed file DEADZONE.TXT for information on how to obtain the
  225. latest version of D-StAt.
  226.  
  227.        
  228. Suggestions always welcome!
  229. ---------------------------
  230. If you have any suggestions for improvement or wish to report any bugs, you can
  231. reach me via netmail:
  232.        
  233.        The DeAdZoNe
  234.        Victor Magdic
  235.        FidoNet: 1:259/427
  236.        TeleNet Canada: 20:22/104
  237.        
  238.        or by writing to:
  239.        
  240.        Victor Magdic
  241.        424 Camden Circle
  242.        Mississauga, Ontario
  243.        L4Z 2P4
  244.        CANADA
  245.        
  246. ------------------------------------------------------------------ end
  247.  
  248.