home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / OSK / EFFO / pd1.lzh / SYS / HELP / kermit.hlp < prev    next >
Text File  |  1989-09-06  |  18KB  |  342 lines

  1. @H
  2. @T0
  3. NAME            kermit - file transfer, virtual terminal over tty link
  4.      
  5. SYNOPSIS        kermit cl[e] line [esc]                   (connect)
  6.                 kermit r[ddifl] [line]                    (receive)
  7.                 kermit s[ddifl] [line] file ...           (send)
  8.                 kermit gl[ddif] line file ...             (get)
  9.                 kermit ql[ddif] line                      (quit)
  10.                 kermit h[ddifl] [line]                    (server)
  11.      
  12. DESCRIPTION     Kermit provides reliable file transfer  and  primitive  virtual
  13.                 terminal   communication   between   machines.    It  has  been
  14.                 implemented   on   many    different    computers,    including
  15.                 microprocessors  (see  below).    The  files transferred may be
  16.                 arbitrary ASCII data (7-bit  characters)  and  may  be  of  any
  17.                 length.    The file transfer protocol uses small (96 character)
  18.                 check summed packets, with  ACK/NACK  responses  and  timeouts.
  19.                 Os9 Kermit by defaults (changeable by compilation options) uses
  20.                 a fifteen "second" timeout and ten retries.
  21.      
  22.                 The arguments to kermit are a set of flags (no  spaces  between
  23.                 the flags), three optional args (which, if included, must be in
  24.                 the same order as the flags  which  indicate  their  presence),
  25.                 and,  if  this is a Send or Get operation a list of one or more
  26.                 files.
  27.      
  28.                 Kermit has six modes, Connect, Send, Receive,  Get,  Quit,  and
  29.                 Host.    Connect is for a virtual terminal connection, Send and
  30.                 Receive may be used to transfer files  in  a  non-server  mode,
  31.                 Send,  Get,  and Quit are used with a remote kermit server, and
  32.                 Host is used to make the Os9 system a  server  itself.    These
  33.                 modes are specified by the first flag, which should be c, s, r,
  34.                 g, q, or h respectively.  Exactly one mode must be specified.
  35.      
  36.                 The file arguments are only meaningful to a Send or Get kermit.
  37.                 The  Receiving  kermit  will attempt to store the file with the
  38.                 same name that was used to  send  it.    Os9  kermits  normally
  39.                 convert  outgoing  file names to uppercase and incoming ones to
  40.                 lower case (see the f flag).  If a filename  contains  a  slash
  41.                 (/) all outgoing kermits will strip off the leading part of the
  42.                 name through the last slash.  In  the  Get  command,  filenames
  43.                 will  be  sent  to the remote host as is and the filenames sent
  44.                 back will  be  converted  as  usual  for  a  receiving  kermit.
  45.                 (Wildcard characters may be expanded on the remote end.)
  46. @D1
  47. About... : 2
  48. Distribution_Rules : 7
  49. Notes : 5
  50. Diagnostics : 6
  51. Example : 3
  52. Options : 8
  53. @T8
  54. OPTIONS         The d flag (debug) makes kermit a bit more verbose.  The states
  55.                 kermit  goes through are printed along with other traces of its
  56.                 operation.  A second, third, and even fourth d flag will  cause
  57.                 kermit to give an even more detailed trace.
  58.      
  59.                 The i flag (image) allows slightly more efficient file transfer
  60.                 between Os9 machines.  Normally (on Kermits defined to  run  on
  61.                 Os9  systems)  return  is  mapped  to  CRLF on output, LF's are
  62.                 discarded on input, and bytes are masked to 7 bits.  If this is
  63.                 set,  no mapping is done on returns, and all eight bits of each
  64.                 byte are sent or received.
  65.      
  66.                 The l flag (line) specifies the tty line that kermit should use
  67.                 to  communicate with the other machine.  This is specified as a
  68.                 regular filename, like "/t2".  If no  l  option  is  specified,
  69.                 standard  input is used and kermit assumes it is running on the
  70.                 remote host (i.e.. NOT the machine to which  your  terminal  is
  71.                 attached).
  72.      
  73.                 The  e flag (escape) allows the user to set the first character
  74.                 of the two character escape sequence for Connect  mode.    When
  75.                 the escape character is typed, kermit will hold it and wait for
  76.                 the next character.  If the next character is c  or  C,  kermit
  77.                 will  close the connection with the remote host.  If the second
  78.                 character is the same  as  the  escape  character,  the  escape
  79.                 character  itself  is passed.  An exclamation mark ('!') as the
  80.                 second character will cause shell to be forked.  (Use your  EOF
  81.                 character to return to the kermit connect mode.)  Any character
  82.                 other than these two results in a bell being sent to the user's
  83.                 terminal  and  no  characters  passed  to the remote host.  All
  84.                 other typed characters  are  passed  through  unchanged.    The
  85.                 default  escape  character  is  tilde ('~').  (Control-3 on the
  86.                 standard Coco keyboard.)
  87. @T2
  88. Authors:    Bill Catchings, Bob Cattani, Chris Maio, Columbia University
  89.             Modified  from UNIX Kermit to Os9 Kermit By Glean Seaton and Robert
  90.             A. Larson
  91.             with fixes and contributions from many others.
  92. Documentation:
  93.             Walter Underwood, Ford Aerospace (Palo Alto, CA)
  94.             Changed for Os9 Kermit by Robert A. Larson
  95.             Slightly reordered form a help file by Lukas Zeller (89-09-06)
  96. Version:    1.5
  97. Date:       July 1985
  98.      
  99. A  sample,  working  implementation of the Kermit "kernel" was written in the C
  100. language, and widely distributed in the Kermit Protocol Manual.    This  kernel
  101. was  intended  merely  to  illustrate the protocol, and did not include a "user
  102. interface", nor some of the fancy features like server support, 8-bit  quoting,
  103. file  warning, timeouts, etc.  Several sites have added the necessary trappings
  104. to make this a production version of Kermit, usually under the  UNIX  operating
  105. system.  Limited server functions have also been added to the Os9 version.
  106.      
  107. The  keyword style of user/program interaction favored by Kermit (program types
  108. prompt, user types command followed by operands, program types another  prompt,
  109. etc)  is  contrary to the UNIX style, so UNIX implementations have a style more
  110. familiar to UNIX users.  The Os9 version has retained  this  style  of  command
  111. interface.    C  versions  of Kermit are running successfully on VAX and PDP-11
  112. UNIX systems, IBM 370-compatible mainframes  under  Amdahl  UTS,  and  the  SUN
  113. Microsystems MC68000-based and other workstations.
  114.      
  115. There  is  a  new version of Kermit written in C called C-Kermit.  (The current
  116. version as of July 1985 is 4c.)  It is recommended for  Unix  and  adapting  to
  117. other  operating  systems  if  memory  is  adiquate.    (It is being adapted to
  118. Os9/68000, but is probably to large for Os9/6809.)
  119.      
  120. Os9 filespecs are of the form
  121.      
  122.     dir1/dir2/dir3/ ... /filename
  123.      
  124. where the tokens delimited by slashes form a path name, and are each limited to
  125. 29  characters  in  length.  The final token in a path is the actual file name.
  126. By convention, it is of the form name.type, but there is nothing special  about
  127. the dot separating name and type; to Os9 it's just another character, and there
  128. may be many dots in a filename.
  129. @T3
  130. EXAMPLE         For  this  example  we  will  assume  two Os9 machines.  We are
  131.                 logged onto "Os9a" (the local machine), and want to communicate
  132.                 with "Os9b" (the remote machine).  There is a modem on "/t2".
  133.      
  134.                 We  want  to  connect  to "Os9b", then transfer "file1" to that
  135.                 machine.
  136.      
  137.                 We type:
  138.      
  139.                     kermit cl /t2
  140.      
  141.                 Kermit answers:
  142.      
  143.                     Kermit: connected...
  144.      
  145.                 Now we dial the remote machine and connect the modem.  Anything
  146.                 typed  on  the  terminal will be sent to the remote machine and
  147.                 any output from that machine will be displayed on our terminal.
  148.                 We hit RETURN, get a "login:" prompt and login.
  149.      
  150.                 Now  we need to start a kermit on the remote machine so that we
  151.                 can send the file over.  First we start up the remote, (in this
  152.                 case   receiving)   kermit,  then  the  local,  (sending)  one.
  153.                 Remember that we are talking to Os9b right now.
  154.  
  155.                 We type:
  156.      
  157.                     kermit r
  158.      
  159.                 (there is now a Receive kermit on Os9b)
  160.      
  161.                 We type ~ (the escape character) and then the letter c to  kill
  162.                 the local (Connecting) kermit:  ~c
  163.      
  164.                 Kermit answers:
  165.      
  166.                     Kermit: disconnected.
  167.      
  168.                 We type:
  169.      
  170.                     kermit sl /t2 file1
  171.      
  172.                 Kermit answers:
  173.      
  174.                     Sending file1 as FILE1
  175.      
  176.                 When  the  transmission  is  finished,  kermit will type either
  177.                 "Send complete", or "Send failed.", depending on the success of
  178.                 the  transfer.    If we now wanted to transfer a file from os9b
  179.                 (remote) to os9a (local), we would use these commands:
  180.      
  181.                     kermit cl /t2
  182.                       (connected to Os9b)
  183.                     kermit s file9
  184.                       ~c (talking to Os9a again)
  185.                     kermit rl /t2
  186.      
  187.                 After all the transfers were done, we should connect again, log
  188.                 off of Os9b, kill the Connect kermit and hang up the phone.
  189. @T5
  190. NOTES           Kermit can interact strangely with the tty driver.
  191.      
  192.                 The  KERMIT  Protocol  uses  only  printing  ASCII  characters,
  193.                 Ctrl-A, and CRLF.   Ctrl-S/Ctrl-Q  flow  control  can  be  used
  194.                 "underneath"   the   Kermit  protocol,  but  is  not  currently
  195.                 implemented in Os9 Kermit.
  196.      
  197.                 Since BREAK is not an ASCII character,  kermit  cannot  send  a
  198.                 BREAK  to the remote machine.  On some systems, a BREAK will be
  199.                 read as a NUL.
  200.      
  201.                 This kermit does have timeouts  when  run  under  Os9,  so  the
  202.                 protocol is stable when communicating with "dumb" kermits (that
  203.                 don't have timeouts).
  204.  
  205.                 The  Quit  command  will  send a "Generic Finish" packet to the
  206.                 remote kermit server.
  207.      
  208.                 The Host command has not been fully implemented and  tested  as
  209.                 of this writing.
  210. @T6
  211. DIAGNOSTICS     cannot open device
  212.                 The file named in the line argument did not exist  or  had  the
  213.                 wrong permissions.
  214.      
  215.                 Could not create file
  216.                 A Receive kermit could not create the file being sent to it.
  217.      
  218.                 nothing to connect to
  219.                 A Connect kermit was started without a line argument.
  220. @T7
  221.               POLICY ON COMMERCIAL USE AND DISTRIBUTION OF KERMIT
  222.      
  223.                                  Frank da Cruz
  224.      
  225.               Columbia University Center for Computing Activities
  226.      
  227.                                 September, 1985
  228.      
  229.      
  230. The KERMIT file transfer protocol has always been open, available, and free to
  231. all.  The protocol was developed at the Columbia University Center for
  232. Computing Activities, as were the first several KERMIT programs.  Columbia has
  233. shared these programs freely with the worldwide computing community since 1981,
  234. and as a result many individuals and institutions have contributed their own
  235. improvements or new implementations in the same spirit.  In this manner, the
  236. number of different systems supporting KERMIT implementations has grown from
  237. three to over 100 in less than four years.  If Columbia had elected to keep
  238. the protocol secret, to restrict access to source code, or to license the
  239. software, the protocol would never have spread to cover so many systems, nor
  240. would the programs be in use at so many sites, nor would the quality of many of
  241. the implemementations be so high.
  242.      
  243. Although KERMIT is free and available to anyone who requests it, it is not in
  244. the "public domain".  The protocol, the manuals, the Columbia implementations,
  245. and many of the contributed implementations bear copyright notices dated 1981
  246. or later, and include a legend like
  247.      
  248.   Copyright (C) 1985, Trustees of Columbia University in the City of New York.
  249.   Permission is granted to any individual or institution to use, copy, or
  250.   redistribute this software so long as it is not sold for profit, provided
  251.   this copyright notice is retained.
  252.      
  253. The copyright notice is to protect KERMIT, Columbia University, and the
  254. various contributors from having their work usurped by others and sold as a
  255. product.  In addition, the covering letter which we include with a KERMIT tape
  256. states that KERMIT can be passed along to others; "we ask only that profit not
  257. be your goal, credit be given where it is due, and that new material be sent
  258. back to us so that we can maintain a definitive and comprehensive set of KERMIT
  259. implementations".
  260.      
  261. Within this framework, it is acceptable to charge a reproduction fee when
  262. supplying KERMIT to others.  The reproduction fee may be designed to recover
  263. costs of media, packaging, printing, shipping, order processing, or any
  264. computer use required for reproduction.  The fee should not reflect any program
  265. or documentation development effort, and it should be independent of how
  266. many implementations of KERMIT appear on the medium or where they came from.
  267. It should not be viewed as a license fee.  For instance, when Columbia ships a
  268. KERMIT tape, there is a $100.00 reproduction fee which includes a 2400' reel of
  269. magnetic tape, two printed manuals, various flyers, a box, and postage; there
  270. is an additional $100.00 order processing charge if an invoice must be sent.
  271. The tape includes all known versions of KERMIT, including sources and
  272. documentation.
  273.      
  274. Commercial institutions may make unlimited internal use of KERMIT, and
  275. KERMIT may be installed on timesharing systems where customers are charged for
  276. system use, so long as they are not charged more for using KERMIT than for
  277. using any other program.
  278.      
  279. A question raised with increasing frequency is whether a company may
  280. incorporate KERMIT into its products.  A hardware vendor may wish to include
  281. KERMIT with its standard software.  A software house may wish to incorporate
  282. KERMIT protocol into its communications package, or to distribute it along
  283. with some other product.  A timesharing vendor or dialup database may wish to
  284. provide KERMIT for downloading.  All these uses of KERMIT are permissible,
  285. with the following provisos:
  286.      
  287.  A KERMIT program may not be sold as a product in and of itself.  In addition
  288.   to violating the prevailing spirit of sharing and cooperation, commercial
  289.   sale of a product called "KERMIT" could violate the trade mark which is held
  290.   on that name by Henson Associates, Inc., creators of THE MUPPET SHOW.
  291.      
  292.  Existing KERMIT programs and documentation may be included with hardware or
  293.   other software as part of a standard package, provided the price of the
  294.   hardware or software product is not raised significantly beyond costs of
  295.   reproduction of the KERMIT component.
  296.      
  297.  KERMIT protocol may be included in a multi-protocol communication package as
  298.   one of the communication options, or as a communication feature of some
  299.   other kind of software package, in order to enhance the attractiveness of the
  300.   package.  KERMIT protocol file transfer and management should not be the
  301.   primary purpose of the package.  The price of the package should not be
  302.   raised significantly because KERMIT was included, and the vendor's literature
  303.   should make a statement to this effect.
  304.      
  305.  Credit for development of the KERMIT protocol should be given to the Columbia
  306.   University Center for Computing Activities, and customers should be advised
  307.   that KERMIT is available for many systems for only a nominal fee from
  308.   Columbia and from various user group organizations, such as DECUS and SHARE.
  309.      
  310. Columbia University may grant permission to any person or institution to
  311. develop a KERMIT program for any particular system.  A commercial institution
  312. that intends to distribute KERMIT under the conditions listed above should be
  313. aware that other implementations of KERMIT for the same system may appear in
  314. the standard KERMIT distribution at any time.  Columbia University encourages
  315. all developers of KERMIT software and documentation to contribute their work
  316. back to Columbia for further distribution.
  317.      
  318. Finally, Columbia University does not warrant in any way the KERMIT software
  319. nor the accuracy of any related documentation, and neither the authors of any
  320. KERMIT programs or documentation nor Columbia University nor any other
  321. contributing institutions acknowledge any liability resulting from program or
  322. documentation errors.
  323.      
  324. These are general guidelines; this is not a legal document to be searched for
  325. loopholes.  To date, KERMIT has been freely shared by all who have taken the
  326. time to do work on it, and no formal legalities have proven necessary.  The
  327. guidelines are designed to allow commercial enterprises to participate in the
  328. promulgation of KERMIT without seriously violating the KERMIT user community's
  329. trust that KERMIT will continue to spread and improve at no significant cost to
  330. themeselves.  The guidelines are subject to change at any time, should more
  331. formal detail prove necessary.
  332.      
  333. Commercial organizations wishing to provide KERMIT to their customers should
  334. write a letter stating their plans and their agreement to comply with the
  335. guidelines listed above.  The letter should be addressed to:
  336.      
  337.     KERMIT Distribution
  338.     Columbia University Center for Computing Activities
  339.     612 West 115th Street
  340.     New York, NY  10025
  341.  
  342.