home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / ESDOOR12.ZIP / ESDOOR.DOC < prev    next >
Encoding:
Text File  |  1996-04-20  |  10.0 KB  |  253 lines
  1.  
  2.                       ┌────────────────────────────┐
  3.                       │============================│
  4.                       │   Endangered Species Door  │
  5.                       │============================│
  6.                       │COPYRIGHT 1996 T&J Software │
  7.                       └────────────────────────────┘
  8.         One of the T&J Software Collection of multi-BBS door programs.
  9.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  10.                UltraBBS, Telegard, TriBBS, and Remote Access.
  11.  
  12.  
  13.                        VERSION 1.20     04/20/96
  14.  
  15.                                    By
  16.  
  17.                               Tom Wildoner
  18.                             397 West Broadway
  19.                              Jim Thorpe, PA
  20.                                  18229
  21.                            VOICE (717)325-9480
  22.                   *between 6:00 & 8:00 p.m. Eastern Time
  23.  
  24.                                   From
  25.  
  26.                            The T&J Software BBS
  27.                         NODE 1: (717)325-9481 28.8k
  28.                         NODE 2: (717)325-2054 28.8k
  29.                         NODE 3: (717)325-4369 Fido Only
  30.                                24 Hours/Day
  31.  
  32.                    INTERNET:  tjsoft@postoffice.ptd.net
  33.                    FTP: ftp.europa.com /outgoing/DOORS/tj-software
  34.                    FTP: ftp.thekeep.com /TJ-Software
  35.                    FIDO: FREQ ESDOOR for full door version.
  36.                          FREQ ESDATA for the latest database.
  37.                          FREQ TJSOFT for info packet.
  38.  
  39. LATEST VERSION:
  40. ^^^^^^^^^^^^^^^
  41. Please call the T&J BBS for the latest version of this program.
  42.  
  43. LEGALITIES:
  44. ^^^^^^^^^^^
  45. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  46. WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY
  47. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  48. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS
  49. PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING
  50. OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  51.  
  52. DISTRIBUTION:
  53. ^^^^^^^^^^^^^
  54. Please feel free to distribute this door.
  55.  
  56. PROGRAM DESCRIPTION:
  57. ^^^^^^^^^^^^^^^^^^^^
  58. The Endangered Species Door presents your callers with the latest
  59. information on all endangered/threatened species broken down by
  60. catagory. T&J Software routinely updates the database as new species
  61. are added or delisted from the listing.
  62.  
  63. You may also search the database online.
  64.  
  65. CONFIGURATION: (The ESDOOR.CFG file)
  66. ^^^^^^^^^^^^^^
  67. Run --->  ESDOOR UTILITY   to easily setup your ESDOOR.CFG file!
  68.  
  69.  
  70. Example configuration file for PCBOARD.SYS
  71. ------------------------------------------
  72. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  73. T&J Software        <=-  (Change this to your BBS name)
  74. Tom                 <=-  (The Sysop's first name)
  75. Wildoner            <=-  (The Sysop's last name)
  76.  
  77. Example configuration file for USERS.SYS
  78. ----------------------------------------
  79. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  80. T&J Software        <=-  (Change this to your BBS name)
  81. Tom                 <=-  (The Sysop's first name)
  82. Wildoner            <=-  (The Sysop's last name)
  83.  
  84. Example configuration file for DOOR.SYS
  85. ---------------------------------------
  86. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  87. T&J Software        <=-  (Change this to your BBS name)
  88. Tom                 <=-  (The Sysop's first name)
  89. Wildoner            <=-  (The Sysop's last name)
  90.  
  91. Example configuration file for USERINFO.DAT
  92. -------------------------------------------
  93. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  94. T&J Software        <=-  (Change this to your BBS name)
  95. Tom                 <=-  (The Sysop's first name)
  96. Wildoner            <=-  (The Sysop's last name)
  97. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  98.  
  99. Example configuration file for CALLINFO.BBS
  100. -------------------------------------------
  101. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  102. T&J Software        <=-  (Change this to your BBS name)
  103. Tom                 <=-  (The Sysop's first name)
  104. Wildoner            <=-  (The Sysop's last name)
  105.  
  106. Example configuration file for DORINFOx.DEF
  107. -------------------------------------------
  108. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  109.                           where 'x' is the BBS Node number.
  110. T&J Software        <=-  (Change this to your BBS name)
  111. Tom                 <=-  (The Sysop's first name)
  112. Wildoner            <=-  (The Sysop's last name)
  113.  
  114. Example Batch File
  115. ^^^^^^^^^^^^^^^^^^
  116. A sample batch file is included and is similer to the following:
  117.    ECHO OFF
  118.    CD\DOORS\ESDOOR          <=- Switch to the door's Directory.
  119.    ESDOOR ESDOOR.CFG        <=- Execute the door program and pass the
  120.                                 configuration filename to the program.
  121.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  122.    BOARD                    <=- Restart BBS.
  123.  
  124.  
  125. This Door is multi-node  compatible so you may run more than 1 node from
  126. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  127. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  128. variables, (q.v.)
  129.  
  130. Normally, when running multinode, just setup different BIBLE.CFG files
  131. for each node:   ESDOOR1.CFG   ESDOOR2.CFG  etc....
  132.  
  133. Environment Variables
  134. ^^^^^^^^^^^^^^^^^^^^^
  135. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  136. variables. Non-PCBoard systems may also use these variables by including
  137. the following in either your BBS batch or AUTOEXEC.BAT
  138.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  139.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  140. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  141. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  142. .CFG file for multi-node operation!
  143.  
  144. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  145. command line.  For example:
  146.  
  147.      ESDOOR ESDOOR.CFG /5
  148. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  149.      ESDOOR ESDOOR.CFG /%IRQ%
  150.  
  151. This tells the program to use IRQ 5 instead of the standard IRQ.
  152.  
  153.   Had reports of conflicts when using non-standard IRQ's on Novell/Netware
  154.  systems. Seems Novell also uses the / character so something went screwy
  155.  somewhere. So I added the * (asterisk) which may be used instead of the /
  156.  in case of a conflict. In other words, /%IRQ% and *%IRQ% will both work
  157.  and are interchangeable.
  158.  
  159. When specifying the location of the system file on line 1 of the doors .CFG
  160. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  161. and %wcnodeid%. Some examples:
  162.  PCBoard: 
  163.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  164.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  165.  
  166.  Wildcat!:
  167.    USERINFO.DAT in C:\WILDCAT\WCWORK\NODE1
  168.  
  169.                    C:\WILDCAT\WCWORK\NODE%wcnodeid%\USERINFO.DAT
  170.  
  171.  
  172.    DOOR.SYS in C:\WILDCAT\WCWORK\NODE1
  173.  
  174.                    C:\WILDCAT\WCWORK\NODE%wcnodeid%\DOOR.SYS
  175.  
  176. Non-PCBoard systems may use the PCB environment variables by setting them
  177. in either AUTOEXEC.BAT or in the batch that runs the door. For example:
  178.  SET PCBDRIVE=C:
  179.  SET PCBDIR=\BBSDIR
  180.  SET PCBNODE=1
  181.  
  182. Fossil Driver Support
  183. ^^^^^^^^^^^^^^^^^^^^^
  184. DoorFrame supports the use of Fossil drivers.  To tell your Door to use the
  185. Fossil driver instead of the standard COM ports, just put /FD on the command
  186. line when running the door. For example:
  187.      MYDOOR MYDOOR.CFG /FD
  188. indicates that a Fossil driver is present and should be used. If no Fossil
  189. driver is detected, DoorFrame will print a message to that effect and exit
  190. the door gracefully.
  191.  
  192. Sysop Keys
  193. ^^^^^^^^^^
  194. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  195.          written to DOOR.SYS and USERS.SYS
  196. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  197.          and/or written to DOOR.SYS and USERS.SYS
  198. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  199. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  200.          and/or written to DOOR.SYS and USERS.SYS
  201. F8    -  Returns the caller involuntarily to the BBS.
  202. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  203.          and/or written to DOOR.SYS and USERS.SYS
  204. F10   -  Activates SysOp CHAT mode within the DOOR.
  205. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  206. UP    -  Give the caller extra time while in the DOOR.  
  207. DN    -  Subtract time from the caller while in the DOOR. 
  208. HOME  -  HELP key for Status Line options.
  209. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  210. ALT-X -  PCBoard will exit after current caller logs off. Value is
  211.          passed to PCBoard. Not available on non-PCBoard systems.
  212.  
  213. PROBLEMS:
  214. ^^^^^^^^^
  215. See the TJHELP.TXT file!
  216. Please feel free to contact me if you have any problems at all.
  217.  
  218. MAINTENANCE:
  219. ^^^^^^^^^^^^
  220. No nightly maintenance required.
  221.  
  222. UPGRADING:
  223. ^^^^^^^^^^
  224. See the UPGRADE.DOC file.
  225.  
  226. RUNNING LOCALLY:
  227. ^^^^^^^^^^^^^^^^
  228. To run in LOCAL mode simply type ESDOOR LOCAL
  229.  
  230. FUTURE VERSIONS:
  231. ^^^^^^^^^^^^^^^^
  232. Let me know what you would like to see added!!
  233.  
  234. VERSION HISTORY:
  235. ^^^^^^^^^^^^^^^^
  236. Version 1.00 ......... First release. 06/03/95
  237. Version 1.10 ......... 7/20/95 Fixed indexing problem found when adding
  238.                        new species to the database. This required
  239.                        making an external index and recompiling the
  240.                        door to handle it. Future database updates will
  241.                        only work with v1.10+ of the door.
  242. Version 1.20 ......... 4/20/96 Updated routines to make them compatible
  243.                        with the 32-bit version of the door. Removed RIP
  244.                        detection. ALL RIP support has now been removed.
  245.  
  246. REGISTERING:
  247. ^^^^^^^^^^^^
  248. That's all there is to it! If you have any problems or questions
  249. please feel free to call the T&J Software BBS at (717)325-9481.
  250.  
  251. See the enclosed registration form for ordering this door and others!
  252. (REGISTER.TXT)
  253.