home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / STERM.ZIP / STERM.DOC < prev    next >
Text File  |  1991-03-16  |  8KB  |  201 lines
  1.  
  2.                 STERM: OS/2 Terminal Mangler
  3.                               
  4.                               
  5.      No warranty, expressed or implied, accompanies this
  6. software.  Use it at your own risk.  No guarantee of
  7. reliability or support may be attached to this offering.
  8.  
  9.      Since I am gathering up all the current pieces of
  10. STERM, it seemed like a good time to provide some meager
  11. tidbits of documentation for the benighted user.
  12.  
  13.      Currently, only one command-line parameter is
  14. supported, the path to the connection description file to be
  15. used with this access.  The next release, if any, will have
  16. this parameter point (optionally) to a connection directory
  17. file which will contain a list of connection description
  18. files and their description (sort of a pick list of
  19. connections).
  20.  
  21.      Commands are of the verb ... object style.  Some of
  22. them may require or optionally support quoted (double or
  23. single) strings.  The operation of the program is very
  24. sensitive to the order of these commands.  The rationale for
  25. this order may not be immediately apparent.  The best course
  26. is to follow some of the given examples, if they work.
  27.  
  28.      All lines beginning with an asterisk (*) are considered
  29. comments; these will not slow the process too much.  The
  30. commands are case insensitive, or should be.
  31.  
  32.                         Installation
  33.  
  34.      Executable material and sample definition files are in
  35. STERM.ZIP.  Unzip this to the directory for communications
  36. or to a unique directory.  Direct any reasonable query about
  37. the source via my BIX userid 'dserls'.  This source is
  38. written for the JPI Topspeed C environment; the project file
  39. is included. For those with other compilers, the thread
  40. start and stop code may have to be 'adjusted' for the
  41. particular runtime.  I would put this in a development path.
  42. Modify the .PRM files in your communications directory for
  43. correct phone numbers, ports, line attributes, and
  44. passwords.  Add a menu item to your communication PM group:
  45. specify the full path of the STERM.EXE file, specify the
  46. working directory as the spot where the .PRM files are
  47. located.  Be sure that STERM.ICO resides with the .EXE file.
  48. For the 'parameter' description for PM, use something like
  49. '[Connect To?]'; this will have PM prompt you for the
  50. definition filename.
  51.      
  52.      The only feature of this terminal program which might
  53. distinguish it from others is the SIMVT mode.  This barely
  54. supports 3278 emulation via VT100 emulation using the
  55. mainframe host program SIM3278(tm).   An installation task
  56. for SIMVT users is to insure that a valid key-mapping exists
  57. for PC keys to 3270 keys.  The default mapping assumes the
  58. old-style AT keyboard.  If you have an enhanced keyboard, or
  59.  
  60.                 STERM: OS/2 Terminal Mangler
  61.                               
  62.                               
  63. some other strangeness, edit this file.  It contains a
  64. sample for every key that can be mapped in the form
  65. 'pckey=3270key'.
  66.                                                             
  67. Anyhow, STERM is an OS/2 communication program which accepts
  68. a definition file as a connection parameter and acts as a
  69. dumb terminal.  There must ALWAYS be a definition file.
  70.  
  71. I hope to add XMODEM and/or KERMIT support as well as
  72. SIM3278 support in its 'native' mode.
  73.  
  74.       I went wild with threadness and assigned a thread each
  75. to:
  76.    (1)  writing to the COM port.
  77.    (2)  reading from the COM port.
  78.    (3)  writing to the display.
  79.    (4)  reading the keyboard.
  80.  
  81.      This does not include the main thread which processes
  82. the command file and handles housekeeping.
  83. These threads are woven together with anonymous pipes, so
  84. that those which accept input can do so from multiple
  85. sources.
  86.  
  87.      The video output thread must soon become much more
  88. sophisticated since it needs some way of accepting
  89. attributes and screen addresses.
  90.  
  91.      The current set of commands is:
  92.      Modem Initialization --
  93.  
  94.          PORT - accepts 1, 2, or 3.
  95.          This defaults to 1 if not contained in the
  96.          command file or specified after the 1st SEND.
  97.  
  98.          SPEED - the baudrate.
  99.          Accepts most popular rates.
  100.  
  101.          STOPBITS - accepts '1', '1.5', or '2'
  102.  
  103.          PARITY - accepts 'EVEN', 'ODD', 'SPACE',
  104.                   'MARK', or 'NONE'.
  105.  
  106.          DATABITS - accepts 5 thru 8 (5?).
  107.  
  108.          ECHO - whether local echo of keyboard input is
  109.                 to be done (half duplex).
  110.  
  111.  
  112.  
  113.       Pacing Control --
  114.  
  115.          DELAY - time in millisecs (minimum of 10).
  116.                 DosSleep is called here.
  117.  
  118.                 STERM: OS/2 Terminal Mangler
  119.                               
  120.                               
  121.  
  122.          SEND - send data to the port.
  123.                 This can be in the form of a single or
  124.                 double-quoted string for character data
  125.                 or an identifier for control codes.
  126.                 The current set of identifiers is:
  127.                     CR, LF, SOH, XON, and ETX.
  128.  
  129.                 STERM: OS/2 Terminal Mangler
  130.                               
  131.                               
  132.  
  133.  
  134.          AWAIT - wait for a particular string.
  135.                 The data may be specified as for 'SEND'.
  136.                 A 30 sec. timeout is the default here, but
  137.                 is adjustable via the TIMELIM command.
  138.                 An Alt-X should 'break' this wait, mostly.
  139.  
  140.          TIMELIM - specify timeout value for AWAIT.  The
  141.                 value is in milliseconds.
  142.  
  143.      Screen --
  144.  
  145.          COLOR - syntax is 'foreground ON background'
  146.                 The list of colors is:
  147.                 BLACK, BLUE, CYAN, GREEN, MAGENTA, RED,
  148.                 BROWN, WHITE, GRAY, LITEBLUE, LITECYAN,
  149.                 LITEMAGENTA, LITEGREEN, LITERED, YELLOW, and
  150.                 BRITE.  The usual proscriptions apply to the
  151.                 mixing of colors which cause blinking.
  152.  
  153.      Emulation --
  154.  
  155.          TERMINAL - enter TTY or SIMVT.  This VT100 emulator
  156.                 should be SIMVT, since it's only effective
  157.                 for SIM3278.  Soon expect ANSI (BBS) and a
  158.                 more 'real' VT100.  Be careful about where
  159.                 in the description file this is specified.
  160.  
  161.          COMLOG - copy characters arriving or departing
  162.                 at the COM port to the disk file STERM.LOG
  163.                 in the current directory.
  164.  
  165.          3270KEYS - the pathname of a file containing the
  166.                 desired equivalencies between the PC
  167.                 keyboard and its 3270 equivalent.
  168.                 See the sample .KEY file.  More than one
  169.                 PC key may be set to the same 3270 key,
  170.                 (F8 and PGDN for example).
  171.  
  172.  
  173.      Tweaking the 'Delay' times before 'SENDing' data will
  174. usually obtain the desired result in the script.
  175.  
  176.  
  177.      Two immediate special-key commands are Alt-E and Alt-X;
  178. the former to toggle the ECHO state, the latter to terminate
  179. the program immediately.  Also, Alt-C will clear the screen
  180. without informing the host, during a terminal session.
  181.  
  182.      Another 'special' key is Alt-D, which is used to enter
  183. one or more of the above commands while in a terminal
  184. session.  The top line of the screen will temporarily be
  185. usurped for the purpose of displaying the entered text.
  186.  
  187.                 STERM: OS/2 Terminal Mangler
  188.                               
  189.                               
  190. When Alt-D is again pressed, the previous contents of the
  191. top screen line will be replaced.
  192.  
  193.      In the 3270 emulation mode, many bugs are extant.
  194. Try to avoid HOME, which cannot behave as in a real 3270.
  195. Currently, a CR is sent following the Home sequence; this
  196. causes the entry of any data within an input area.
  197. Also, backspace is semi-destructive currently - eventually
  198. its behavior will be parameter specified.
  199.  
  200.  
  201.