home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / DOORMT10.ZIP / DOORMAT.DOC < prev    next >
Encoding:
Text File  |  1993-05-20  |  13.5 KB  |  367 lines
  1.  
  2.            +----------------------------------------------+
  3.            | Doormat, (C) Copyright 1991-93 Scott Johnson |
  4.            |              for Jibben Software             |
  5.            |                 Version 1.00                 |
  6.            +----------------------------------------------+
  7.  
  8.  
  9. This is a list of the files that should accompany this software
  10. package:
  11.  
  12. README       - Read me file with info to run Doormat locally.
  13. ATTRACT.ANS  - ANSI DOORMAT test file - Jibben Software Attraction
  14. DM.BAT       - Batch file for running Doormat locally as a test
  15. DOORMAT.DEF  - Example Doormat Configuration File.
  16. FILE_ID.DIZ  - BBS Description File.
  17. DOORMAT.DOC  - Doormat Documentation.
  18. ORDERFRM.DOC - The order form.
  19. DOORMAT.EXE  - Doormat executable.
  20. CATALOG.JSW  - Information on current Jibben Software Products.
  21. NAMES.LST    - Sample name exclude/include list
  22. DOOR.SYS     - Dummy DOOR.SYS file for running Doormat locally.
  23. AVEXTRA.TXT  - Information regarding PKZIP AV codes.
  24. ATTRACT.TXT  - Text DOORMAT test file - Jibben Software Attraction
  25.  
  26. This software should not include any other files other than the ones
  27. listed above.  It was also compressed using either the PKZIP AV.
  28.  
  29.  
  30.         Shareware Trade Association & Resources
  31.  
  32. Scott Johnson is a charter member of STAR!  STAR is the shareware 
  33. industries fastest growing trade association.
  34.  
  35. To obtain other fine software from members of STAR, please contact the
  36. Software Creations BBS.  It is the hub of the STAR distribution network
  37. supporting 53 phone lines.  To access Software Creations, you may call
  38. the following numbers:
  39. (508) 365-2359 - 2400 baud
  40. (508) 368-4137 - US Robotics HST
  41. (508) 368-7423 - Dual Standard, V.32bis
  42.  
  43. Please contact The Warehouse BBS for TECHNICAL SUPPORT at:
  44. (612) 379-8272 - Dual Standard, V.32bis (10 phone lines)
  45.  
  46.  
  47.                The concept of Shareware
  48.  
  49. Doormat is being released as a Shareware product.  Shareware is a
  50. marketing concept, in which you get to try out a software package for
  51. a period of time.  If you find that the software is useful to you (you
  52. are still using it), you are obligated to send in a registration fee
  53. for that software to the author.
  54.  
  55. Doormat trial period is 21 days.  That means, once you start using
  56. Doormat, you have 21 days to decide whether or not it is useful to you.
  57. If it is useful, please promptly send in the requested registration fee.
  58. If it is not useful, you are expected to delete it and stop using it.
  59.  
  60. The shareware version of Doormat is functional.  However, it will post
  61. this annoying message to the user and pause until it is registered:
  62.  
  63. -Doormat- By Scott Johnson (C) 1993 Jibben Software, All rights reserved.
  64.  
  65. UNREGISTERED VERSION
  66. Please register this software after 21 days or remove from the system.
  67.  
  68. Also,  the timing functions will not be available until this version is
  69. registered and there will be a 'press a key' message before the text is
  70. displayed.
  71.  
  72. Here's what you get when you register (Please use ORDERFRM.DOC to order
  73. this software):
  74.  
  75. 1.  Support.  You can call and leave e-mail to me on the BBS listed in
  76.     the Technical Support section of this document I will more than
  77.     likely answer all questions, but the registered individuals will
  78.     definitely get top priority.  You will also receive unlimited
  79.     telephone support for the program.  Registered users will get a
  80.     phone number that they will be able to use to receive support between
  81.     the hours of 6:00 pm - 9:00 pm (Central Standard Time) Monday-Friday.
  82.  
  83. 2.  You will receive a disk with the most recent version of Doormat.
  84.     The software will also have all of the registration incentives
  85.     removed.  The name and serial number of your BBS will also be
  86.     displayed in the main menu when the software is run.
  87.  
  88. 3.  Special access to new products.  You will be allowed access to
  89.     beta test any software package that I'm in the process of creating.
  90.     The beta software will be available only on the Warehouse BBS.
  91.     Also you must make arrangements with Jibben Software to get access
  92.     to the new software.  (see Technical Support section of this
  93.     document for details).
  94.  
  95. 4.  You will be able to download and upgrade your registered version
  96.     with the shareware releases of minor revisions (1.01, 1.10,
  97.     1.90...).
  98.  
  99. 5.  You will also have low cost upgrades for major revisions (2.0,
  100.     3.0...) of this software.
  101.  
  102.  
  103.                            What is Doormat?
  104.  
  105. Doormat is geared for Sysops wanting a little more control in between 
  106. doors.  Have you ever wanted to lockout certain user from a door? Block 
  107. out certain age groups? Display a message to all users before they 
  108. enter a door?  Shut a door down during a certain time to run 
  109. maintenance or leave the board open for other uses?  Have only a 
  110. certain group of people to access a certain door?  Then this program 
  111. was written just for you.
  112.  
  113.                      Where did the idea come from?
  114.  
  115. On a board that I help run the SysOp posed a certain question, "How can 
  116. I display a message to all users letting them know of an external 
  117. interface that is available to download or to let the users know that I 
  118. am going to reset the game?  How can I close the door down so I insure 
  119. clean data while the maintenance is running?" So the first generation 
  120. of Doormat was created.  From there I received several other tips from 
  121. people that wanted to lock out all users under 18 for adult only type 
  122. doors, and another person that wanted to lock out certain troublesome 
  123. users from a storyboard that was ruined several times.  So I set to 
  124. work on the whole picture, and came up with the final version and here 
  125. it is.  I'm open to all comments or questions so if you have anymore 
  126. ideas, let me know.
  127.  
  128.  
  129.  
  130.                        Requirements for Doormat
  131.  
  132.  
  133. Doormat should have at least 100KB of free memory to run.
  134.  
  135. Supported BBS Systems
  136. ---------------------
  137. Doormat will support any BBS that creates a DOOR.SYS file when chaining
  138. to a door.  Also, Wildcat 2.x (CALLINFO.BBS), DORINFOx.DEF and
  139. PC Board - 12.x through 14.x (PCBOARD.SYS) are supported.
  140.  
  141.  
  142.               Installation Instructions
  143.  
  144. Sample Door Batch File
  145. ----------------------
  146. The door filename is placed on the command line of DOORMAT.EXE.  Here is a
  147. sample batch file calling Doormat before entering Jibben Software's
  148. Galactic Overload door game.  This example assumes the following:
  149.     Doormat.EXE is in the DOS PATH or in the door directory
  150.     DOOR.SYS and Doormat.DEF is in the door directory
  151.  
  152. C:                            ( change drives )
  153. CD\DOORS\GO                   ( change to door directory )
  154. Doormat DOOR.SYS  Doormat.DEF ( run Doormat )
  155. IF NOT ERRORLEVEL 0 GOTO END  ( * )
  156. GO DOOR.SYS                   ( run Jibben Software's Galactic Overlord )
  157. :END                          ( END header for escaping batch file if error
  158. CD\                           ( change back to the root directory )
  159.  
  160. ( * ) This line checks to see if an error occurs and exits the batch file
  161.       without entering the main door. (READ THE NOTE BELOW FOR MORE INFO)
  162.  
  163.       A list of errorlevel codes follow:
  164.  
  165.     Errorlevel -1    Fatal error; caller hung up, files missing, etc...
  166.     Errorlevel 0     No problems; ok to run next door
  167.     Errorlevel 1     User hit door closed times - registered version only
  168.     Errorlevel 2     User is under age
  169.     Errorlevel 3     User was on the exclude list
  170.  
  171. Non-Standard Comm Ports
  172. -----------------------
  173. If you have a DigiBoard system or are using Fossil drivers you can
  174. still use this door game!  You will have to add another parameter to
  175. the door batch file.  The format of this next parameter is PORT:AAAA:X.
  176.  
  177. *** NOTE: ***
  178.  
  179. The dos batch errorlevels, from testing and working with them, seem to 
  180. not allow the "NOT ERRORLEVEL 0".  You may try this, HOWEVER, if this 
  181. does not work then replace the line "IF NOT ERRORLEVEL 0 GOTO END" with
  182. the following lines:
  183.  
  184. IF ERRORLEVEL  3 GOTO END
  185. IF ERRORLEVEL  2 GOTO END
  186. IF ERRORLEVEL  1 GOTO END
  187. IF ERRORLEVEL -1 GOTO END
  188.  
  189.  
  190.                Doormat Examples
  191.  
  192.  
  193. The following batch file would request a port using interrupt 4 at
  194. address 03F8.
  195.  
  196. C:  
  197. CD\DOORS\GO 
  198. Doormat DOOR.SYS PORT:03F8:4 DOORMAT.DEF 
  199. IF NOT ERRORLEVEL 0 GOTO END 
  200. GO DOOR.SYS PORT:03F8:4 
  201. END:  
  202. CD\
  203.  
  204. The following batch file would request port #3 on a DigiBoard.
  205.  
  206. C:
  207. CD\DOORS\GO
  208. Doormat DOOR.SYS PORT:D:3 Doormat.DEF
  209. IF NOT ERRORLEVEL 0 GOTO END
  210. GO DOOR.SYS PORT:D:3
  211. END:
  212. CD\
  213.  
  214. The following batch file would request port #2 on a Fossil Driver.
  215.  
  216. C:
  217. CD\DOORS\GO
  218. Doormat DOOR.SYS PORT:F:2 Doormat.DEF
  219. IF NOT ERRORLEVEL 0 GOTO END
  220. GO DOOR.SYS PORT:F:2
  221. END:
  222. CD\
  223.  
  224. Local Mode
  225. ----------
  226. The door can be tested in local mode, although, you'll have to use a
  227. DOOR.SYS file that has a comm port of zero (COM0:).  The following
  228. files are included:
  229.  
  230. LOCAL.BAT
  231. DOOR.SYS
  232.  
  233. Simply typing LOCAL with the above files in the same directory as the
  234. other Doormat distribution files will start the door in local mode.
  235.  
  236.  
  237. Miscellaneous Setup Issues
  238. --------------------------
  239. Doormat supports multi-node access!  So, you can safely allow
  240. more than one node to access the door at one time.  To best way to
  241. accomplish this is to place Doormat.EXE somewhere in the search path.
  242. When registering, place the overlay file in the SAME directory as
  243. the Doormat.EXE file.  However, you will be responsible for keeping
  244. each DOOR.SYS or related door file separate from other players files.
  245.  
  246.  
  247.               Configuration
  248.  
  249. Doormat has been written to be easily configured.  Included with this
  250. distribution software is a file named Doormat.DEF ( or whatever you wish
  251. to call it).  It is very similar to a Microsoft Windows *.INI file.  It
  252. contains a sample configuration for the utility.  It also contains the
  253. documentation for the settings and what the options mean.  Please refer
  254. to this file to see how to configure your copy of Doormat.
  255.  
  256.  
  257.  
  258.                Doormat Technical Info
  259.  
  260. Files
  261. -----
  262. Doormat is the first door utility released by Jibben Software.  And is 
  263. also the first program ever released by the author Scott Johnson.
  264.  
  265. The only files that Doormat requires are:
  266. Doormat.DEF       - Doormat configuration file.
  267. Doormat.EXE       - Doormat executable.
  268.  
  269. All other distribution files may be removed to conserve disk space.
  270.  
  271.  
  272.             Special Sysop Functions
  273.  
  274.  
  275. On-Line Sysop Commands
  276. ----------------------
  277.  
  278. While a caller is on-line, the local sysop has several options:
  279.  
  280.  
  281. FKey      Description
  282. -------   --------------------------------------------
  283.  F3*      Toggle printer on/off
  284.  F4*      Toggle pagebell on/off
  285.  F5       Shell to DOS
  286.  F7*      Toggle caller alarm on/off
  287.  F8       Return user to system
  288.  F9       Toggle display on/off
  289.  
  290. Alt-Key   Description
  291. -------   --------------------------------------------
  292.  ALT-H    Toggle between different status lines
  293.  ALT-N*   Toggle sysop on next
  294.  ALT-X*   Toggle exit to dos after call and help lines
  295.  
  296.  
  297. Alternately pressing the ALT-H key will bring up the next status line
  298. screen.  The 1st screen is a help screen, the second screen shows your
  299. COM port status.
  300.  
  301. *The function keys marked with an "*" will only be of use to systems
  302. using pcboard.sys.  The rest are functional with any system.
  303.  
  304.  
  305.                          Why cripple software?
  306.  
  307. A common practice for Shareware authors has been appearing, software 
  308. crippling.  This unfortunate occurrence is needed to insure the 
  309. author's time and effort is compensated for.  Please understand how 
  310. much time and effort goes into each program that is written. 
  311.  
  312.  
  313.                Development Data
  314.  
  315. Doormat was written entirely in C++ using Borland C++ 3.1.
  316.  
  317.  
  318.                Technical Support
  319.  
  320. For technical support I (Scott Johnson) can be reached at the following
  321. on-line systems:
  322.  
  323. The Warehouse BBS:  612-379-8272  1200-57600 baud V.32bis/HST 16.8K
  324. (N81) - 10 Lines.  The Warehouse is my first (main) line of support.
  325. Since I am a co-sysop of this BBS, I usually log on several times a day
  326. to check for email.  This BBS is a subscription BBS, however anyone
  327. logging on will receive access rights to the file area where my
  328. software can be downloaded for FREE and a message area that is
  329. dedicated to Jibben Software.
  330.  
  331. Door-Util conference from FIDO.  I will be reading all messages sent to 
  332. me in this forum, but will respond as time permits.  Of course, 
  333. registered users will get a response right away.
  334.  
  335.                 Acknowledgments
  336.  
  337. I would like to thank those people that have assisted me in the
  338. development of this software:
  339.  
  340. Scott Jibben, a darn good programmer and friend who gave me Jibben libraries
  341. to simplify and speed up development of this project and others to come...
  342.  
  343. Travis Carter, SysOp of the Warehouse BBS, for testing the software and
  344. providing a message forum for supporting software written by Jibben Software.
  345.  
  346. My wife, for being patient and supportive in getting this software written
  347. and out.
  348.  
  349. Finally, all of the people who've registered my software.  I really
  350. appreciate it!
  351.  
  352.  
  353.                            Disclaimers, etc.
  354.  
  355. Jibben Software specifically disclaims all other warranties, expressed
  356. or implied, including but not limited to implied warranties of
  357. merchantability and fitness for a particular purpose, functionality or
  358. data integrity.  In no event shall Jibben Software be liable for any
  359. loss of profit or any other commercial damage, including but not
  360. limited to special, incidental, consequential or other damages.
  361.  
  362.  
  363. Borland is a registered trademark of Borland International, Inc.
  364. DigiBoard is copyright (c) DigiBoard.
  365. Microsoft Windows is a registered trademark of Microsoft Corporation.
  366.  
  367.