home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / DOOR / CLASAD20.ZIP / CLASSAD.DOC < prev    next >
Text File  |  1994-11-02  |  9KB  |  226 lines
  1.                                CLASSAD v2.0 
  2.                         (C)1994 Heavenware Software
  3.  
  4.   
  5.   WARRANTY:
  6.   ---------
  7.   CLASSAD is distributed without warranty. In no event will Heavenware 
  8.   Software be liable to you for damages, including any loss of profits, 
  9.   lost savings, or other incidental or consequential damages arising out 
  10.   of your use of or inability to use this program, even if Heavenware 
  11.   Software, or an authorized representative have been advised of the 
  12.   possibility of such damages. Heavenware Software will not be liable 
  13.   for any such claim by any other party. Every possible means has been 
  14.   used to ensure the integrity of this program.
  15.  
  16.  
  17.   SHAREWARE CONCEPT: 
  18.   ------------------
  19.   CLASSAD is distributed as shareware, and may be used up to 30 days 
  20.   as a trial period, after which, you must either register this program 
  21.   by sending $10.00 U.S. dollars  to:
  22.                           Heavenware Software
  23.                           P.O. Box 9824
  24.                           Dyess AFB, Tx # 79607-9824
  25.   or stop using it.
  26.  
  27.   
  28.   REG BENEFITS:  
  29.   ------------
  30.   With the key in place, your users will have access to all the categories  
  31.   you have defined in the CAT.CTL file. 
  32.   
  33.   The 5 sec delay at the end of the program will be bypassed. 
  34.   
  35.   The maintenance utility will be operational. 
  36.   
  37.   And you'll have the pleasure of knowing that you have helped support one
  38.   of the upcoming leaders in the shareware programming world.
  39.  
  40.   
  41.   REMEMBER, once registered, always registered, but to obtain any new 
  42.   releases or updates you must call one of our boards. 
  43.   Seventh Heaven @ 1-915-698-9514 / Fido 1:392/20
  44.   Rapid Output   @ 1-915-695-6488 / Fido 1:392/27
  45.  
  46.    
  47.   We have always tried to support our products as much as is humanly 
  48.   possible, and will continue to do so, so please... if you need help, 
  49.   contact us, even if you are not registered!
  50.  
  51.  
  52.   COPYRIGHTS:
  53.   -----------
  54.   CLASSAD is (c)1994 Heavenware Software and was written in Turbo Pascal 
  55.   7.0, Copyright (c)1992 Borland International, using RMdoor (c)1991-1994 
  56.   By Mark Goodwin and Randy Hunt. 
  57.  
  58.   
  59.   INSTALLATION:
  60.   -------------
  61.   1. Unzip the archive into any dir.
  62.   
  63.   2. Then edit CLASSAD.cfg file to suit your board.
  64.  
  65.        Line 1: Door data file type
  66.        Line 2: Path to the door data file(s)
  67.        Line 3: BBS Name
  68.        Line 4: Sysop's Name
  69.        Line 5: Locked Baud Rate
  70.  
  71.      As illustrated above, the door's data file type is specified in line 1
  72.      and can be PCB for PCBoard, GAP for GAP (DOOR.SYS), SF for Spitfire,
  73.      RBBS for RBBS, WC for Wildcat!, TRIBBS for TriBBS, or WWIV for WWIV.
  74.  
  75.      NOTE: RoboBOARD Sysops, use GAP.
  76.      
  77.      The Locked baud rate is specified in line 5. If the sysop doesn't
  78.      lock his serial port, he must specify 0 for the locked baud rate
  79.      NOTE: Although many door formats do pass the locked baud rate in the
  80.      door data files, some older formats such as RBBS do not. For
  81.      conformity, CLASSAD requires that you specify the locked baud rate
  82.      in line 5 and ignores any value passed in the door data files.
  83.  
  84.      The following is a sample door configuration file:
  85.  
  86.      GAP
  87.      C:\ROBOFX\TEMP_#
  88.      Seventh Heaven
  89.      Heavenware Software
  90.      57600
  91.  
  92.      CLASSAD can be run locally without a door data file by specifying
  93.      /L after the configuration file parameter in the DOS command line.
  94.  
  95.      Example:
  96.      Clasad20 Classad.cfg /l
  97.      
  98.      Non standard IRQs can be used with CLASSAD by specifying the IRQ number 
  99.      after the "config" parameter in the command line used to run the door.
  100.  
  101.      Example:
  102.      CLASSAD CLASSAD.CFG IRQ
  103.  
  104.  
  105.      
  106.   SPECIAL KEYS:
  107.   -------------
  108.   While the door is running, the sysop can press certain special keys to
  109.   perform a variety of functions. The following is a list of the
  110.   functions that these keys perform:
  111.  
  112.      Key(s)           Function
  113.  
  114.      HOME             Toggles between the user status window and a help
  115.                       display that lists the special keys.
  116.  
  117.      F6               Takes 5 minutes away from the caller.
  118.                       NOTE: This will NOT be returned to BBS.
  119.  
  120.      F7               Gives 5 minutes to the caller.
  121.                       NOTE: This will NOT be returned to the BBS.
  122.  
  123.      F9               Quit the door and return the caller to the BBS.
  124.  
  125.      F10              Enter chat mode. Pressing the ESC key exits the
  126.                       chat mode.
  127.  
  128.      Alt+D            Drop to DOS.
  129.  
  130.  3. Edit or create the CAT.CTL file. This file must exist for CLASSAD to  
  131.     run properly. You may change it in anyway you wish with the following
  132.     exceptions.
  133.      
  134.      a.) The unregistered version will only use the first category listed,
  135.          so you may not want to waste your time creating more than one until
  136.          you register.
  137.  
  138.      b.) The MAXIMUM number of categories is 20. If you have more they just
  139.          won't be read into CLASSAD.
  140.  
  141.      c.) Each description may not be longer than 20 characters long.
  142.  
  143.     The .CTL file is a straight ASCII text file, so you may edit it with
  144.     almost any text editor. Just make sure you do a CR after each item is
  145.     entered.
  146.  
  147.  4. Create the appropiate batch files that will run CLASSAD.
  148.  
  149.  5. Edit your BBS structure to put CLASSAD on the menu(s).
  150.  
  151.  
  152.  
  153.   MULTI-NODE SETUP:
  154.   -----------------
  155.   Although CLASSAD was not specifically written as a multi-node door, it
  156.   can be run on a multi-node BBS. The basics of "HOW TO" are this:
  157.  
  158.   a.) You'll need to create separate batch files for each node.
  159.       and within each batch file have it look for a empty file that will
  160.       be created when a user enters the door.
  161.       If the file exists then redirect the user to a utility door that
  162.       will inform them that the door they wanted to enter was being used
  163.       by another node. One such utility exists. We wrote one a while back,
  164.       and it is available for download or FREQ. Filename: TRISCR.ZIP.
  165.       TRISCR is just another door but all it does is looks for a screen 
  166.       that you have specified and displays it. TRISCR supports RIP, ANSI,
  167.       & ASCII style screens. And the best part is it's FREE.
  168.  
  169.       Here's a sample of one of my batch files for Node 1:
  170.       @echo off
  171.       d:
  172.       CD\ROBOFX\DOORS\DOORX
  173.       if exist busy2.flg goto inuse        <-- Checks for any other .flg
  174.       echo > busy1.flg                     <-- Creates the flag for node 1
  175.       CLASAD20 CLASSAD1.CFG                <-- Runs door using node 1 .cfg
  176.       del busy1.flg                        <-- Deletes the flag after use
  177.       goto done                            <-- redirects batch file
  178.  
  179.       :inuse                               <-- If door is already being used
  180.          cd\robofx
  181.          busy1                             <-- Batch file that runs TRISCR.
  182.   
  183.       :done
  184.          cls
  185.  
  186.   b.) You will also need to create seperate .cfg files unless all the paths
  187.       and locked baud rates are the same for all nodes.
  188.  
  189.       This may all sound difficult, but it really isn't that hard.
  190.       Depending on your setup and the BBS software you are running, all
  191.       of this may or may not be necessary.
  192.  
  193.       If you are asking why we didn't write all this into the program, I
  194.       have the answer. Because if the user drops carrier while inside the
  195.       door, and the door was supposed to delete the busy.flg, the .flg 
  196.       file will not get deleted and the next user who calls and tries to 
  197.       enter the door will not be able to. So although it is a little harder 
  198.       this way, you win in the end.
  199.  
  200.       If there are any other questions concearning Multi-Node setup,
  201.       don't hesitate to ask. We may not beable to help, but we'll sure try.
  202.  
  203.    
  204.    UPGRADE INFO:
  205.    -------------
  206.    If you are upgrading from v1.2, you will need to do a complete fresh
  207.    install with the exception of the classad.cfg file.
  208.    
  209.  
  210.    IMPORTANT NOTES:
  211.    ----------------
  212.    Upon a caller placing an Ad, CLASSAD will create the appropiate .dat 
  213.    file for that category,
  214.  
  215.    Do NOT attempt to edit these yourself through a text editor. You could 
  216.    corrupt the file making them completely useless to CLASSAD.
  217.    Instead use the CAMAINT.EXE utility that came with this archive.
  218.  
  219.    If after installing CLASSAD, you wish to edit the CAT.CTL file, you will
  220.    need to delete ALL of the .dat files that exist in that directory.
  221.    If you do not, possible .dat file corruption could result. So the best
  222.    thing to do is to make sure you have all the categories you want listed
  223.    in the CAT.CTL before allowing user access to CLASSAD.
  224.    
  225.    - END OF FILE -
  226.