home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / fossdumm.zip / FOSSDUMM.DOC < prev    next >
Text File  |  1993-06-15  |  7KB  |  171 lines
  1. Welcome to the world of Dummy Fossil!
  2.  
  3. Version : 0.1 (Just to have to count something :-))
  4.  
  5. Legalities :
  6. *****************************************************************************
  7. Author and Copyright: 
  8.          Michael Mrosowski
  9.          Mühlenweg 1
  10.          22880 Wedel
  11.          Germany
  12.  
  13. 1. Liability
  14. This software and accompanying materials are distributed "AS IS" without
  15. warranty, express, implied or statutory, including but not limited to any
  16. implied warranties of merchantability and fitness for a particular purpose.
  17. In no event shall anyone involved with the creation and production of this
  18. product be liable for indirect, special, or consequential damages, arising
  19. out of any use thereof or breach of any warranty. 
  20.  
  21. 2. Distribution
  22. This program is Public-Domain, that means that everyone can use and copy this 
  23. program as long and as often as he wants.
  24. *****************************************************************************
  25.  
  26. This is a short guide of:
  27.  - what you can do with it
  28.  - what you should not do with it
  29.  - how to install it
  30.  - further information
  31.  
  32. Function and environment of Dummy Fossil:
  33. -----------------------------------------
  34.   short : 
  35.     OS/2 2.0 or newer
  36.     DOS-Door which supports a fossil driver
  37.     supports multi-node 
  38.     (have a look at the scheme below)
  39.  
  40.   long:
  41. - Dummy Fossil has been written do allow an easy use of Dos-Doors under
  42.   Maximus OS/2 (anyway you can use it with any OS/2 Program which uses File-
  43.   Handles for I/O).
  44. - Dummy Fossil consists of an OS/2-Server (SERVDUMM) which communicates with 
  45.   a DOS-Fossilemulator (FOSSDUMM) via a Named Pipe.
  46.  
  47.          OS/2-Session                            DOS-Box
  48.    
  49.          SERVDUMM.EXE<─────(Named Pipe)───────>FOSSDUMM.EXE
  50.                ^                                    ^
  51.         ┌──────┴─────┐                              │
  52.   (com-handle) or (local=0)                   (fossil calls)
  53.         │            │                              │
  54.         v            v                              v
  55.     COM-DRIVER    CONSOLE                        DOS-DOOR
  56.  
  57.  
  58. - The DOS-Door MUST have FOSSIL DRIVER SUPPORT as any newer Door should 
  59.   offer.
  60. - You do NOT need any special hidden switches or patches to any DLL as in
  61.   the MAGIC toolkit. All you need is OS/2 2.0 or newer.
  62. - Dummy Fossil should even be able (not tested) to access Dos-Boxes or native
  63.   Dos-Computers running running in a network (via the Named Pipe services).
  64. - Multi-node capability (Node-numbers are simply added to the Pipe-Name).
  65.  
  66. What you should not do with it :
  67. --------------------------------
  68.   short :
  69.     no high performance
  70.   long:
  71. - The source code has not been optimized to support high-speed file transfers.
  72.   But it will offer a sufficient speed to use any other text-oriented doors.
  73.   Feel free to modify the added source code, to archieve that goal.
  74.   (see further information for that)
  75.   
  76. Installation + Testing :
  77. ------------------------
  78.   short:
  79.     see the examples at the end of this section
  80.   long:
  81. - Install your Dos-Door as usual, but be sure to enable the Fossil-Driver
  82.   support.
  83. - Copy FOSSDUMM.EXE and SERVDUMM.EXE to you disk.
  84.   Copy EMX.DLL to your DLL-directory or to the directory where you start
  85.   servdumm.exe (not always the directory where it stands but where you call
  86.   it from).
  87. - You can hardcode the com-port in your Dorinfox.Def or whatever you use,
  88.   to a single port (e.g. COM1) because FOSSDUMM does not bother which 
  89.   COM-Port, Baudrate the door wants to access. If you don't do that, the
  90.   door won't usually access FOSSDUMM in a local testrun (it runs then in local 
  91.   mode) and you are not able to test the function of Dummy Fossil easily.
  92. - Menus.ctl (Maximus) : After generating your Door-Info-file (Dorinfox.def 
  93.   etc.) call the cmd-file listed below via Xtern_Run. Pass the Node-No and 
  94.   the Com-Handle.
  95. - In the cmd-file start a Dos-Session with a batchfile calling FOSSDUMM.
  96.   Then start servdumm. 
  97.     
  98.     Parameters of FOSSDUMM.EXE (DOS):
  99.       FOSSDUMM.EXE <Node-Id> <Programname> <Any other Parameters>
  100.       Example:     01 hello.exe param1 param2 param3
  101.     
  102.     Parameters of SERVDUMM.EXE (OS/2):
  103.       SERVDUMM.EXE <Node-Id> <Com-Handle>
  104.       Example:     01 5    
  105.  
  106. - Testing :
  107.     You can test the whole thing if you start SERVDUMM with the com-handle
  108.     "0" (yep zero): SERVDUMM.EXE 01 0
  109.     Then Servdumm accepts local keystrokes, sends them do FOSSDUMM and echoes
  110.     any output of the Door to the OS/2-Screen.
  111.  
  112.   
  113.   Example of menus.ctl:
  114.   
  115. NODsp  Display_File   misc\dummdoor              limited  "1"
  116.        Xtern_run      cmd.exe_/C_gwar.cmd_%K_%P  limited  "1 = Global War"
  117. %                                         │  └Com-Handle
  118. %                                         └Node-Id
  119.   
  120.   Example of cmd-file:                       
  121.                                              
  122. rem Parameter %K %P
  123. cd c:\online\gwar
  124. start "GWAR Dos-Session" /C /DOS /MIN gwar.bat %1 
  125. c:\online\servdumm %1 %2
  126. cd c:\max
  127.    
  128.   Example of batch-file:
  129.    
  130. c:\online\fossdumm %1 war.exe /R c:\max\dorinfo1.def
  131.    
  132. Further information:
  133. --------------------
  134. - Safety:
  135.     SERVDUMM has a built-in carrier-detect and will cancel the session on a
  136.     carrier loss.
  137.     FOSSDUMM will signal "Lost Carrier" to the door when it looses connection
  138.     with SERVDUMM. 
  139.     This can be if:
  140.       - Carrier lost
  141.       - SERVDUMM has been aborted with Ctrl-C
  142.       - The OS/2-session of SERVDUMM has been killed for any reason.
  143.         (e.g. BIGBRO.EXE)
  144. - Compatibility:        
  145.     FOSSDUMM currently only supports the basic fossil-functions 0 through 
  146.     0x0F. Any Door that expects more won't work very well.
  147.     I tested fossdumm successfully with the following doors :
  148.       Gwar, Studs, Bordelo, TJ Video Poker, The Pit, Ecelectic Avenue
  149. - Bugs:
  150.     Always possible, notify me if you found some. I will try to catch'em
  151.     if this won't get too much work. 
  152. - Source-Code:
  153.     SERVDUMM.C   has been compiled with GNU-EMX 0.8e
  154.     FOSSDUMM.PAS has been compiled with TP 6.0 
  155.   (Q&D, i know)  
  156.  
  157.   Feel free to use the source-code where and for what you want. Change it,
  158.   squeeze it, eat it. But it would be nice if you could state my name some-
  159.   where if you redistribute the package for a similar use.
  160.   
  161. Author: 
  162.   Michael Mrosowski
  163.   Muehlenweg 1
  164.   22880 Wedel
  165.   Germany
  166.   Fidonet : 2:242/330.1
  167.     
  168. Contact me if you want. Any remarks are welcome. And excuse my funny 
  169. germish.
  170.   Ciao, Mike
  171.