home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / RATS30.ZIP / RATS.DOC < prev    next >
Text File  |  1996-03-10  |  16KB  |  352 lines
  1.  
  2.  
  3.                                  -=  R A T S  =-
  4.                            RemoteAccess TimeBank System
  5.  
  6.                                    Version 3.00
  7.                           Copyright 1995 - 1996 SoftNet
  8.                                All Rights Reserved
  9.  
  10.  
  11.  
  12.                               Co-Owners' of SoftNet
  13.  
  14.  
  15.                      David Smart                  Peter Kling
  16.                     Space Station         Info System Technology, Inc.
  17.  FidoNet:             1:324/285                    1:374/169
  18.  Phone BBS/FAX:    1-508-454-0356               1-407-729-9166
  19.  
  20.  
  21.  
  22. ╒════════════════════════════════════════════════════════════════════════════╕
  23. │░░░░░░ LICENSING INFORMATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  24. ╘════════════════════════════════════════════════════════════════════════════╛
  25.  
  26.       This is a licence agreement between you, the end user, and SoftNet
  27.   RATS, including any Screen, Executable, documentation, etc are the
  28.   property of SoftNet. Please read the terms and conditions of this
  29.   licence agreement carefully before using the software. If you for any
  30.   reason, whatsoever, cannot accept the conditions in this agreement,
  31.   you are not permitted to use RATS.
  32.  
  33.       You acknowledge and agree that RATS is a proprietary product of
  34.   SoftNet protected by applicable copyright laws and international treaty
  35.   provisions. You further acknowledge and agree that all rights, title,
  36.   and interest in, and to RATS are and shall remain with SoftNet
  37.  
  38.       RATS may be used for a period of thirty (30) days on a trial
  39.   basis to allow you to determine its suitability for your particular
  40.   application. After this period you MUST register RATS, or remove
  41.   it from your system. Registration entitles you to use RATS and
  42.   any future versions of RATS for as  long  as you wish, subject
  43.   to any special licensing conditions and/or applicable upgrade fees
  44.   attached to future versions.
  45.  
  46.       In the event that you are in violation of this licence agreement,
  47.   you agree and accept that SoftNet may cancel your registration and
  48.   any rights to use RATS that you may have. In the case of a dispute 
  49.   over the licence agreement, you further agree and accept to fully
  50.   reimburse SoftNet for legal and other expenses resulting from the
  51.   dispute.
  52.  
  53.       RATS is provided "as is", without warranty of any kind, or
  54.   fitness for a particular purpose, either expressed or implied, all
  55.   of are hereby explicitly disclaimed. SoftNet only guarantees that
  56.   RATS will occupy disk space.
  57.  
  58.       SoftNet liability resulting from your use or inability to use
  59.   RATS is limited to the amount that the affected party has paid
  60.   for it, or in the event that RATS was registered with a third
  61.   party  for payment to SoftNet, liability is limited to the amount
  62.   that was received by SoftNet from that third party.
  63.  
  64.       Neither SoftNet nor any of its employees, agents, or other
  65.   representatives are in any way obligated to provide future versions
  66.   of, or support for, RATS. You may freely distribute and copy
  67.   RATS provided that no fee is charged and the RATS distribution
  68.   archive contains unmodified copies of the original files as produced
  69.   by SoftNet Pay Bulletin Board Systems may, however, charge their
  70.   normal fee provided that no additional charge for RATS is levied
  71.   No part of RATS may be modified, altered, reverse engineered,
  72.   sold, or distributed in any form what so ever which would involve
  73.   some sort of trade without prior written permission from SoftNet
  74.  
  75. ╒════════════════════════════════════════════════════════════════════════════╕
  76. │░░░░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  77. ╘════════════════════════════════════════════════════════════════════════════╛
  78.  
  79. The RemoteAccess TimeBank System (henceforth known as RATS) is a user time-
  80. banking system for RemoteAccess and QuickBBS.  It has many features for the
  81. user and Sysop alike and allows users to bank online time and download
  82. kilobytes for use at a later date.
  83.  
  84. RATS also supports programs which automatically deposit minutes in user
  85. accounts using the THEBANK.EXT external support file (see External Game
  86. Support).
  87.  
  88. At the time of this release, RATS works with RemoteAccess versions 1.00
  89. through 2.50 and QuickBBS 2.75 through 2.80.  RATS will automatically
  90. detect and support the format of these packages' EXITINFO.BBS files.
  91.  
  92. If RATS finds a QBBS exitinfo, it refers to itself as
  93.  
  94.   RATS - The QuickBBS TimeBank System
  95.  
  96. RATS has a separate maintenance program called RMU (RATS Maintenance Utility)
  97. which takes care of the RATS data file RATS.DAT.  It performs tasks ranging
  98. from deleting zero-balance accounts and users who are no longer in the
  99. USERS.BBS file to sorting accounts in last name order.
  100.  
  101. RATS provides hot-key support.  If the user is familiar with the commands,
  102. the current screen output can be interrupted when a command key is pressed.
  103. This can really speed things along!
  104.  
  105. RATS has a graphic transaction screen and uses Sysop-definable colors for
  106. most fields and prompts.
  107.  
  108. RATS recognizes the Sysop when he/she logs in and affords the <S>ysop Admin.
  109. command which basically allows the Sysop to make balance changes or delete
  110. certain user accounts.  RATS assumes that the user is the Sysop if the
  111. current user name is equal to that of the Sysop name as defined by your BBS.
  112. RATS also supports allowing another user access to the Sysop menu. This is
  113. for a co-sysop etc.
  114.  
  115.  
  116. RATS allows the Sysop to define values for maximum time deposit, withdrawal,
  117. and balance, as well as maximum kilobyte deposit, withdrawal, and balance.
  118. You can also set the maximum time transfer and maximum purchaseable kilobytes
  119. as well as default prompt foreground, prompt background, and prompt highlight
  120. colors to be used. You may also allow your users to borrow time or K-Bytes
  121. from the bank. You may specify a one time interest charge.
  122.  
  123. RATS will support Multi-Line Systems. You can have more than one user in
  124. the bank at the same time. You MUST be running SHARE.EXE for multi-node
  125. support. Full RECORD LOCKING is supported, and support is included to handle
  126. up to 99 nodes.
  127.  
  128. ╒═════════════════════════════════════════════════════════════════════════════╕
  129. │░░░░░░ INSTALLATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  130. ╘═════════════════════════════════════════════════════════════════════════════╛
  131.  
  132.    VERY IMPORTANT!!!
  133.  
  134.    If you are running a version of RATS prior to 1.20 then you will be
  135.    required to completely re-install this new version.
  136.  
  137.    Version 1.50 IS compatable with 1.21 and 1.20 data files although
  138.    you will be required to go through RatsCfg and add in the new information
  139.    required for this version.
  140.  
  141.          *** If You are Installing RATS For The FIRST Time ***
  142.  
  143. Unpack the distribution archive into the directory you'll run RATS in.  RATS
  144. can be run in any subdirectory as long as paths are setup properly in
  145. RATSCFG.EXE.  We recommend creating a RATS subdirectory off your main BBS
  146. directory.
  147.  
  148. Run the RATSCFG.EXE program to create/edit the RATS configuration file.
  149.  
  150. PLEASE READ RATSCFG.DOC for information on configuring RATS.
  151.  
  152. Now you will need to create the batch files needed to run RATS.  This is
  153. straight forward, and beyond the scope of this document. A sample RATS.BAT
  154. is included with the distribution archive.
  155.  
  156. That's all there is to it!  RATS is easy to install and to use.
  157.  
  158.  
  159. ╒═══════════════════════════════════════════════════════════════════════════╕
  160. │░░░░░░ COMMAND LINE PARAMETERS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  161. ╘═══════════════════════════════════════════════════════════════════════════╛
  162.  
  163. RATS accepts the following command line parameters:
  164.  
  165.     /E - This  tells  RATS  not  to read any upcoming system event
  166.     information.  Some systems do not define any events within the
  167.     BBS and RATS doesn't like finding no events.    If  you  don't
  168.     have any events defined within your  BBS,  pass this parameter
  169.     to RATS.  I would recommend having at least one event  defined
  170.     within  your BBS as RATS thinks this is an ideal configuration
  171.     and loves the heck out of it! <grin>
  172.  
  173.     IMPORTANT NOTES ABOUT EVENTS:
  174.  
  175.     If you have ANY system events that require a user to be off at
  176.     a specific time,  you  MUST  have these events defined in your
  177.     BBS event schedule or RATS will  allow  users to withdraw time
  178.     that would overlap the system event time.
  179.  
  180.     If you  just  plain  don't  have  any  system events, then you
  181.     should use the /E command line parameter when  executing  RATS
  182.     (as above).
  183.   
  184.  
  185.     /I - Causes  RATS  to  perform an 'Inquire'. DORINFO1.DEF  will
  186.     be opened and the current online user's name retrieved  from  it.
  187.     Next, RATS will search it's data file for this user  and  return
  188.     the user's name and current account balance in the format:
  189.  
  190.                            USER_NAME:Time_Balance
  191.                            USER_NAME:K_Balance
  192.  
  193.     Where USER_NAME  is  the  user's full  name  (just as it is in
  194.     DORINFO1.DEF for  that matter - no underscores) and BALANCE is
  195.     the  user's  current  balance.    If the user does not have an
  196.     account, a balance of 0 will be returned.
  197.  
  198.     This  information is then written  to  a  file called RATS.TYM
  199.     which  is a standard ASCII text file.  RATS will overwrite any
  200.     existing RATS.TYM file.  This file will be written in the same
  201.     directory that contains RATS.EXE. Line one contains the users
  202.     banked time, and line 2 is the users banked K-Bytes.
  203.  
  204.     This feature was added to support  door programs which need to
  205.     read a user's current balance.
  206.  
  207.     If you pass the /I parameter to RATS, the specified task will
  208.     be performed and then RATS will exit to DOS.  RATS will NOT
  209.     come up for online use when this parameter is passed to it
  210.     since its sole purpose is to allow other door programs to
  211.     retrieve the current user's account balance.
  212.  
  213.  
  214.     /NOLIST  Passing this on the command line will disable the users
  215.     from listing other users balances. You will still be able to list
  216.     them from the sysop menu.
  217.  
  218.     /N This is used to pass the Node Number in a multi-node system.
  219.     If you are running a single node system, ignore this. Otherwise
  220.     you pass /N1 for node 1, /N2 for node 2 etc... You will be required
  221.     to create a seperate configuration file for each node. See notes
  222.     in RATSCFG.DOC
  223.  
  224.  
  225.  
  226. For normal single line operation, RATS doesn't need any command line
  227. parameters passed to it.
  228.  
  229.  
  230. ╒═════════════════════════════════════════════════════════════════════════════╕
  231. │░░░░░░ EXTERNAL FILES SUPPORTED ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  232. ╘═════════════════════════════════════════════════════════════════════════════╛
  233.  
  234.  
  235. RATSUSE.TXT - Minimum Usage File
  236. -----------------------------------------------------------------------------
  237. If you configure RATS to require a user to use the BBS for a given amount of
  238. time before being able to make a deposit (of time or kilobytes) and a user
  239. attempts to make a deposit before using the BBS for the minimum required
  240. time, RATS will display a text file called RATSUSE.TXT, if it exits.  If it
  241. does not exist, a short message will be displayed.
  242.  
  243. This was added to support those Sysops who do not wish to have users logon
  244. only to deposit all of their time and then logoff.  If you set the minimum
  245. usage time in RATSCFG to 5 minutes, for example, and a user logs on and
  246. attempts to make a deposit before using the BBS for 5 minutes, the file
  247. RATSUSE.TXT is displayed.  Once the user has used the BBS for 5 minutes or
  248. more, the user is then allowed to make a deposit.
  249.  
  250.  
  251. RATS.BUM & RATSBUM.TXT -- Bummer List
  252. -----------------------------------------------------------------------------
  253. RATS supports a 'bummer list' which is an ASCII text file list of user names
  254. that you do not want to have access to RATS.  This text file must have no
  255. blank lines.  Each line contains one full user name.  The user name can be
  256. in upper or lower case.  RATS will convert the names to upper case when it
  257. reads them.  The name of the text file is RATS.BUM.  If RATS finds this
  258. file upon startup, it will process it.
  259.  
  260. If a user who is on the bummer list tries to fire up RATS, RATS will look for
  261. a file called RATSBUM.TXT.  If found, this file will be displayed.  Otherwise,
  262. a default, one-line message will be displayed.
  263.  
  264.  
  265.  
  266. ╒═════════════════════════════════════════════════════════════════════════════╕
  267. │░░░░░░ EXTERNAL GAMES SUPPORT ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  268. ╘═════════════════════════════════════════════════════════════════════════════╛
  269. RATS is compatible with programs which utilize an external, automatic
  270. time-banking file (THEBANK.EXT) in that RATS will read this file and apply
  271. deposits and/or withdrawals automatically, to user accounts.
  272.  
  273. This means that RATS allows other door programs to automatically deposit
  274. or withdraw time OR K-Bytes from user accounts.  This can be quite handy,
  275. especially for door programs that offer gambling or other time or k-byte
  276. manipulation features.
  277.  
  278. So how does this work?  In RATSCFG, you entered a path to the external time
  279. bank support file THEBANK.EXT.  Whenever RATS is started, it looks for this
  280. file in the path you have set up.  If found, RATS performs the following
  281. tasks:
  282.  
  283.  o - Reads a line from THEBANK.EXT and retrieves the user name for the
  284.      transaction and the amount of the transaction.
  285.  
  286.  o - Searches the RATS data file for this user.  If the user does not
  287.      have an account, one is created.
  288.  
  289.  o - Applies the amount to be transacted.  This amount may be a positive or
  290.      a negative number.  If the number is negative, then the amount is
  291.      withdrawn from the user's account.  If the number is positive, the
  292.      amount is deposited.
  293.  
  294.  
  295. So, what's the format of this external support file?  THEBANK.EXT is simply
  296. an ASCII text file consisting of no blank lines.  Each line must contain a
  297. transaction.  Here's a sample THEBANK.EXT file;  we will be depositing 30
  298. minutes in Jane Doe's account and withdrawing 30 minutes from John Doe's
  299. account:
  300.  
  301. <top of file>
  302. JANE DOE:30
  303. JOHN DOE:-30
  304. <end of file>
  305.  
  306. To Deposit or withdraw K-Bytes you simply put a K or k on front of the number.
  307.  
  308. JANE DOE:K30
  309. JOHN DOE:k-30
  310.  
  311. There is no limit to the number of transactions in THEBANK.EXT.  However,
  312. the more there are to process the longer it will take RATS to load since
  313. RATS looks for and processes this file each time it is loaded. Once the
  314. file has been processed, it is removed.
  315.  
  316.  
  317.  
  318. RATSMIN.TXT  - Minimum Security to Access RATS
  319. -----------------------------------------------------------------------------
  320. If a user fires up RATS and has a security level less than the Minimum
  321. Security value defined in RATSCFG, the text file RATSMIN.TXT is displayed,
  322. if it exists in the directory containing RATS.EXE.  If this file does not
  323. exist, a one-line message will be displayed.  The user is then returned to
  324. the BBS.
  325.  
  326. This is useful for Sysops who would like to tell users how to get access to
  327. RATS if their security level is not high enough.  The Sysop can then set the
  328. security level on the menu entry that calls RATS to a lower level than what
  329. is actually required to have access to it.
  330.  
  331.  
  332.  
  333. ╒═════════════════════════════════════════════════════════════════════════════╕
  334. │░░░░░░ SUPPORT ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  335. ╘═════════════════════════════════════════════════════════════════════════════╛
  336.  
  337. All support will be handled through the SoftNet support, Please See SUPPORT.DOC
  338. for the closest Support system to you.
  339.  
  340. If you have any helpful comments, suggestions or bug reports, please feel
  341. free to contact us.
  342.  
  343. We also have available, a SoftNet / Info System Technology, Inc. support echo,
  344. which is carried on the Fido BackBone.  Tag Name is MCSOFT or SOFTNET
  345.  
  346. If you use RATS for 60 days, you are required to register it or remove it
  347. from your system.
  348.  
  349. Please support us, so we may continue to support you....
  350.  
  351.  
  352.