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