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