home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 8 / CDASC08.ISO / VRAC / BUYADOOR.ZIP / BUYADOOR.DOC < prev    next >
Text File  |  1993-08-23  |  13KB  |  331 lines
  1.  
  2.  
  3.                             Buy-A-Door
  4.  
  5.                              v0.05ß
  6.  
  7.                                by
  8.  
  9.                           Mike Liddekee
  10.  
  11.                             
  12.                            Support BBS
  13.                          Prime Base BBS
  14.                          (804) 587-4289
  15.                          (804) 587-4382
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.                             OVERVIEW
  23.                             --------
  24.  
  25. Buy-A-Door is a stand-alone program that can be executed after
  26. every Door program completes and before it returns to your BBS. 
  27. It will display a message that encourages your callers to donate
  28. to the BBS by adopting a given door or group of doors and having
  29. his/her name displayed every time the particular door is
  30. executed. There are 2 options available with Buy-A-Door:
  31.  
  32.    OPTION 1, UNREGISTERED version, will display a hard-coded      
  33.    (non-changeable) message describing the Adopt-A-Door concept   
  34.    to your callers. The REGISTERED version will allow you to      
  35.    create your own message (10 lines, 62 characters per line).
  36.  
  37.    OPTION 2 will display the names of the callers (max of 6) that 
  38.    have contributed to the registration of that particular door.  
  39.    This file is an  ASCII file you create with the names of the 
  40.    callers (Max 30 char/name). The name of the file is your       
  41.    choice, but the name must match with the name in the           
  42.    configuration file.
  43.  
  44.  
  45.  
  46.   
  47.  
  48.  
  49. NOTE: Runtime errors will be logged to a file called DFRAME.ERR   
  50.       which is created in the directory you run the door from.
  51.  
  52.  
  53.  
  54.      
  55.                           INSTALLATION
  56.                           ------------
  57.  
  58. Installation is fairly easy and straight-forward. The following
  59. steps and examples should have you up and running in a very short
  60. period of time.  It is assumed that you are familiar with setting
  61. up DOORS on your system.  To this end, only examples of the
  62. configuration file and Door batch file are described.
  63.  
  64.       1) Create a directory to hold all Buy-A-Door files
  65.  
  66.       2) Unzip BUYADOOR.ZIP into the the above directory
  67.  
  68.       3) Create a configuration file, with a name of your choice, 
  69.          or modify the supplied ADOPT.CFG file. A description     
  70.          follows:
  71.  
  72.         *   C:\PCB\DOOR.SYS          Location of system files     
  73.                                      (see below)
  74.             YOUR BBS NAME            Your BBS Name
  75.             Mike                     Sysop's First Name
  76.             Liddekee                 Sysop's Last Name
  77.  
  78. |---------------------------------------------------------------|
  79. | READ!     1          CommPort  \ These 2 lines are required   |
  80. | READ!     1          Node #    / ONLY for GTUSER.BBS          |
  81. |---------------------------------------------------------------|
  82.  
  83.         $   1                        1=Initial Message Display
  84.                                      2=Display Callers Names That 
  85.                                        Contributed
  86.         $   ADOPT.DOR                File Name Containing Initial 
  87.                                      Display
  88.         $   THANK.YOU                     File Name Containing    
  89.                                           Contributing Callers
  90.         $   30                       Number of SECONDS To Keep    
  91.                                      Msg On Screen
  92.       ! $   0                        Security level that will     
  93.                                      bypass the DOOR
  94.       ! $   0                        Security level that will     
  95.                                      bypass the DOOR
  96.       ! $   0                        Security level that will     
  97.                                      bypass the DOOR
  98.       ! $   0                        Security level that will     
  99.                                      bypass the DOOR
  100.       ! $   0                        Security level that will     
  101.                                      bypass the DOOR
  102.        
  103.         * = Replace with ONE of the following:
  104.  
  105. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using      
  106.                                    PCBOARD.SYS only
  107. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to 
  108.                                    v3.0)
  109. C:\BBS\DOOR.SYS                 <- For ANY systems that support   
  110.                                    DOOR.SYS 
  111. C:\BBS\DORINFOx.DEF             <- For ANY systems that support   
  112.                                    DORINFOx.DEF
  113. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  114. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  115. C:\BBS\GTUSER.BBS               <- For GT Power (if using this    
  116.                                    option you must put the        
  117.                                    ComPort # on line 5 and the    
  118.                                    Node # on line 6 of the        
  119.                                    configuration file)
  120.  
  121.  
  122.  
  123.         $ = Requires registration to change to a different value
  124.         ! = If callers Security level matches any one of these    
  125.         levels, Buy-A-Door will bypass the registeratio screens
  126.  
  127.  
  128.       4) Add Buy-A-Door to the batch file that runs the Door,      
  129.          after whose completion you want the Buy-A-Door message    
  130.          to be displayed. An example of the Door we want to run   
  131.          Buy-A-Door after:
  132.  
  133.             ECHO OFF
  134.             CD\PCB\DOORS\PROGRAM      Location of Door Files
  135.             DOOR DOOR.CFG             EXE filename and CFG        
  136.                                       filename
  137.             CD\PCB\DOORS\ADOPTME      Location of ADOPT Files
  138.             ADOPTME! ADOPTME!.CFG     EXE and CFG Filename        
  139.                                       created in #3 above.
  140.             CD\PCB
  141.             BOARD
  142.  
  143.  
  144.        5) When running in more than one node, be sure to supply a
  145.           different configuration name for each node (your choice 
  146.           of name).
  147.  
  148.        6) If running with multi-port boards add /FD to the line   
  149.           containing the CFG name as follows:
  150.  
  151.                         ADOPT Adopt.CFG /FD
  152.  
  153.  
  154.                     NON-STANDARD COM SUPPORT
  155.                     ________________________
  156.  
  157.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 =     
  158.       IRQ4 and COM2/COM4 = IRQ3. If you wish to use a             
  159.       non-standard IRQ, add the IRQ number after the              
  160.       configuration filename. Let's assume your Door is called    
  161.       FOOBAR and you want to use COM1 and IRQ5. The command line
  162.       
  163.       passed to your Door would be:
  164.  
  165.                       FOOBAR FOOBAR.CFG /5
  166.  
  167.       The /5 tells FOOBAR to use IRQ5 rather than the standard    
  168.       IRQ4 that is normally used with COM1. No /x parameter is    
  169.       needed for the standardIRQ's.
  170.  
  171.       As an alternative, you may use an environmental variable on 
  172.       the command line. To use the variable (following the        
  173.       example above), place a SET IRQ=5 in the batch file used to 
  174.       bring up your BBS (you would need a different IRQ number    
  175.       for each node). The command line would now look like this:
  176.  
  177.                     FOOBAR FOOBAR.CFG /%IRQ%
  178.  
  179.       This, in combination with the use of the environmental      
  180.       variables described in the MULTI-NODE SETUP section will    
  181.       allow you to use one batch file and one config file to run  
  182.       this door on all nodes.
  183.  
  184.  
  185.  
  186.  
  187.                            MULTI-NODE SETUP
  188.                            ________________
  189.  
  190.       Buy-A-Door Multi-Node capable. Each node must have the
  191.       ability to access a configuration file which will have its  
  192.       own system file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc)  
  193.       defined on the first line. There are 2 ways to accomplish   
  194.       this:
  195.  
  196.       (1) Create a separate configuration file for each node. The 
  197.           only difference between each file would be the location 
  198.           of the system file for that particular node. For        
  199.           example, on my system there are 2 nodes and the first   
  200.           line of the config files would look like this:
  201.  
  202.                         NODE1:  C:\PCB1\DOOR.SYS
  203.                         NODE2:  C:\PCB2\DOOR.SYS
  204.  
  205.           Thus, if you have a 4 node BBS, you will need 4         
  206.           configuration files.
  207.  
  208.       (2) Use ONE configuration file for ALL nodes. This Door     
  209.           will recognize the following PCBoard environmental      
  210.           variables:
  211.  
  212.                  PCBDIR    (Directory containing the System file)
  213.                  PCBDRIVE  (Drive containing the System file)
  214.  
  215.           Thus, the first line of the SINGLE configuration file,  
  216.           
  217.           for this Door would look like this:
  218.  
  219.                    %PCBDRIVE%%PCBDIR%\DOOR.SYS
  220.  
  221.       NOTE: This option, as described, assumes that you are       
  222.       running PCBoard 14.5a software. The environmental variables 
  223.       are automatically created by the software for each node.
  224.  
  225.       HOWEVER, if you are running other BBS software you should   
  226.       be able to set the variables EXACTLY as described below,    
  227.       for EACH node (more than likely in each batch file you use  
  228.       to bring up EACH node):
  229.  
  230.                             PCBDRIVE=C:
  231.                             ^^^^^^^^^
  232.                             PCBDIR=\NODE2
  233.                             ^^^^^^^^
  234.  
  235.       Info with a carat (^) under it, MUST be typed as is. The    
  236.       rest depends on your naming conventions.  This, in          
  237.       combination with the use of the optional environmental
  238.       variable described in the NON-STANDARD COM SUPPORT section, 
  239.       will allow you to use one batch file and one config file to 
  240.       run this door on all nodes.
  241.  
  242.  
  243.  
  244.                            LEGALITIES
  245.                            __________
  246.  
  247.  
  248.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED    
  249.       "AS IS" WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY,    
  250.       INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF      
  251.       MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO 
  252.       EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND           
  253.       PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  254.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE   
  255.       THEREOF OR BREACH OF ANY WARRANTY.
  256.  
  257.  
  258.  
  259.                           DISTRIBUTION
  260.                           ____________
  261.  
  262.    You may make this file available for downloading from your BBS 
  263.    or you may upload it to any BBS of your choice, provided that  
  264.    you do not make any changes to the contents of the archive     
  265.    (ZIP file). The archive and its individual contents may not be 
  266.    used by any service that charges any money whatsoever, without 
  267.    the written permission of the author.
  268.  
  269.  
  270.  
  271.                           REGISTRATION
  272.                           ____________
  273.  
  274.    I am not a subscriber to the "Crippleware" concept, and this   
  275.    program reflects that philosophy. This is a full-featured      
  276.    program, whose functionality is not hampered in any way,       
  277.    whether you register it or not.  Registration and the receipt  
  278.    of your KEY file into the Buy-A-Door directory allows for the   
  279.    changing of certain default values in the configuration file.
  280.  
  281.    To register your copy of Buy-A-Door, please fill out the        
  282.    registration form (REGISTER.FRM) and mail it along with the    
  283.    registraiton fee to the name and address on the form. MUST be  
  284.    payable in US funds!!!!
  285.  
  286.    Be sure to use the proper upper/lower case when filling in     
  287.    your name and BBS name, as they MUST match the way you entered 
  288.    them in the configuration file. ^^^^ 
  289.  
  290.    Based upon information supplied on the registration form, I    
  291.    will pre-register you on the BBS. You will then be able to     
  292.    call Prime Base and pick up your KEY file or you may include a 
  293.    Self-Addressed stamped disk mailer and and I will send         
  294.    you the KEY file back by return mail along with the latest     
  295.    version of Buy-A-Door.
  296.  
  297.  
  298.  
  299.  
  300.                               MISC
  301.                               ____
  302.  
  303.    The latest version of Buy-A-Door and other fine door programs,  
  304.    are always available for download from Prime Base BBS at 
  305.    (804) 256-587-4289 or (804) 587-4382 .  Join conference #1 to
  306.    download the latest releases.  You may also download doors by
  307.    William Rountree, sysop of Prime Base BBS
  308.  
  309.    Remember, should you have any problems, questions or           
  310.    suggestions, be sure to drop me a message on the              
  311.    aforementioned BBS or call me voice at (501) 268-1431 anyday!
  312.  
  313.  
  314.                         ACKNOWLEDGEMENTS
  315.                         ----------------
  316.  
  317.    I would like to thank the following for their help with my 
  318.    programming:
  319.  
  320.         William Rountree - Without his help this and other 
  321.                            programs would not be possible.
  322.                            Thanks William!!
  323.  
  324.         Cam DeBuck       - For his help with some of the coding.
  325.                            Thanks Cam!!
  326.  
  327.         Mike Wilson      - For his help with some of the coding
  328.                            also.  Thanks Mike!!
  329.  
  330.    And to the late Ted Freeman for an outstanding Door Library.
  331.