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