home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD2.bin / bbs / comm / terminus-2.0d.lha / Terminus / Docs / xprkermit.doc < prev   
Text File  |  1993-12-21  |  18KB  |  381 lines
  1.                               XPR Kermit
  2.                          Version 1.111 - RELEASE
  3.                            December 21, 1991
  4.  
  5.                      Marco Papa - Felsina Software
  6.                 Stephen R. Walton, Cal State Northridge
  7.  
  8. This is an implentation of an External Protocol (XPR) library for the
  9. Kermit file transfer protocol.  In keeping with the Kermit documents,
  10. here is a list of the items supported and not supported.
  11.  
  12. XPR Kermit Capabilities At A Glance:
  13.  
  14.   Local operation:                   Yes
  15.   Remote operation:                  No
  16.   Login scripts:                     *
  17.   Transfer text files:               Yes
  18.   Transfer binary files:             Yes
  19.   Wildcard send:                     Yes
  20.   File transfer interruption:        Yes
  21.   Filename collision avoidance:      No
  22.   Can time out:                      Yes
  23.   8th-bit prefixing:                 Yes
  24.   Repeat count prefixing:            Yes
  25.   Alternate block checks:            Yes
  26.   Terminal emulation:                *
  27.   Communication settings:            Yes
  28.   Transmit BREAK:                    *
  29.   Support for dialout modems:        *
  30.   IBM mainframe communication:       *
  31.   Transaction logging:               No
  32.   Session logging (raw download):    No
  33.   Debug logging:                     No
  34.   Packet logging:                    No
  35.   Act as server:                     No
  36.   Talk to server:                    Yes
  37.   Advanced server functions:         No
  38.   Local file management:             *
  39.   Command/Init files:                *
  40.   UUCP and multiuser line locking:   *
  41.   Long packets:                      Yes
  42.   Sliding Windows:                   No
  43.   File attributes packets:           No
  44.   Command macros:                    *
  45.   Raw file transmit:                 *
  46.  
  47. The items marked with a '*' above are those which are to be provided by the
  48. calling terminal emulation program.  Notice that, although XPR Kermit itself
  49. cannot be a "Kermit server," often the communcation program's scripting
  50. capability will allow XPR Kermit to be used for the unattended transfer
  51. of files between the Amiga and a remote machine.
  52.  
  53. I. Introduction
  54. ---------------
  55.  
  56. XPR Kermit implements the Kermit file transfer protocol in the form of an
  57. Amiga External Protocol (XPR) library.  This allows the addition of an
  58. up-to-date version of the Kermit protocol to any communications program
  59. which supports the XPR specification.  For further information on Kermit,
  60. read the book "Kermit:  A File Transfer Protocol" by Frank da Cruz, 1986,
  61. Digital Press.
  62.  
  63. To install XPR Kermit, simply copy the file "xprkermit.library" to your
  64. LIBS: directory, and request your comm program to use XPRKERMIT as its
  65. external file transfer protocol.
  66.  
  67. XPR Kermit supports Version 2.0 of the XPR Protocol specification.  For
  68. more details on this, I recommend that you find a copy of the XPR Zmodem
  69. library, version 2.0.  Its documentation contains a good deal of the
  70. justification and philosophy of external protocol libraries, which I
  71. won't repeat here.
  72.  
  73. Please note that this document assumes you already have some
  74. understanding of what the Kermit protocol is, and how to use it.  I
  75. have tried to include a few hints about common problems, but there is
  76. no substitute for obtaining and using a copy of the documentation for
  77. the Kermit on the other system to which you will be talking.  In
  78. addition, two commercial books are available.  "Kermit:  A File
  79. Transfer Protocol" by Frank da Cruz describes the protocol in some
  80. detail.  While aimed at those writing a Kermit program, it contains a
  81. good deal of useful information about Kermit itself.  "MS-DOS Kermit"
  82. by Christine Gianone is, despite its title, a wealth of good
  83. introductory information about any version of Kermit.
  84.  
  85. II. Setting Options
  86. -------------------
  87.  
  88. XPR Kermit supports the parts of the Kermit protocol outlined in the table
  89. above.  There are currently seven user-settable parameters in XPR Kermit,
  90. which cover the parameters which are most often necessary to customize.
  91. If your communications problem is especially severe--for example, your
  92. method of connection to another system swallows characters which are special
  93. to Kermit, such as '#' or '&'--you may need to get a copy of the stand-alone
  94. Kermit program, C Kermit for the Amiga, distributed via many paths.
  95.  
  96. There are actually two sets of "setup" parameters in XPR Kermit.  The first
  97. set are commands which XPR Kermit can send to a remote Kermit server. These
  98. are not actually setups, but are in fact commands to XPR Kermit which cause it
  99. to communicate with a remote Kermit server.  The fourth command in this group
  100. is "Change Options," which causes no communication.  Instead, you are
  101. requested for changes in the current values of the parameters which Kermit
  102. will use for communication.
  103.  
  104. These items can be set in one of two ways.  One method is with a simple
  105. character string which is sent to XPR Kermit by the comm program;  this string
  106. will hereafter be referred to as the "init string."  This is generally done if
  107. an environment variable named "xprkermit" exists and has a value, in which
  108. case XPR Kermit is sent the value when you first select XPR Kermit as your
  109. protocol.  Some comm programs also allow an initialization string to be sent
  110. in other ways, such as from a script; VLT, for example, has an INITXPR script
  111. command.  The format of this string is specified by the external protocol.
  112.  
  113. The second, more elegant method, is with some type of requester or set
  114. of requesters.  In this case, you will be presented by your comm program
  115. with a set of Intuition gadgets of some type which allow the choice of
  116. XPR Kermit commands and the setting of the options.
  117.  
  118. However, the string method has the advantage of giving one the ability to
  119. change external protocol settings non-interactively, such as from a script. 
  120. In the case of XPR Kermit, such a script can actually command XPR Kermit to
  121. perform communication.  One obvious use of this is to transfer an entire
  122. directory tree from your Amiga to a remote machine:  you can make the remote's
  123. Kermit a server and command it to perform the appropriate CD commands, then
  124. transfer files.
  125.  
  126. The currently supported XPR Kermit server commands are listed below.
  127. The format of the init string is in parentheses, generally simply a
  128. single letter.
  129.  
  130.     Kermit Finish (F):  Tells a Kermit server that you are done.  The
  131.     remote server will stop being a server.
  132.  
  133.     Kermit Bye (B):  Tells a Kermit server that you are done;  the server
  134.     will exit and log you off the remote machine.
  135.  
  136.     Kermit CD (C{dir}):  Change the default directory for files sent or
  137.     received by the Kermit server.  Examples of the init string would
  138.     be 'C/bin' or 'Cuser:[username.amiga]'.
  139.  
  140. For setting options via an init string, the first character of the init
  141. string must be the letter O (for Options).  Following that letter can
  142. be one or more of the option setting formats listed bellow;  these
  143. can be separated by whitespace and/or commas.
  144.  
  145. There are three settings which are either "yes" or "no."  Your comm program
  146. will give you some way of setting them interactively.  Simple button gadgets
  147. will be labeled "yes" and "no;"  otherwise, you may see a string gadget,
  148. into which you should type the word "yes" or "no" by hand.  This string is
  149. case-insensitive.  In the init-string, "yes" is represented by the single
  150. upper-case character Y.
  151.  
  152.     Convert FileName (C{Y|N}):  If "yes," then incoming file names are
  153.     converted to a form acceptable to the Amiga.  Currently, this
  154.     means simply translating them to lower case.  Default "yes."
  155.  
  156.     Host Server (G{Y|N}):  If "yes," then the host (remote) Kermit is
  157.     assumed to be in server mode.  You will be prompted for file
  158.     names when you request an XPR Kermit receive, and this file
  159.     name will be sent to the server in the form of a Kermit GET
  160.     command.  Default "no."
  161.  
  162.     Keep Incomplete (K{Y|N}) If "yes," then incomplete files will be
  163.     kept.  An incomplete file can result from either an actual
  164.     error in the transfer, or a user-requested cancellation of
  165.     a transfer in process.  Default "no."
  166.  
  167.     Text File (T{Y|N}):  Flags whether the incoming file is text or binary.
  168.     If "yes," then carriage-return/line-feed pairs in the incoming
  169.     packet