home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / games / empire22.lzh / Doc / SEREmp < prev    next >
Encoding:
Text File  |  1990-08-26  |  10.2 KB  |  202 lines
  1.                     Amiga Empire by Chris Gray - SEREmp
  2.  
  3.  
  4. SEREmp is the Amiga Empire client program which communicates with a remote
  5. player over a serial port. By default, it will use the standard Amiga
  6. serial port and will "autobaud" between 2400, 1200 and 300 baud, allowing
  7. connections with either 8 data bits and no parity, or with 7 data bits and
  8. even parity. Parameters specified on the shell command line, or via
  9. WorkBench Tool Type entries, can override these defaults. SEREmp should be
  10. compatible with Matt Dillon's 'Getty' program, and with startup by BBS
  11. programs. Note that SEREmp does not automatically start up EmpServ, the
  12. Amiga Empire server program, so in Getty or BBS applications, EmpServ must
  13. have been previously started. When SEREmp is started from the WorkBench, it
  14. can be started directly by double clicking on the SEREmp icon, or
  15. indirectly by double clicking on a project icon whose Default Tool entry
  16. indicates SEREmp. In the former case, the Tool Type entries for SEREmp
  17. itself are used. In the latter case, the Tool Type entries for the project
  18. are used. When started from a shell, the '-' in front of flags can be
  19. omitted. In the following descriptions, the shell flag is given, followed
  20. by the Tool Type name that has the same function, if any. Flag values which
  21. are on-off switches can be specified in Tool Types with any of 'ON', 'OFF',
  22. 'YES' or 'NO'. The various parameters that can be specified are:
  23.  
  24.     -d [DEVICE=] [default serial.device] - specify which serial device is
  25.         to be used. There must be a corresponding driver file in your DEVS:
  26.         directory. The default name, 'serial.device' corresponds to the
  27.         standard serial port built in to all Amigas. Other valid names
  28.         include 'siosbx.device', which would refer to ASDG's dual port
  29.         board. There must be no spaces between the 'd' and the device name.
  30.  
  31.     -u [UNIT=] [default 0] - specify which unit of the device to use. The
  32.         standard 'serial.device' only supports one unit, so '0' should be
  33.         used. 'siosbx.device' supports two units per board installed. CBM's
  34.         seven-port board presumeably supports units 0 through 6. At the
  35.         programming level, this unit number is given as the 'unit'
  36.         parameter on the 'OpenDevice' call. There must be no spaces between
  37.         the 'u' and the unit number.
  38.  
  39.     -b [BAUD=] [default 0] - specify the baud rate to use for the
  40.         connection. Any value can be given here, and some serial devices
  41.         will support them, but you will normally use a standard value like
  42.         1200, 2400, 9600, etc. Value 0 is special, in that it indicates
  43.         that autobaud selection is desired. This is the most common value
  44.         to use with modems. The modem will come up first in 2400 baud, and
  45.         SEREmp will try to read a carriage return. If it fails, it will
  46.         switch to 1200 baud and try again. A second failure will result in
  47.         a try at 300 baud. If that fails, it will switch back to 2400 baud
  48.         and repeat the cycle. The tests are done with 8 data bits and no
  49.         parity bit, and if a carriage return with the high bit set is
  50.         received, SEREmp will assume even parity with 7 data bits. Thus,
  51.         with a baud selection of 0, connecting players must enter 1, 2 or
  52.         3 carriage returns before they get the initial connection message.
  53.         With other values, the connection message is sent a couple of
  54.         seconds after the connection is established, without waiting for
  55.         any input characters. There must be no spaces between the 'b' and
  56.         the baud rate.
  57.  
  58.     -s [SHARED=] [default not shared] - specify whether the serial port is
  59.         to be opened in shared mode or not. In shared mode, the open will
  60.         succeed even if some other program already has the port open, so
  61.         long as they have opened it in shared mode also. Similarly, in
  62.         shared mode, subsequent programs can open the same port. In non-
  63.         shared mode, there must be no other programs with the port open,
  64.         and no future requests, shared or otherwise, will be allowed until
  65.         SEREmp exits.
  66.  
  67.     -x [XONOFF=] [default disabled] - specify whether or not XON/XOFF
  68.         handshaking is to be enabled. This handshaking allows the remote
  69.         user to suspend output by typing a control-S, and resume it by
  70.         typing a control-Q. There is a timeout on all serial port
  71.         activities, but this may not work correctly with all devices, thus
  72.         it may be possible for a user to suspend a SEREmp indefinitely if
  73.         this is enabled. The timeout does work correctly with the built-in
  74.         serial port.
  75.  
  76.     -i [IGNORECD=] [default disabled] - if this flag is specified, then
  77.         SEREmp will ignore the presence or absence of the CD (carrier
  78.         detect) signal on the serial port. Normally, this signal is used to
  79.         indicate when a connection is made via a modem. If the modem or
  80.         terminal you are using does not generate this signal, then you can
  81.         specify this flag to force SEREmp to connect, without waiting for
  82.         the CD signal.
  83.  
  84.     -7 [7WIRE=] [default disabled] - specify whether the serial device is
  85.         to use 7-wire hardware handshaking or not. The default is to ignore
  86.         all wires on the serial port except the transmit and receive data
  87.         lines. This hardware protocol is mostly useful for programs which
  88.         transfer data at high rates to other programs. Various serial
  89.         devices will support it with varying degrees of success. How well
  90.         it works will also depend on the serial cable you are using, and on
  91.         the support of the device on the other end of the cable.
  92.  
  93.     -p[neo] [PARITY=] [default no parity] - specify the parity setting for
  94.         the serial port. On WorkBench, the choices are 'NONE', 'EVEN' and
  95.         'ODD'. From a shell they are 'n', 'e' and 'o'. There must be no
  96.         space between the 'p' and the parity letter.
  97.  
  98.     -tr [RETRY=] [default 60] - number of seconds to wait between attempts
  99.         to open the specified serial port. This retrying allows SEREmp to
  100.         wait for non-shared access to the port when another program
  101.         currently has the port open. As usual, there must be no spaces
  102.         between the 'tr' and the value.
  103.  
  104.     -tp [PROBE=] [default 1] - number of seconds to wait between probes of
  105.         the serial port to see if there is a call incoming. One second is
  106.         fairly short, but going to much more than 10 seconds could result
  107.         in callers thinking the system is not running.
  108.  
  109.     -td [DISCONNECT=] [default 3] - number of seconds to pause after an
  110.         incoming call has terminated before looking for another call.
  111.         Normally, during the wait period, the DTR line to the modem will be
  112.         inactive. This delay is often needed to fully disconnect two
  113.         modems.
  114.  
  115.     -tt [TIMEOUT=] [default 5 * 60] - number of seconds (the default is 5
  116.         minutes) of inactivity on the serial port before a timer goes off
  117.         and attempts to terminate the session. This timeout is applied to
  118.         all reads and writes to the port. Its purpose is to clear a call
  119.         that is hung due to a user using control-S and then disconnecting.
  120.         The previous release of Amiga Empire had a problem with this.
  121.  
  122.     -FLUSH [FLUSH] - If this flag appears then SEREmp will send the server a
  123.         rt_flush instead of a rt_writeWorld after each country logs out.
  124.         This can take 10-15 secs on a large world, and should probobly
  125.         only be used on single-user systems, or when you are paranoid
  126.         about losing data. NOTE: This flag is different from the flush
  127.         option inside Empire itself!
  128.  
  129.     -TEST [TEST] - Use the test message port instead of the standard port.
  130.         Used with the EmpServ -t flag to allow testing Empire while the main
  131.         system is still running.
  132.  
  133.     -NORESET [NORESET] - Turns off the "ATZ" that is normally sent to the
  134.         modem when autobaud is selected.
  135.  
  136. A few special-purpose shell command line flags have no WorkBench
  137. equivalent. They were included for compatibility with Matt Dillon's 'Getty'
  138. program, but are of use to any BBS program wishing to start up SEREmp as
  139. well. They are:
  140.  
  141.     -Getty - specify that a Getty connection is being made. This forces the
  142.         port to be opened in shared mode, and disables any parameter
  143.         setting by SEREmp - the port is used in whatever state it is left
  144.         by the calling program. Any baud rate, parity, 7wire, or xon/xoff
  145.         switches specified will be ignored.
  146.  
  147.     -DEVICE device-name - specifies which serial device to use. This is
  148.         equivalent to the '-d' or 'DEVICE=' flags. Note that in this case
  149.         there must be at least one space between the '-DEVICE' and the
  150.         device name.
  151.  
  152.     -UNIT unit-number - specifies which unit of the serial device to use.
  153.         This is equivalent to the '-u' or 'UNIT=' flags. In this case also,
  154.         there must be at lease one space between the '-UNIT' and the unit
  155.         number.
  156.  
  157. Shell Examples
  158.  
  159.     Run SEREmp
  160.  
  161. Use 'serial.device' unit 0, with autobaud/parity selection, no XON/XOFF
  162. protocol, no 7-wire protocol, exclusive access, expect CD to be active, use
  163. an open retry time of 1 minute, a call probe time of 1 second, a disconnect
  164. interval of 3 seconds and a port timeout of 15 minutes.
  165.  
  166.     Run SEREmp -dsiosbx.device -u1 -b2400 -po -7 -s -tt60
  167.  
  168. Use the ASDG 'siosbx.device', unit 1, at a fixed baud rate of 2400 with
  169. odd parity. Enable the 7-wire protocol, pay attention to CD, open the
  170. device for shared use, use an open retry time of 1 minute, a call probe
  171. time of 1 second, a disconnect interval of 3 seconds and a port timeout of
  172. 1 minute.
  173.  
  174.     Run SEREmp -b9600 -pe -i
  175.  
  176. Use 'serial.device', unit 0, with a fixed baud rate of 9600 with even
  177. parity. Open the device for exclusive use, and ignore the CD signal.
  178. Everything else is the default. I use this setting to connect to the ADDS
  179. Viewpoint terminal I have connected to my standard serial port.
  180.  
  181.  
  182. WorkBench Examples
  183.  
  184. The same examples as above, done with WorkBench Tool Types are:
  185.  
  186. 1)
  187.     <no Tool Type entries needed for the first example>
  188.  
  189. 2)
  190.     DEVICE=siosbx.device
  191.     UNIT=1
  192.     BAUD=2400
  193.     PARITY=ODD
  194.     7WIRE=ON
  195.     SHARED=YES
  196.     TIMEOUT=60
  197.  
  198. 3)
  199.     BAUD=9600
  200.     PARITY=EVEN
  201.     IGNORECD=YES
  202.