home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / DS201.ZIP / DOORSTAT.DOC next >
Encoding:
Text File  |  1993-11-14  |  8.6 KB  |  214 lines
  1.  
  2.  
  3.  
  4.         =================================================================
  5.         DoorStat version 2.01    Baker Street Software
  6.         =================================================================
  7.         
  8.         -----------------------------------------------------------------
  9.         Introduction
  10.         
  11.         DoorStat  will track  the usage  of doors  on your bulletin board 
  12.         system,  producing ASCII and ANSI bulletins showing the number of 
  13.         times and a graph of the relative usage of all your doors.  
  14.         
  15.         Files contained in the DoorStat Archive are:
  16.         
  17.         DOORSTAT.EXE     - main program
  18.         DOORSTAT.DOC     - this file
  19.         REGISTER.FRM     - registration form
  20.         WHATSNEW.201     - program changes from last version
  21.         README.1ST       - note on upgrading
  22.         FILE_ID.DIZ      - program description
  23.         
  24.         Other associated files used and created by DoorStat
  25.         
  26.         DOORSTAT.DAT  - data file 
  27.         DOORSTAT.CLR  - configuration file 
  28.         
  29.         -----------------------------------------------------------------
  30.         Using DoorStat
  31.         
  32.         When DoorStat is run for the first time you will be prompted  for 
  33.         the name of your BBS. DoorStat will then enter the  configuration 
  34.         mode so that you may specify how you wish your bulletin to look.
  35.         
  36.         Following  are  explainations  of  the  different  command   line 
  37.         parameters.
  38.         
  39.         
  40.         -CONFIG   
  41.         
  42.         This option allows you to customize DoorStat to fit your  system. 
  43.         This  is where you may edit the door list, change the colors  and 
  44.         your  bbs name. You may also reset the usage counter  and  change 
  45.         the graph character here. 
  46.         
  47.         When  entering  a  door  name you  must   observe  the  following 
  48.         restrictions  in order for the program to accurately  track  your 
  49.         door usage.
  50.         
  51.         1. The  name of  the door  that you  use with  the DOORSTAT -NAME 
  52.         parameter   must match  that of the name in the list  you  create 
  53.         exactly.  The program is case sensitive so,
  54.         
  55.         Know-it-all  is not the same as  know-it-all
  56.         Know it all  is not the same as  KnowItAll
  57.             
  58.         2. The  name of  the door  can be  no more than twenty characters 
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.         in length.
  66.         
  67.         3. A maximum of 210 doors may be tracked in this version.
  68.         
  69.         
  70.         -NAME     
  71.         
  72.         Log  each  door usage with this parameter. The  command  
  73.         
  74.              DoorStat  -NAME  <doorname>  
  75.         
  76.         will   store  the   name  of  that  particular   door   in    the 
  77.         DOORSTAT.DAT   file. The  <doorname> parameter  must follow   the 
  78.         same restrictions listed in the -CONFIG parameter.  
  79.         
  80.         You   run  DoorStat  with the -NAME parameter in the  batch  file 
  81.         that calls your door.
  82.         
  83.                   Example: => exit from bbs to door
  84.         
  85.                     :door
  86.                       doorstat -name My favorite door
  87.                       cd\door
  88.                       run_door
  89.                       cd\bbs
  90.                       back to bbs
  91.         
  92.         
  93.         
  94.         -STATS <path>
  95.         
  96.         This  parameter will produce both the ASCII and ANSI bulletin for 
  97.         you  to  display.  Following  the   -stats   parameter  you  must 
  98.         specifiy  how you wish the door usage to be shown. There are  two 
  99.         options. You may create a graph representing the number of  times 
  100.         a  door  has  been accessed with a  #  character  as  the  second 
  101.         parameter or you may create a graph representing a percentage  of 
  102.         each  doors usage relative to the total door usage using  the   %  
  103.         character as the second parameter. You must also specify the path 
  104.         to  the directory where you wish the bulletin files to be  stored 
  105.         as the third parameter.
  106.         
  107.                   The output file names are:
  108.         
  109.                   DOORSTAT.ASC  -  ASCII file
  110.                   DOORSTAT.ANS  -  ANSI file
  111.         
  112.                   When   using this  parameter do not  include a  traiing 
  113.                   backslash on the path.
  114.         
  115.                   Example: doorstat -stats # c:\bbs\txtfiles
  116.                            doorstat -stats % c:\bbs\txtfiles
  117.         
  118.         
  119.         -RESET    This  parameter allows you to reset the  usage  counter      
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.                   from  the command line. Running  doorstat  -reset  will 
  127.                   reset  all  the counters to zero and reset  the  "from" 
  128.                   date to the current system date.
  129.         
  130.         
  131.         ----------------------------------------------------------------
  132.         Thanks to Joe Hacker for doing the beta testing for this program.
  133.         
  134.         
  135.         Registration/Support/Questions/Suggestions
  136.         -----------------------------------------------------------------
  137.         If  you like  this program  please register it.   If you   regis-
  138.         ter  this   program you will receive a registration  number  that  
  139.         will  be  valid  for all future versions of this  program.    The 
  140.         program  will  not  say   [UNREGISTERED]  at the  bottom  of  the 
  141.         bulletins,  but  will  have  your  name  instead.    To  register 
  142.         complete the  registration form and send $5.00 to
  143.         
  144.         Baker Street Software   P.O. Box 10143    Conway, Arkansas  72032
  145.         
  146.         $5.00 isn't much is it?
  147.         
  148.         Once   you  receive  your registration number you can   create  a 
  149.         file called DOORSTAT.KEY with your ASCII text editor.   The  file 
  150.         should contain the following information:
  151.         
  152.         REGISTRATION NUMBER
  153.         Your Name
  154.         
  155.         That's it.  Thanks.
  156.         
  157.         The  latest  revision  of this program  and  other  Baker  Street 
  158.         software may be found at the locations listed below. Questions or 
  159.         suggestions about this program can also be directed to me  (Brent 
  160.         Herring) at these locations. 
  161.         
  162.         The Computer Hut      (501) 329-0321   Fido 1:399/11
  163.         Gethsemane            (512) 937-2088   Fido 1:160/140
  164.         
  165.         ------------------------------------------------------------------
  166.         Legalese
  167.         
  168.         1."DoorStat"  refers to the executable  programs,  documentation, 
  169.         and  related  files  contained  in  the   DoorStat   distribution  
  170.         archive released  by Baker Street Software.
  171.         
  172.         2.Baker Street Software  is in no way obligated to provide future 
  173.         versions of, or support for this program.
  174.         
  175.         3.You   may  not  modify or   otherwise   reverse-engineer   this 
  176.         program.
  177.         
  178.         4.The software and accompanying materials (including instructions 
  179.         for  use) are provided  "as  is"  without  warranty of any  kind. 
  180.         Further,  the author does not warrant,  guarantee, or  make   any 
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.         representations   regarding the use,  or the results of the  use, 
  188.         of  the software or written materials in terms  of   correctness, 
  189.         accuracy, reliability, currentness or otherwise.
  190.         
  191.         The author(s) shall not be liable  for  any  direct,    indirect, 
  192.         consequential, or incidental damages (including damages for  loss 
  193.         of business profits, business  interruption,  loss  of   business 
  194.         information, and the like)  arising out  of the use or  inability 
  195.         to use the software even if the author has been advised  of   the 
  196.         possibility of such damages.
  197.         
  198.         5.You  are free to distribute  this archive,  in fact I hope that 
  199.         you  do so.   However in  distribution please  observe these  few 
  200.         restrictions. (a) All  the files  in the  original archive   must 
  201.         be included.  (b) No  fee may  is charged  for its  distribution, 
  202.         and  that the distribution  archive  is  not  modified   in   any  
  203.         way.   Pay  Bulletin  Board Systems  may  however   charge  their 
  204.         normal  fee provided  that no  additional charge is  levied.  (c) 
  205.         This program may not be included as part of any software  library 
  206.         which  is distributed  on a  commercial basis  (commercial = "for 
  207.         money")   without prior  written permission  from   Baker  Street 
  208.         Software.
  209.         
  210.         6.Your   use  of this software is considered agreement  to  these 
  211.         terms.
  212.  
  213.  
  214.