home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / HST10.ZIP / HST.DOC < prev    next >
Encoding:
Text File  |  1995-07-02  |  11.4 KB  |  298 lines
  1.  
  2.                       ┌────────────────────────────┐
  3.                       │============================│
  4.                       │    HST Info Online 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.00     07/02/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.                      FIDO:  1:268/400
  34.                             FREQ TJMAGIC for complete list!
  35.                       FTP:  europa.com /outgoing/DOORS/tj-software
  36.  
  37.  
  38. LATEST VERSION:
  39. ^^^^^^^^^^^^^^^
  40. Please call the T&J BBS for the latest version of this program.
  41.  
  42. LEGALITIES:
  43. ^^^^^^^^^^^
  44. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  45. WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY
  46. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  47. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS
  48. PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING
  49. OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  50.  
  51. DISTRIBUTION:
  52. ^^^^^^^^^^^^^
  53. Please feel free to distribute this demo door.
  54.  
  55. PROGRAM DESCRIPTION:
  56. ^^^^^^^^^^^^^^^^^^^^
  57. The HST Info Door contains the latest information of the Hubble
  58. Space Telescope and background data! Your users can read and search
  59. through the entire online database in seconds, matching their
  60. keyword search and reporting which articles contained the matches.
  61. The keyword containing line will be highlighted in the text (if your
  62. caller is in ANSI mode).
  63.  
  64. Updated databases will be available to download from our BBS in
  65. file area #10 as HST#x.ZIP where x=database update number. Simply
  66. download any updates and unzip it in the door directory (overwriting)
  67. any of the files - it couldn't be easier!
  68.  
  69. You may also file request HSTDATA from 1:268/400 for the latest
  70. available database!
  71.  
  72. Updated databases merely need to be unzipped in the door directory
  73. like this:  PKUNZIP -o HST#1.ZIP
  74.  
  75. ...this will over write the old databases using the -o on the
  76. command line.
  77.  
  78. TEXT COLOR:
  79. ^^^^^^^^^^^
  80. Simply edit the file COLOR.DAT, lines 1 and 2. Here's the file:
  81.  
  82. 14
  83. 3
  84.  
  85. Line 1: Foreground Color
  86. Line 2: Background Color
  87.  
  88. Foreground:   15 = Bright White     Background: 7 = Default White
  89.               14 = Bright Yellow                6 = Light Yellow
  90.               13 = Bright Purple                5 = Light Purple
  91.               12 = Bright Red                   4 = Light Red
  92.               11 = Bright Cyan                  3 = Light Cyan
  93.               10 = Bright Green                 2 = Light Green
  94.                9 = Bright Blue                  1 = Light Blue
  95.                8 = Dark Grey
  96.                7 = Default White
  97.                6 = Light Yellow
  98.                5 = Light Purple
  99.                4 = Light Red
  100.                3 = Light Cyan
  101.                2 = Light Green
  102.                1 = Light Blue
  103.  
  104. CONFIGURATION: (The HST.CFG file)
  105. ^^^^^^^^^^^^^^
  106. Run --->  HST UTILITY   to easily setup your HST.CFG file!
  107.  
  108.  
  109. Example configuration file for PCBOARD.SYS
  110. ------------------------------------------
  111. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  112. T&J Software        <=-  (Change this to your BBS name)
  113. Tom                 <=-  (The Sysop's first name)
  114. Wildoner            <=-  (The Sysop's last name)
  115.  
  116. Example configuration file for USERS.SYS
  117. ----------------------------------------
  118. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  119. T&J Software        <=-  (Change this to your BBS name)
  120. Tom                 <=-  (The Sysop's first name)
  121. Wildoner            <=-  (The Sysop's last name)
  122.  
  123. Example configuration file for DOOR.SYS
  124. ---------------------------------------
  125. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  126. T&J Software        <=-  (Change this to your BBS name)
  127. Tom                 <=-  (The Sysop's first name)
  128. Wildoner            <=-  (The Sysop's last name)
  129.  
  130. Example configuration file for USERINFO.DAT
  131. -------------------------------------------
  132. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  133. T&J Software        <=-  (Change this to your BBS name)
  134. Tom                 <=-  (The Sysop's first name)
  135. Wildoner            <=-  (The Sysop's last name)
  136. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  137.  
  138. Example configuration file for CALLINFO.BBS
  139. -------------------------------------------
  140. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  141. T&J Software        <=-  (Change this to your BBS name)
  142. Tom                 <=-  (The Sysop's first name)
  143. Wildoner            <=-  (The Sysop's last name)
  144.  
  145. Example configuration file for DORINFOx.DEF
  146. -------------------------------------------
  147. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  148.                           where 'x' is the BBS Node number.
  149. T&J Software        <=-  (Change this to your BBS name)
  150. Tom                 <=-  (The Sysop's first name)
  151. Wildoner            <=-  (The Sysop's last name)
  152.  
  153. Example configuration file for SFDOORS.DAT
  154. ------------------------------------------
  155. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  156. T&J Software        <=-  (Change this to your BBS name)
  157. Tom                 <=-  (The Sysop's first name)
  158. Wildoner            <=-  (The Sysop's last name)
  159.  
  160. Example configuration file for GTUSER.BBS
  161. -----------------------------------------
  162. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  163. T&J Software        <=-  (Change this to your BBS name)
  164. Tom                 <=-  (The Sysop's first name)
  165. Wildoner            <=-  (The Sysop's last name)
  166. 1                   <=-  (COM port number - defaults to 1)
  167. 1                   <=-  (Node number - defaults to 1)
  168.  
  169.  
  170. Example Batch File
  171. ^^^^^^^^^^^^^^^^^^
  172. A sample batch file is included and is similer to the following:
  173.    ECHO OFF
  174.    CD\DOORS\HST             <=- Switch to the door's Directory.
  175.    HST HST.CFG              <=- Execute the door program and pass the
  176.                                 configuration filename to the program.
  177.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  178.    BOARD                    <=- Restart BBS.
  179.  
  180.  
  181. This Door is multi-node  compatible so you may run more than 1 node from
  182. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  183. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  184. variables, (q.v.)
  185.  
  186. Normally, when running multinode, just setup different HST.CFG files
  187. for each node:   HST1.CFG   HST2.CFG  etc....
  188.  
  189.  
  190. Environment Variables
  191. ^^^^^^^^^^^^^^^^^^^^^
  192. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  193. variables. Non-PCBoard systems may also use these variables by including
  194. the following in either your BBS batch or AUTOEXEC.BAT
  195.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  196.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  197. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  198. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  199. .CFG file for multi-node operation!
  200.  
  201. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  202. command line.  For example:
  203.  
  204.      HST HST.CFG /5
  205. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  206.      HST HST.CFG /%IRQ%
  207.  
  208. This tells the program to use IRQ 5 instead of the standard IRQ.
  209.  
  210.   Had reports of conflicts when using non-standard IRQ's on Novell/Netware
  211.  systems. Seems Novell also uses the / character so something went screwy
  212.  somewhere. So I added the * (asterisk) which may be used instead of the /
  213.  in case of a conflict. In other words, /%IRQ% and *%IRQ% will both work
  214.  and are interchangeable.
  215.  
  216. When specifying the location of the system file on line 1 of the doors .CFG
  217. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  218. and %wcnodeid%. Some examples:
  219.  PCBoard: 
  220.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  221.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  222.  
  223.  Wildcat!:
  224.    USERINFO.DAT in C:\WILDCAT\WCWORK\NODE1
  225.  
  226.                    C:\WILDCAT\WCWORK\NODE%wcnodeid%\USERINFO.DAT
  227.  
  228.  
  229.    DOOR.SYS in C:\WILDCAT\WCWORK\NODE1
  230.  
  231.                    C:\WILDCAT\WCWORK\NODE%wcnodeid%\DOOR.SYS
  232.  
  233. Non-PCBoard systems may use the PCB environment variables by setting them
  234. in either AUTOEXEC.BAT or in the batch that runs the door. For example:
  235.  SET PCBDRIVE=C:
  236.  SET PCBDIR=\BBSDIR
  237.  SET PCBNODE=1
  238.  
  239. Fossil Driver Support
  240. ^^^^^^^^^^^^^^^^^^^^^
  241. DoorFrame supports the use of Fossil drivers.  To tell your Door to use the
  242. Fossil driver instead of the standard COM ports, just put /FD on the command
  243. line when running the door. For example:
  244.      MYDOOR MYDOOR.CFG /FD
  245. indicates that a Fossil driver is present and should be used. If no Fossil
  246. driver is detected, DoorFrame will print a message to that effect and exit
  247. the door gracefully.
  248.  
  249. Sysop Keys
  250. ^^^^^^^^^^
  251. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  252.          written to DOOR.SYS and USERS.SYS
  253. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  254.          and/or written to DOOR.SYS and USERS.SYS
  255. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  256. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  257.          and/or written to DOOR.SYS and USERS.SYS
  258. F8    -  Returns the caller involuntarily to the BBS.
  259. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  260.          and/or written to DOOR.SYS and USERS.SYS
  261. F10   -  Activates SysOp CHAT mode within the DOOR.
  262. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  263. UP    -  Give the caller extra time while in the DOOR.  
  264. DN    -  Subtract time from the caller while in the DOOR. 
  265. HOME  -  HELP key for Status Line options.
  266. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  267. ALT-X -  PCBoard will exit after current caller logs off. Value is
  268.          passed to PCBoard. Not available on non-PCBoard systems.
  269.  
  270. PROBLEMS:
  271. ^^^^^^^^^
  272. See the TJHELP.TXT file!
  273. Please feel free to contact me if you have any problems at all.
  274.  
  275. MAINTENANCE:
  276. ^^^^^^^^^^^^
  277. No nightly maintenance required.
  278.  
  279. RUNNING LOCALLY:
  280. ^^^^^^^^^^^^^^^^
  281. To run in LOCAL mode simply type HST LOCAL
  282.  
  283. FUTURE VERSIONS:
  284. ^^^^^^^^^^^^^^^^
  285. Let me know what you would like to see added!!
  286.  
  287. VERSION HISTORY:
  288. ^^^^^^^^^^^^^^^^
  289. Version 1.00 ......... First release. 07/02/95
  290.  
  291. REGISTERING:
  292. ^^^^^^^^^^^^
  293. That's all there is to it! If you have any problems or questions
  294. please feel free to call the T&J Software BBS at (717)325-9481.
  295.  
  296. See the enclosed registration form for ordering this door and others!
  297. (REGISTER.TXT)
  298.