home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / utils / te2 / tool / cpk2_101.doc < prev   
Encoding:
Text File  |  1992-07-21  |  11.0 KB  |  246 lines
  1.                                Oberon CommPak/2 Dynamic Link Library
  2.        Asynchronous Communications Routine Library for use with TE/2
  3.                                                         Version 1.01
  4.  
  5.                                                      Oberon Software
  6.                                                518 Blue Earth Street
  7.                                               Mankato, MN 56001-2142
  8.  
  9.                                            Voice Phone: 507/388-7001
  10.                                                    BBS: 507/388-1154
  11.                                            MCI Mail: oberon/413-5847
  12.                                                GEnie Mail: B.FLOWERS
  13.                                                      CIS: 72510,3500
  14.  
  15.                                                        July 21, 1992
  16.  
  17.   -------------------------------------------------------------
  18.  
  19. Copyright 1991-92, Oberon Software, Mankato, MN - All Rights Reserved
  20.  
  21.   -------------------------------------------------------------
  22.  
  23.   This version of the file COMMPAK2.DLL is a replacement for the file
  24. of the same name which is distributed with the Oberon Terminal
  25. Emulator/2.  The dynalink library contains the routines which TE/2
  26. uses for its low and medium level access to the communication device,
  27. terminal emulation, and file transfer protocols.
  28.  
  29.   If you are currently using TE/2 version 1.20 you should replace
  30. your existing COMMPAK2.DLL with this file.
  31.  
  32.   This version of COMMPAK2.DLL is NOT guaranteed to work with any
  33. version of TE/2 prior to version 1.20.  If you are using a version
  34. of TE/2 prior to 1.20, you should obtain the latest version. 
  35. Please contact Oberon Software if you are unable to locate a copy.
  36.  
  37.   Oberon Software will no longer officially support versions of TE/2
  38. prior to Version 1.10.C nor versions of COMMPAK2.DLL prior to Version
  39. 0.99.
  40.  
  41.   -------------------------------------------------------------
  42.  
  43.   The CommPak/2 Dynamic Link Library is a shareware product of
  44. Oberon Software.  You may freely use it in conjunction with TE/2 with
  45. no further registration commitment than is already implied by your
  46. use of TE/2.  If you are already a registered user of TE/2, use of
  47. this file is completely free.  If you have not registered TE/2, you
  48. are urged to do so, but this file is considered to be part of the
  49. shareware package and does not require its own separate registration.
  50.  
  51.   Enhancements to this library will occur from time to time
  52. independent of version releases of other Oberon Software products.
  53. The most current version of this library, so long as it is compatible
  54. with the current released version of TE/2, will always be available
  55. on the Oberon User Support BBS (507/388-1154, HST).  We will also
  56. make sure that new releases of this library appear on GEnie,
  57. Compuserve, BIX, and major BBSes around the world as they become
  58. available.
  59.  
  60.  
  61.   -------------------------------------------------------------
  62.  
  63.   INSTALLATION:
  64.  
  65.   If you have already installed a compatible version of TE/2 (as
  66. defined above), simply locate the file COMMPAK2.DLL on your hard disk
  67. and replace it with this copy of that file.  Please note that if TE/2
  68. is currently running you must exit TE/2 before copying the new file
  69. over the existing one.  The next time you start TE/2 the new dynamic
  70. link library will be used.
  71.  
  72.   If you have not yet installed TE/2, please follow the installation
  73. instructions contained in the TE/2 documentation and then replace
  74. COMMPAK2.DLL as outlined in the previous paragraph.
  75.  
  76.  
  77.   -------------------------------------------------------------
  78.  
  79.  
  80.   WHAT'S NEW?
  81.  
  82.   File Transfer Protocols
  83.   =======================
  84.  
  85.   All file transfer protocols have been reworked somewhat.  YModem
  86.   has been recompiled to remove some overzealous compiler
  87.   optimizations which were causing troubles in many cases.  A
  88.   "priority contention" between several threads (used in all the
  89.   protocols) has been resolved which should result in more robustness
  90.   for all the protocols.  ZModem has been heavily worked on to deal
  91.   with several problems including the occurrence of large numbers of
  92.   retried packets, CRC errors, and failure to resynchronize after
  93.   retried packets.  Further, the ZModem in Commpak/2 1.00 would fail
  94.   to work with some other implementations of ZModem such as the DOS
  95.   program DSZ and the Unix sz if the sending program attempted to
  96.   escape control characters.  This problem has been addressed.  This
  97.   implementation of ZModem will NOT work with the complementary rz/sz
  98.   which Omen Technologies distributes for VAX VMS systems because
  99.   those programs contain copyrighted ZModem-90(tm) extensions which
  100.   insure that these programs will only operate in conjunction with
  101.   other Omen products. Omen Technologies sells a VAX VMS version of
  102.   rz/sz which will work with other vendors ZModems.  If you need
  103.   this, you must contact Omen.
  104.  
  105.  
  106. General notes on the COMMPAK2FLAGS environment variable
  107. =======================================================
  108.  
  109.   The two items below both instruct you to set or unset some flags in
  110.   this environment variable.  It would seem to be a good idea to
  111.   restate the format for this here before proceeding.  The variable
  112.   must be set in the OS/2 environment before TE/2 is executed;
  113.   Commpak/2 reads the value only at start-up.  Thus, you should set
  114.   the value in your config.sys file or, if you start TE/2 from a
  115.   batch file, you could set it there.  The general format of the
  116.   variable is:
  117.  
  118.     set COMMPAK2FLAGS=<flag1>:<val1>;<flag2>:<val2>; ...
  119.  
  120.   where "flag1" and "flag2" are one-letter settings, "val1" and
  121.   "val2" are the values to which the flags are set and their format
  122.   depends on the flag in question.  You may have as many or as few
  123.   flags in this list as you need, each flag/value pair is separated
  124.   from the next by a semicolon.  The list itself should be
  125.   terminated with a semicolon.
  126.  
  127.   Thus, to set the VT100 default attribute flag (discussed below) to
  128.   "23" and the Extended Hardware Buffering flag (also discussed below)
  129.   to "N", you would use the following statement in your config.sys or
  130.   start-up batch file:
  131.  
  132.     set COMMPAK2FLAGS=V:23;X:N;
  133.  
  134.   Currently, the available flags are:
  135.  
  136.     Flag  Value
  137.     ----  -----
  138.     'K'   Set to 0, 1, or 2 will determine how (or whether) the file
  139.           transfer protocols sample the keyboard for the ESCape key.
  140.           0 implies no keyboard check, 1 will cause it to use a
  141.           no-wait keyboard read, and 2 will use KbdPeek to check for
  142.           a keystroke.  Default value is 2.
  143.     'V'   Set to a number from -1 to 255 to set the VT100 default
  144.           screen attribute.  -1 (the default) will enable the default
  145.           VT100 screen attribute of white on black (7).  See
  146.           discussion below.
  147.     'X'   Set to 'Y' or 'N'.  Default is 'N'.  If set to 'Y', this
  148.           will cause the file transfer protocols to attempt to enable
  149.           the device driver's Auto-Buffering mode for the 16550 UART.
  150.           Otherwise, the setting will be left as is.  See the
  151.           discussion below.
  152.  
  153.  
  154. VT100
  155. =====
  156.  
  157.   People have suggested that it would be more esthetically pleasing
  158.   if there were a way to override the VT100 default color attribute
  159.   of White on Black to a setting of the user's choice.  As an interim
  160.   measure, you are now able to set this via the COMMPAK2FLAGS
  161.   environment variable.  To do this set the flag "V" to the decimal
  162.   value of the attribute you would like the VT100 to use as the
  163.   default (note, to make this work the best, this should be the same
  164.   value you use for the TermAttr in TE2.INI).
  165.  
  166.   For example, if you like white text on a blue background you should
  167.   set TermAttr to 23 in TE2.INI and your COMMPAK2FLAGS setting should
  168.   contain "V:23;" (in TE2.INI you have the option of using the hex
  169.   notation: 0x17).  There is a table in the TE/2 documentation which
  170.   should help you in deciding what the numeric value of the color
  171.   attribute you wish to use is.  In the next release of TE/2, this
  172.   will be directly settable from TE/2; the COMMPAK2FLAGS flag is only
  173.   an interim workaround.
  174.  
  175.  
  176. Extended Hardware Buffering
  177. ===========================
  178.  
  179.   Changed default value on "X" flag for COMMPAK2FLAGS:
  180.   ----------------------------------------------------
  181.   The "X" flag (which is set to "Y" or "N" to enable/disable the
  182.   probe for a 16550 UART when protocols start up) used to default to
  183.   "Y", it now defaults to "N" because the OS/2 com driver mishandles
  184.   this on some machines (notably some PS/2 model 70's with a 16450
  185.   UART in which case it causes OS/2 to halt!).  Thus, if you have
  186.   been instructed to "set COMMPAK2FLAGS=X:N;", you can now remove
  187.   this from your config.sys or session start-up if you would like.
  188.  
  189.   General note regarding Extended Hardware Buffering
  190.   --------------------------------------------------
  191.   It is probably best to set this via the OS/2 MODE command as is
  192.   appropriate for your hardware and to set TE/2 and Commpak/2 to not
  193.   alter the setting.  With the change in COMMPAK2FLAGS mentioned
  194.   above, no further action is required for Commpak/2.  For TE/2, you
  195.   should make sure that the keyword "ExtendedFIFO" is either deleted
  196.   or "commented out" of your TE2.INI file and/or modem include file.
  197.  
  198.  
  199.   -------------------------------------------------------------
  200.  
  201.   We intend to document the API (Application Program Interface) for
  202. CommPak/2 and make it available to interested parties.  If you are
  203. interested in such a toolkit, fell free to contact Oberon Software
  204. via the Oberon BBS for information.
  205.  
  206.  
  207.   -------------------------------------------------------------
  208.  
  209.   The code contained in the accompanying file COMMPAK2.DLL ("the
  210. software") and this document are:
  211.  
  212.                 Copyright (c) 1990-1992
  213.                 by Oberon Software
  214.                 518 Blue Earth Street
  215.                 Mankato, MN 56001-2142  USA
  216.  
  217.   Portions of the ZModem code are:
  218.  
  219.                 Copyright (c) 1991-1992
  220.                 by Chris Laforet and Chris Laforet Software
  221.                 Graham, NC
  222.  
  223.   -------------------------------------------------------------
  224.  
  225.  
  226.   Use of this software for any purpose whatsoever constitutes your
  227. unqualified acceptance of the following statements.
  228.  
  229.   The author makes no warranty or representation that the software will
  230. be error free.  The author disclaims any warranties, either express or
  231. implied, including but not limited to any implied warranty of
  232. merchantability or fitness for any particular purpose.
  233.  
  234.   The user agrees to take full responsibility for the selection of and
  235. any use whatsoever made of the software.
  236.  
  237.  
  238.     IN NO EVENT WILL THE AUTHOR BE LIABLE FOR ANY DAMAGES WHATSOEVER
  239.   (INCLUDING WITHOUT LIMITATION DAMAGES FOR LOSS OF BUSINESS PROFITS,
  240.   BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION OR THE LIKE)
  241.   ARISING OUT OF THE USE OF, INTERRUPTION IN THE USE OF, OR INABILITY
  242.   TO USE THIS SOFTWARE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF ANY
  243.   POSSIBILITY OR LIKELIHOOD OF SUCH DAMAGES.
  244.  
  245.  
  246.