home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 15 / CD_ASCQ_15_070894.iso / vrac / ripdor11.zip / RIPDOOR.DOC < prev    next >
Text File  |  1994-06-12  |  15KB  |  388 lines
  1. == RIPDOOR.DOC ============================================================= 
  2.                                  RIPDOOR            
  3.                        Version 1.1 -- June 12, 1994
  4. ===========================================================================  
  5.    
  6.                                 Description    
  7.         
  8.     The purpose of this door is to allow the BBS user to download a RIP
  9.     compatible terminal program, and the ICON package for your BBS, if used.
  10.     If a caller logs on to your BBS without RIP graphics s/he is allowed
  11.     to download the RIP terminal program of your choice.  The user may also
  12.     download or update the RIP ICON package from your system, via Xmodem,
  13.     Ymodem or Zmodem.   If the user is using a RIP terminal program when 
  14.     s/he calls, they are allowed to download the RIP ICON package only. 
  15.     RIPDOOR will automatically sense if the user is already using RIP 
  16.     graphics.  
  17.  
  18.     RIPDOOR is used where any normal BBS door is used.  Many BBS's offer
  19.     special log-on doors for new users.  This is an EXCELLENT place to put
  20.     this door.  Other BBS's offer main menu options.  This would be another
  21.     good place to put the door.  Or, you can simply add this to your regular
  22.     door menu.
  23.  
  24.     RIPDOOR is an online BBS Door that works on almost any BBS.  RIPDOOR is
  25.     compatible with systems that use PCBOARD.SYS, USERS.SYS,  DOOR.SYS,         
  26.  
  27.     CALLINFO.BBS, USERINFO.DAT, SFDOORS.DAT, GTUSER.BBS, TRIBBS.SYS, 
  28.     CHAIN.TXT or DORINFOx.DEF for interfacing to the BBS.    
  29.     
  30.     RIPDOOR was written in Microsoft QUICKBASIC (tm) 4.5, and utilizes some
  31.     of the routines contained in Tom Hanlin's PBClone library, and the late
  32.     Ted Freeman's DOORFRAME library.  The COM routines are handled by the       
  33.     QBSerial I/O library.
  34.     
  35.     This product is provided "as is" without warranty of any kind. The entire 
  36.     risk as to the results and  performance of the program is assumed by you. 
  37.     Furthermore, the  author does  not warrant, guarantee, or  make any  other 
  38.     representations regarding  the use of,  or the  results of the use of the 
  39.     program,  and you  rely on the  program and  results  solely at  your own 
  40.     risk.  The author  cannot and  will not accept  responsibility for system 
  41.     damage, loss of profit, or any other special, consequential or incidental 
  42.     damages  resulting  from  the  use  or  inability  to  use this  product. 
  43.     
  44.                                    Copyright    
  45.     
  46.     RIPDOOR by Bill Watts is being distributed as Shareware.  Under this 
  47.     concept you may use the SHAREWARE (unregistered) version for a reasonable 
  48.     period of time for evaluation after which you must either register your 
  49.     copy or discontinue usage.  (A reasonable time would be 30 days).  
  50.     
  51.                                  Distribution    
  52.     
  53.     You are encouraged to distribute RIPDOOR provided that all files 
  54.     contained in the archive are distributed in their original and unmodified 
  55.     state.    
  56.     
  57.                                  
  58.  
  59.                                  Registration
  60.  
  61.      You may register this program by sending the recommended donations 
  62.      at the end of this document.  A form is attached for your convenience.
  63.      When you register, all "crippled" options are made functional.  After
  64.      you register, all upgrades are issued at no charge.
  65.      
  66.  
  67.  
  68.  
  69. STEP 1 -- INSTALLATION  
  70.  
  71.      Use PKUNZIP to unpack the original archive into your BBS directory. 
  72.      In the archive you should find:
  73.         
  74.         1). RIPDOOR.EXE  -  The main executable.
  75.         2). RIPDOOR.DOC  -  This DOC file.
  76.         3). RIPDOOR.CFG  -  A sample configuration file.
  77.         4). SAMPLE.BAT   -  A sample door batch file.
  78.         5). FILE_ID.DIZ  -  A brief BBS description.     
  79.         
  80.      RIPDOOR requires NO COMPORT redirection!  Do NOT use DOORWAY, GATEWAY
  81.      or any other program to redirect the output.  All of the COMPORT 
  82.      routines are built right into RIPDOOR.
  83.  
  84. STEP 2 -- SETTING THE DSZ ENVIRONMENT 
  85.      First, you must have a copy of DSZ.EXE or DSZ.COM in your DOS path. 
  86.      YOU MUST SET THE DSZ ENVIRONMENT TO GET THE FILE TRANSFERS TO 
  87.      OPERATE PROPERLY.  RIPDOOR is smart enough to sense the port 
  88.      desigation and speed IF you set the DSZ environment.
  89.  
  90.      To set the DSZPORT environment, include a SET statement in your
  91.      AUTOEXEC.BAT file or the file that invokes your BBS.  Here is a look 
  92.      at my HOST.BAT for my GT system: 
  93.  
  94.      @ECHO OFF  
  95.      c: 
  96.      cd\gt 
  97.      SET GTPATH=C:\GT 
  98.      SET DSZPORT=1                <--------- DSZPORT Environment setting. 
  99.      GT1800 *xxxx-xxxx host.scr 
  100.  
  101.      IMPORTANT:  Multi-node systems must always set the DSZ environment
  102.      for each node.   This is done best in the batch file that invokes
  103.      your BBS software for that particular node.
  104.  
  105.      The GSZ protocol works just as well as DSZ protocol for transferring 
  106.      the RIPDOOR data files and may be used in lieu of DSZ, however the  
  107.      SET PATH statement is STILL DSZPORT='n', not GSZPORT.  To use the
  108.      GSZ protocol, simply rename it DSZ.
  109.  
  110.  
  111.  
  112. STEP 3 -- CREATE A CONFIGURATION FILE   
  113.      
  114.  
  115.      For NON-GT Power systems, your configuration should look similar to 
  116.      this:  
  117.  
  118. C:\GT\GTUSER.BBS   ; LINE 1 USER FILE 
  119. NetComm BBS        ; LINE 2 NAME OF BBS 
  120. Bill               ; LINE 3 SYSOP FIRST NAME 
  121. Watts              ; LINE 4 SYSOP LAST NAME 
  122.                    ; LINE 5 COM PORT FOR GT SYSTEMS ONLY     
  123.                    ; LINE 6 NODE NUMBER FOR GT SYSTEMS ONLY 
  124. C:\GT\RIPTM153.EXE ; LINE 7 COMPLETE PATH AND FILENAME OF RIP COMM PROGRAM
  125. 581                ; LINE 8 APPROXIMATE SIZE (KB) OF RIP COMM PROGRAM 
  126. C:\GT\ICONS.ZIP    ; LINE 9 COMPLETE PATH AND FILENAME OF ICON PACKAGE
  127. 10                 ; LINE 10 APPROXIMATE SIZE (KB) OF ICON PACKAGE
  128. 03241              ; LINE 11 YOUR REGISTERED SERIAL NUMBER
  129. B12F-G42F          ; LINE 12 YOUR REGISTERED "KEY" CODE
  130. C:\GT\RIPDOOR.LOG  ; LINE 13 COMPLETE PATH AND FILENAME TO LOG FILE
  131.  
  132.  
  133. NOTE: There are 2 additional lines necessary when using GTUSER.BBS. Since 
  134.       this file does not provide the ComPort% and NodeNum% variables, 
  135.       both variables will default to 1.    
  136.       ALL others systems should have a blank line on lines 5 and 6, but
  137.       beware the lines DO need to be there.   
  138.  
  139.       For GT Power systems, your configuration should look similar to this: 
  140.  
  141.  
  142. C:\GT\GTUSER.BBS   ; LINE 1 USER FILE 
  143. NetComm BBS        ; LINE 2 NAME OF BBS 
  144. Bill               ; LINE 3 SYSOP FIRST NAME 
  145. Watts              ; LINE 4 SYSOP LAST NAME 
  146. 1                  ; LINE 5 COM PORT FOR GT SYSTEMS ONLY     
  147. 1                  ; LINE 6 NODE NUMBER FOR GT SYSTEMS ONLY 
  148. C:\GT\RIPTM153.EXE ; LINE 7 COMPLETE PATH AND FILENAME OF RIP COMM PROGRAM
  149. 581                ; LINE 8 APPROXIMATE SIZE (KB) OF RIP COMM PROGRAM 
  150. C:\GT\ICONS.ZIP    ; LINE 9 COMPLETE PATH AND FILENAME OF ICON PACKAGE
  151. 10                 ; LINE 10 APPROXIMATE SIZE (KB) OF ICON PACKAGE
  152. 03241              ; LINE 11 YOUR REGISTERED SERIAL NUMBER
  153. B12F-G42F          ; LINE 12 YOUR REGISTERED "KEY" CODE
  154. C:\GT\RIPDOOR.LOG  ; LINE 13 COMPLETE PATH AND FILENAME TO LOG FILE
  155.  
  156.  
  157.         In the examples above, lines 7 and 9 point to the path and filename 
  158.         of your choice.  You may point to ANY filename and ANY directory.  
  159.         Line 7 will allow the user to download the RIP terminal program of 
  160.         your choice.  Line 9 will allow your users to download any special 
  161.         ICON package for your BBS.  If you do not use a special ICON package
  162.         for your BBS, you enter a "N/A" (without quotes) on line 9.  If you
  163.         choose NOT to have a log file, you may enter a "N/A" on line 13 of
  164.         the configuration file.
  165.  
  166.  
  167. NOTE:  IT IS YOUR RESPONSIBILITY TO MAKE SURE YOU ALWAYS HAVE A CURRENT ICON
  168.        PACKAGE FOR THE USER.  MAKE SURE THE PATH AND FILENAMES OF THE FILES
  169.        ACTUALLY EXIST!  RIPDOOR can only send what you tell it to send.
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.        
  180.  
  181.  
  182.  
  183.         Allowable BBS user types:     
  184.  
  185. PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only 
  186. USERS.SYS                <- For PCBoard systems using USERS.SYS    
  187. CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)    
  188. CHAIN.TXT                <- For WWIV systems    
  189. GTUSER.BBS               <- For GT Power systems    
  190. USERINFO.DAT             <- For Wildcat! 3.x+ systems.    
  191. DOOR.SYS                 <- For systems that support DOOR.SYS    
  192. DORINFOx.DEF             <- For QBBS/RBBS/RA. Replace x with Node #. 
  193. SFDOORS.DAT              <- For Spitfire systems.    
  194. TRIBBS.SYS               <- For TriBBS systems.    
  195.  
  196.      NOTE: See Miscellaneous Notes for info on using Environment Variables. 
  197.  
  198.  
  199.  
  200. STEP 4 -- CREATE A DOOR BATCH FILE 
  201.      
  202.      This is probably one of the easiest doors you'll ever setup.  If your 
  203.      RIPDOOR files reside in the directory C:\BBS, you simply call your batch 
  204.      file like this: 
  205.  
  206.      @echo off 
  207.      C: 
  208.      CD\BBS 
  209.      RIPDOOR RIPDOOR.CFG (or whatever .CFG name you would like)
  210.      ---------   (some systems use a return to BBS statement here) 
  211.  
  212.         That's it.  If your RIPDOOR.CFG file is set up properly, your 
  213.         new door SHOULD work.  
  214.   
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228. Fossil Driver Support    
  229. ---------------------    
  230. RIPDOOR supports the use of Fossil drivers.  To tell your Door to use the 
  231. Fossil driver instead of the standard COM ports, just put /FD on the command 
  232. line when running the door. For example:    
  233.    RIPDOOR RIPDOOR.CFG /FD    
  234. indicates that a Fossil driver is present and should be used. If no Fossil  
  235. driver is detected, RIPDOOR will print a message to that effect 
  236. and exit the door gracefully.    
  237.    
  238. RIPDOOR supports COM 0-15 on the standard IRQ's -  
  239.  
  240.      COM1/COM3 = IRQ4 and    
  241.      COM2/COM4 = IRQ3.   
  242.  
  243. If you wish to use a non-standard IRQ, add the IRQ number after the   
  244. configuration filename.  Let's assume your Door is called RIPDOOR and you  
  245. want to use COM1 and IRQ5. The command line passed to your Door would be:    
  246.  
  247.     RIPDOOR.CFG /5  or    
  248.     RIPDOOR.CFG /%IRQ%  for the environment variable.    
  249.  
  250. The /5 tells RIPDOOR to use IRQ5 rather than the standard IRQ4 that is 
  251. normally used with COM1. No /x parameter is needed for the standard IRQ's.    
  252.  
  253. Environment Variables    
  254. ---------------------    
  255. When specifying the location of the system file on line 1 of the doors .CFG    
  256. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%, 
  257. and %wcnodeid%. Some examples:    
  258.   
  259.  PCBoard:     
  260.    USERS.SYS in C:\PCB         - %pcbdrive%%pcbdir%\USERS.SYS    
  261.    USERS.SYS in C:\PCB\NODE1   - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS 
  262.     
  263.  Wildcat!:    
  264.    USERINFO.DAT in C:\WC\NODE1   - C:\WC\NODE%wcnodeid%    
  265.     
  266. Non-PCBoard systems may use the PCB environment variables by setting them    
  267. in either AUTOEXEC.BAT or in the batch that runs the door. For example:    
  268.  SET PCBDRIVE=C:    
  269.  SET PCBDIR=\BBSDIR    
  270.  SET PCBNODE=1    
  271.  
  272. NOTE: Your configuration file does not need to be called RIPDOOR.CFG.  
  273.       That name was just used in these docs for an example.  You may name
  274.       your .CFG anything you like.  Multi-node systems may use RIPDOOR1.CFG,
  275.       RIPDOOR2.CFG, etc.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.       
  282. Special Commands
  283. ----------------
  284.  
  285.       There are also several Sysop commands while in the door.  Some are 
  286.       active and some are not, though they may be activated in later 
  287.       versions.
  288.       
  289.       HELP = HOME key
  290.         F3 = Print          [NOT ACTIVE]
  291.         F4 = Page           [NOT ACTIVE]
  292.         F5 = Shell to DOS   [ACTIVE] 
  293.         F7 = Alarm          [NOT ACTIVE]
  294.         F8 = Dump User      [ACTIVE]  (Dumps user from Door NOT BBS)
  295.         F9 = Toggle Display [ACTIVE]
  296.        F10 = Chat           [ACTIVE]  ("ESCAPE" ends Chat mode)
  297.   ARROW UP = Increase Users Time
  298. ARROW DOWN = Decrease Users Time
  299.  
  300.       RIPDOOR features HOT keys so the ENTER key is rarely used.
  301.  
  302.   
  303. STEP 5 -- PROBLEMS...  
  304.  
  305.        Any questions or problems can be sent directly to me at NetComm BBS 
  306.        via NetMail from a GT Power netmail system or any FIDO network BBS. 
  307.        Here are my netmail addresses:
  308.  
  309.                GT Address      =   046/004 
  310.                FIDONET Address =   1:104/603.0
  311.                FISHNET Address =   21:69/403.0
  312.  
  313.  
  314.  Program Notes:  
  315.      
  316.      The RIPDOOR door has been tested on MSDOS 3.0, 3.2, 3.3, 3.31 (Compaq), 
  317.      4.01, 5.0, 6.0, 6.2, PCDOS 6.1, DR. DOS 6.0, and Novell DOS 7.0. It has
  318.      been tested under DESQview 2.61, DESQview/X, Windows 3.1, under both 
  319.      Lantastic and Novell environment and seems to work fine on multi-node 
  320.      systems.  It has not been tested on  OS/2 but should work.  DESQview 
  321.      users should make sure that DVANSI.COM is running in the door batch 
  322.      file before RIPDOOR is used.  The DOOR.SYS used by RIPDOOR is the 
  323.      standard 52 line GAP (tm) file, NOT the DOOR.SYS file produced by 
  324.      DOORWAY.  The CALLINFO.BBS used by RIPDOOR currently contains 
  325.      36 lines.   
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.                               REGISTRATION: 
  343.  
  344.           Your name _____________________________________ 
  345.  
  346.      Street Address _____________________________________ 
  347.  
  348.                City ____________________________ State __ 
  349.  
  350.            ZIP Code __________________ 
  351.  
  352.            Voice phone number ___________________________ 
  353.  
  354.            BBS phone number _____________________________ 
  355.  
  356.            BBS Name _____________________________________ 
  357.            (Please show EXACT spelling and make sure upper and  
  358.            lower case letters are listed correctly.) 
  359.  
  360.            BBS Software / Mailer  ________________/________________
  361.  
  362.            Available baud rates _________-_________________ 
  363.  
  364.            Net/Node address:  _____________________________ 
  365.  
  366.            Network: (GT, FIDO, etc)  ______________________ 
  367.            
  368.            How would you like to receive your registration key and
  369.            serial number.  (Check one only!) :   
  370.                        
  371.                      Netmail___________    US Mail __________
  372.  
  373.            Circle one:   PUBLIC or PRIVATE    BBS 
  374.  
  375. To register, send a check or money order for $5.00 to:     
  376.  
  377.      Bill Watts     
  378.      6358 S. Louthan St.     
  379.      Littleton, CO.  80120-3121    
  380.  
  381.         Support is available on NetComm BBS (303) 730-7045 where
  382.         the newest copy of RIPDOOR is always available.
  383.         You may send netmail to me through the GT network at 
  384.         046/004, Fidonet at 1:104/603, or Fishnet at 21:69.403.
  385.  
  386.         Fidonet systems may F'REQ RIPDOOR and GT systems may file
  387.         request RIPDOR*.ZIP to receive the latest version of RIPDOOR.
  388.