home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / foyers15.lha / FoyerSelect.doc < prev    next >
Text File  |  1993-05-29  |  5KB  |  152 lines
  1. /**************************************************************************
  2. *                                                                         *
  3. *     FoyerSelect  All parts (c) Copyright 1993 by Michael R. Mossman.    *
  4. *                Released for private, non-commercial use.                *
  5. *                                                                         *
  6. *                     Compiled with SAS 6.20.                             *
  7. *                                                                         *
  8. *                                                                         *
  9. **************************************************************************/
  10.  
  11.  
  12.  
  13.  
  14. What is It ?
  15.  
  16.  FoyerSelect is a program designed to launch other serial device type
  17. programs from a FIDO frontend or a BBS program. With a FIDO 
  18. frontend you can offer your users several BBS programs or my
  19. program "SerServer" for DOS type things for your self (the Sysop).
  20.  
  21.  FoyerSelect does not offer any password protection like "Getty" or
  22. "Login", but for BBS programs this is not needed.
  23.  
  24.  
  25.  
  26.  
  27. How To Run It !
  28.  
  29.  FoyerSelect requires two files and if you like three;
  30.  
  31.                  1) FoyerSelect     -> the executable         (mandatory)
  32.                  2) FoyerSelect.cfg -> the configuration file (mandatory)
  33.                  3) FoyerSelect.txt -> text file to user on entry
  34.  
  35. FoyerSelect.cfg and FoyerSelect.txt can be in the current directory or
  36. in the "S:" directory.  
  37. FoyerSelect can take several switches or none, if you wish to accept
  38. the defaults. This is the structure of FoyerSelect's command line:
  39.  
  40.     FoyerSelect serial.device unit_number remain connect_baud_rate
  41.  
  42. Serial.device can be any type of serial driver out there...eg.
  43.  
  44.              siosbx.device
  45.              serial.device (default)
  46.              newser.device
  47.              modem0.device
  48.  
  49. Unit_number will be the unit number of the port on the card that you
  50. are using. If the builtin serial.device is used then this defaults
  51. to unit 0.
  52.  
  53. Remain tells FoyerSelect if after the user goes into on application
  54. if they can drop back to FoyerSelect and make another selection or if
  55. FoyerSelect is to return them to the program that called FoyerSelect
  56. ( eg. - the frontend). If you are running a BBS you might not want
  57. the user to be able to make another selection if they ran out of time.
  58. They probably would be then dropped by the frontend. The default is
  59. "1" or allow the user to make another menu selection.
  60.  
  61. Connect_baud_rate is the baud rate that the modem says that it connected
  62. at....eg.  "Connect 2400". Some frontends and BBS's will allow you
  63. to call FoyerSelect with variable arguments. You can then pass along 
  64. this argument to the programs that FoyerSelect calls with the "%b"
  65. argument.
  66.  
  67. eg. Trapdoor -> FoyerSelect siosbx.device 1 0 %B
  68.     Welmat   -> FoyerSelect newser.device 0 1 %d 
  69.  
  70.  
  71.  
  72.  
  73.  
  74. FoyerSelect.cfg
  75.  
  76.  This is the configuration file and must follow an exact format.
  77.  
  78. -----------------------------------CUT HERE--------------------------------
  79. Falcon_BBS execute mail:falcon
  80. SerServer  bbs:serserver siosbx.device 0 %b
  81. -----------------------------------CUT HERE--------------------------------
  82.  
  83.  
  84.  
  85. There are no blank lines in the file at the beginning or end!!! Extra
  86. line feeds will be taken as menu items to the program. In the file 
  87. above, there are only two line feeds. The first menu item (Falcon_BBS) 
  88. starts at the very beginning of the line (no spaces) and the menu item
  89. can not have spaces in it (the reason for the under score rather then
  90. a space). The next thing is the path and executable name. This is 
  91. seperated from the menu item label by a space. Next can come five 
  92. options or arguments to the called program. Each of these are seperated
  93. by spaces. You will notice that SerServer menu item has a "%b" argument
  94. that will call SerServer with the connected baud rate. The above 
  95. configuration file will give you the following look:
  96.  
  97.  
  98. -----------------------------------CUT HERE-------------------------------
  99.  
  100.  
  101. FoyerSelect Version 1.5. Copyright (c) 1993 by Michael R. Mossman
  102.  
  103. Please Make Your Selection :
  104.  
  105. 0   Terminate & Exit
  106. 1   Falcon_BBS
  107. 2   SerServer
  108.  
  109. -----------------------------------CUT HERE-------------------------------
  110.  
  111.  
  112. You will also notice that FoyerSelect can also call script files. The above
  113. script configures Falcon BBS before it is called.
  114.  
  115.  
  116.  
  117.  
  118. FoyerSelect.txt
  119.  
  120.  This is a text file that is displayed to the user between the Copyright
  121. notice and the "Please Make Your Selection :" line. It can be anything
  122. that you wish to tell them and is a straight Amiga DOS text file as
  123. generated with "Ed".
  124.  
  125.  
  126.  
  127. Bugs
  128.  
  129.  None known at this time.
  130.  
  131.  
  132. Copyright etc.
  133.  
  134.  This code is solely base on my own code and nothing was used from "Login"
  135. or "Getty". I do admit that both of these programs gave me ideas. The
  136. personal need was also there!!
  137.  
  138.  
  139. I (Mike Mossman) can be contacted via FIDO at 1:255/19.
  140.  
  141.  
  142.                  "No man is an island onto himself."
  143.  
  144.  
  145.  
  146. Version 1.5 - Cleared the serial port buffer before asking for input
  147.               from the user. Noise or garbage that was in the buffer
  148.               from the frontend was being taken by FoyerSelect as 
  149.               user input.
  150.               
  151.             - Added some feedback to the user when they selected
  152.               the "Terminate and Exit" option.