home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / new / comm / bbs / 4d-bbsdemo / docs / text / 10.doors_external < prev    next >
Text File  |  1993-12-28  |  4KB  |  106 lines
  1. Chapter 10:  Doors and External Programs
  2.  
  3.  
  4.  
  5.  
  6. 10.1 Introduction
  7.  
  8.     Doors are separate programs that can communicate with the BBS.  They
  9. come in many forms such as games and utilities, and can be found on many
  10. BBSs.  It is not guaranteed that all doors will work on 4D-BBS.  They may
  11. have been written for another BBS and may not be fully compatible.
  12.  
  13. 10.1.1 Types
  14.  
  15.     On 4D-BBS you can run 3 types of Door programs:
  16.  
  17.     1:  ARexx
  18.     2:  Paragon
  19.     3:  CLI (StdIO/FIFO)
  20.  
  21. 10.1.2 ARexx Doors
  22.  
  23.     In the Configuration Editor you can set up the port name you wish to
  24. use for your ARexx port.  The default is "4D-BBS".  If you run a multi-line
  25. BBS, 4D-BBS will automatically add a number to the end of your port name.
  26. (For specific ARexx commands see Appendix A3.)
  27.  
  28.     For Example:
  29.  
  30.     line 0:  Port Name "4D-BBS"
  31.     line 1:  " " "4D-BBS1"
  32.  
  33.     Usually all that is required for an ARexx door to run on 4D-BBS is to
  34. change the address to the ARexx port name.  Or you can pass it the ARexx
  35. port name as an argument by using 4D-BBS's embedded instructional code for
  36. the ARexx port name, ^]WT%.  This will require a good understanding of
  37. ARexx if the script is not set up to handle this.  You can find an example
  38. of this in 4DWhosOn.Rexx.  (Refer to Menu Options for more information.)
  39.  
  40.     Below is a simple menu example on how to start an ARexx door:
  41.  
  42.     H:c A Path/filename.rexx
  43.  
  44.     H ; keypress
  45.     c ; door
  46.     A ; type of door (A,P,O,F)
  47.  
  48. 10.1.3 Paragon Door Types
  49.  
  50.     Usually installing a Paragon door is very simple.  You must have a
  51. directory devoted to doors and assign DOORS:  to it.  Many doors require
  52. that sub-directories be set up for them (you will have to read the
  53. individual product documentation about this).
  54.  
  55.     4D-BBS has two ways to run a Paragon door.  The best way is to use the
  56. door option of "P".  4D-BBS will check to make sure the door opens a reply
  57. port to prevent the BBS from hanging in the door mode.  If the reply port
  58. can not be found, 4D-BBS will return.
  59.  
  60.     A simple menu example:
  61.  
  62.     h:c P Doors:filename
  63.  
  64.     The other way to run a Paragon type door is to use the door option of
  65. "O".  Some Paragon doors will not work using the "P" option because they
  66. don't open a properly named reply port.  4D-BBS will not check for a reply
  67. port and will start waiting for commands with the door option of "O".
  68.  
  69.     A simple menu example:
  70.  
  71.     h:c O Doors:filename
  72.  
  73. 10.1.4 CLI (FIFO)
  74.  
  75.     To use this option you must have Matt Dillion's FIFO.  It is in the
  76. Public Domain.  You need FIFO.library in your LIBS:  directory and to also
  77. run the FIFO-Handler.  Read the documentation that comes with FIFO for more
  78. details.  FIFO is available at 4D-BBS support BBS.
  79.  
  80.     Any program that does not detach itself from the standard input and
  81. output or open a window, should be able to be run with this option.
  82. usually if it will run on a CLI (with output to the CLI) it will work here.
  83. Example:  4D-BBS editors could be run as a FIFO door.  If a user hangs up
  84. during a FIFO door, 4D-BBS will send a Ctrl-C to try to abort the program.
  85. It is suggested that you only run programs that will abort on a Ctrl-C.
  86.  
  87.     A sample menu entry example:
  88.  
  89.     h:c F path/filename
  90.  
  91.     Or with embedded instructional code (EIC):
  92.  
  93.     h:c F doors:h&s/HSclient -t^[P7% "^[P3%"
  94.  
  95.     The "^[P7%" being time left on BBS and "^[P3%" is the users name.  Use
  96. quotes around any EIC that may have a space.
  97.  
  98.     There is also a built in SHELL you can start with this option.  This
  99. works VERY well for remote access.  But WARNING:  Keep it out of the reach
  100. of users.  It is just like using the CLI, except you can not click
  101. requestors.
  102.  
  103.     To run the SHELL use "4D-SHELL" (it is case sensitive).
  104.  
  105.     Example:  s:c F 4D-SHELL
  106.