home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / cdccyber / cd3kerhlp.txt < prev    next >
Text File  |  2020-01-01  |  15KB  |  330 lines

  1. -?
  2. The following HELP topics are available:  
  3.   
  4.  ?         !         DIRECTORY EXIT      HELP      KERMIT    PUSH
  5.  QUIT      RECEIVE   SEND      SERVER    SET       SHOW      STATUS
  6.  TAKE      WILDCARDS
  7.   
  8. -KERMIT
  9. KERMIT
  10.   
  11. Kermit is a file transfer protocol for use over an asynchronous serial
  12. telecommunication line.  Files are broken up into "packets" with checksums and
  13. other control information to ensure (with high probability) error-free and
  14. complete transmission.  Kermit-170 is the implementation for the Control Data
  15. Cyber and is run "remotely" from another computer (e.g.  a microcomputer). 
  16.   
  17. You can run Kermit interactively by typing repeated commands in response to its
  18. "Kermit-170>" prompt, or you can run it as a remote server.
  19.   
  20. Kermit-170 command summary -- optional parts are in [brackets]: 
  21.   
  22.  * For exchanging files:         SEND file
  23.                                  RECEIVE
  24.   
  25.  * For acting as a server:       SERVER
  26.   
  27.  * Setting nonstandard transmission and file parameters: 
  28.          SET DEBUG, DELAY, DUPLEX, INIT-RETRY, RETRY, TEXT-MODE
  29.          SET BIN-MODE, EOR-EOF-MODE
  30.          SET SEND (or RECEIVE) End-of-Line, Packet-length, Pad-Character,
  31.                    Pad-Length, Quote-Character, Sync-Character, Time-Out
  32.   
  33.  * Getting information:          DIR [filenam], HELP [topic], STATUS, SHOW
  34.   
  35.  * Leaving the program:          EXIT, QUIT
  36.   
  37. For further information, type HELP for any of the above, e.g.  HELP SET, or 
  38. see the "Kermit Users Guide" and the "Kermit Protocol Manual" for complete
  39. details.
  40.   
  41. -WILDCARDS
  42. Cyber Kermit allows a group  of  files  to  be  specified  in  a  single  file
  43. specification  by including the special "wildcard" characters, "*" and "?".  A
  44. "*" matches any string of characters, including no characters at  all;  a  "?"
  45. matches  any  single  character.    Any number of "*" and "?"  may appear in a
  46. wildcard specification.  To complement the selection criteria, suffix a "-" to 
  47. the wildcard specification.
  48.   
  49. Here are some examples:
  50.   
  51.   *BUG    All files ending in BUG. 
  52.   
  53.   *DOG*   All file names containing DOG.
  54.   
  55.   F*      All files whose names start with F.
  56.   
  57.   F?X*    All  files whose names start with F and contain X in the third posi-
  58.           tion, followed by zero or more characters.
  59.   
  60.   FRED-   All files except FRED.
  61.   
  62. Wildcard notation is most commonly used to instruct Kermit to send, or display
  63. a  directory  of,  a  group of files.  Its usage is similar to capabilities on
  64. many other computer systems.
  65.   
  66. -!
  67. ! command  Execute a NOS command and then return  to  Kermit.    Note  that  a
  68.           single  space  must follow the ! character.  Cyber Kermit supplies a 
  69.           control statement terminator if needed.
  70.   
  71. -DIRECTORY
  72. DIRECTORY [filename]
  73.           Displays  the  names  of  the  files local to the user's job, or the
  74.           names of files in the user's permanent file catalog; filename may be
  75.           a wildcard filename.
  76.   
  77.           If  the command is specified with no parameters or the L: parameter,
  78.           all local files are listed.  If the P:  parameter is used, all  per-
  79.           manent files are listed.
  80.   
  81.           To  list  a single local file or subset of local files, the user may 
  82.           specify a file name or wildcard file name.  To list a single or sub- 
  83.           set  of  permanent  files,  the  user  may  precede the file name or
  84.           wildcard file name by P: 
  85.   
  86.           [The above syntax is also applicable to the REMOTE DIRECTORY  server
  87.           command.]
  88.   
  89. -EXIT
  90. EXIT
  91.           Exit from Kermit-170.  You may also stop Kermit-170 in the midst  of
  92.           a transfer or during server operations by aborting your local Kermit
  93.           with a CTRL-C.  Connect to the Cyber Kermit (don't forget  to  first
  94.           FINISH  if  you were using the Cyber Kermit in server mode) and then
  95.           EXIT.
  96.   
  97. -QUIT
  98. QUIT
  99.           Exit from Kermit-170.  You may also stop Kermit-170 in the midst  of
  100.           a transfer or during server operations by aborting your local Kermit
  101.           with a CTRL-C.  Connect to the Cyber Kermit (don't forget  to  first
  102.           FINISH  if  you were using the Cyber Kermit in server mode) and then
  103.           EXIT.
  104.   
  105. -HELP
  106. HELP [topic]
  107.           Give  Help.    A general help text, and separate help texts for each
  108.           Kermit-170 command, are available.    HELP  ?  lists  the  available 
  109.           topics.
  110.   
  111. -PUSH
  112. PUSH      Exit  to  NOS  command level, saving the current Kermit environment.
  113.           The environment is restored when Kermit is reentered later.
  114.   
  115. -RECEIVE
  116. RECEIVE   Receive a file or group of files from the other host.  If  the  name
  117.           in  the  header  packet  is not a legal Cyber file name, the first 7
  118.           legal characters are used.
  119.   
  120.           If the file already exits as a local file, Kermit aborts the  trans- 
  121.           fer.    If  an  error  occurs  during transfer, the local file being
  122.           received is deleted to allow the transfer  to  be  retried.    After
  123.           entering  the  RECEIVE command, you should escape back to your local
  124.           Kermit and enter the SEND command.
  125.   
  126. -SEND
  127. SEND filename or L:filename or P:filename
  128.           Send  one or more files to the local (micro) Kermit; filename may be
  129.           a wildcard filename.  The name of each file is passed to  the  other 
  130.           Kermit in a file header packet, so that the file can be stored there
  131.           with the same name.  You should escape back to your local Kermit and
  132.           enter  the  RECEIVE  command.   If you don't do this fast enough the
  133.           "send-init" packet may arrive prematurely.  To prevent this, use SET
  134.           DELAY  or  hit  the  RETURN key on your microcomputer if it does not 
  135.           timeout.
  136.   
  137.           If you use the first form of this command and no local file(s) match
  138.           your  request,  your permanent file catalog is searched for matching
  139.           file(s).  If you prefix the filename with L:, only your local  files
  140.           are  searched;  if P:, only your permanent file catalog is searched.
  141.           (Note that for a permanent file transfer, any local file  which  has
  142.           the same name as a permanent file being sent, is deleted.)
  143.   
  144. -SERVER
  145. SERVER    Act  as  a  server  for  another  Kermit.    Whatever  options  were
  146.           previously SET are used.  The server may be shut down from the local
  147.           Kermit  by  using  the  BYE, LOGOUT or FINISH commands.  FINISH ter-
  148.           minates the Cyber Kermit program, but does not log out.  Most often,
  149.           you  should use the FINISH command if you are transferring a file to
  150.           the Cyber so that you may then connect and make the file  permanent.
  151.           The  BYE  or  LOGOUT  command  causes  Cyber Kermit to terminate and
  152.           logout; it may be used, for example, when a file is to  be  received
  153.           from the Cyber and no other work is to be done on the Cyber.
  154.   
  155.           The following server features are currently supported in Kermit-170:
  156.           GET, SEND, FINISH, BYE, REM DIR
  157.   
  158. -SET
  159. SET keyword value 
  160.           Establish system-dependent parameters.  You can examine their values
  161.           with the SHOW  command.    Numeric  values  may  be  decimal,  octal
  162.           (postfixed  with a B), or hexadecimal (postfixed by an H).  The fol-
  163.           lowing may be SET:  
  164.   
  165.           BIN-MODE btype 
  166.               Indicates  how  binary  files  are stored.  Allowable values for
  167.               btype are: 8/12 and PACKED.  The setting  of  BIN-MODE  is  used
  168.               when FILE-MODE is BINARY.
  169.   
  170.           TEXT-MODE ctype
  171.               Sets  the  character  set  of  TEXT files.  Allowable values for
  172.               ctype are: AUTO, DISPLAY,  6/12,  and  8/12.    The  setting  of 
  173.               TEXT-MODE is used when FILE-MODE is TEXT. 
  174.   
  175.           DEBUG option
  176.               Show packet traffic explicitly.  Options are: 
  177.   
  178.               ALL Set all debug options (PACKETS and STATES).
  179.   
  180.               LOG-FILE filename 
  181.                   Log  states  and packets to the specified file.  The default
  182.                   log-file is named KERMLOG.
  183.   
  184.               OFF Don't log debugging information (this is the default).    If
  185.                   debugging was in effect, turn it off and close the log file.
  186.   
  187.               PACKETS
  188.                   Log each incoming and outgoing packet (lengthy).
  189.   
  190.               STATES
  191.                   Log Kermit state transitions and packet numbers (brief).
  192.   
  193.           DELAY decimal-number
  194.               Sets the number of seconds to  wait  before  sending  the  first
  195.               packet.    This  gives  you  time  to  "escape" back and issue a
  196.               RECEIVE command.  The default is 2 seconds.
  197.   
  198.           DUPLEX keyword
  199.               Changes the method of echoing characters when being prompted for
  200.               commands.  The choices are FULL and HALF.  FULL means the  Cyber
  201.               will  echo the characters you type.  HALF means the local system
  202.               echoes them.  FULL is the default, and is used by most hosts.
  203.   
  204.           EOR-EOF-MODE option
  205.               Indicates  how  end-of-record/end-of-file  marks  in  Cyber text
  206.               files are to be handled.  If option is ON, they are converted to
  207.               #EOR/#EOF  lines  in  the  destination  file when a text file is
  208.               received from the Cyber, and #EOR/#EOF lines in  a  source  file
  209.               are converted to end-of-record/end-of-file marks in the destina- 
  210.               tion file when  sending  to  the  Cyber.    If  option  is  OFF,
  211.               end-of-record/end-of-file marks are ignored, and #EOR/#EOF lines
  212.               are treated as ordinary text lines.  EOR-EOF-MODE ON is only ef-
  213.               fective  when  FILE-MODE  is  TEXT; otherwise action is as if it
  214.               were OFF.
  215.   
  216.           FILE-MODE ftype
  217.               Declares  the  file  mode to be used while processing Cyber disk
  218.               files.  Allowable values for ftype are TEXT and  BINARY.    TEXT
  219.               means that the file contains text in either 8/12 ASCII, 6/12 AS-
  220.               CII, or Display Code (See the SET TEXT-MODE  command).    BINARY
  221.               means  that  the  file  contains  binary  data in either 8/12 or
  222.               PACKED form (see the SET BIN-MODE  command).    The  default  is
  223.               TEXT. 
  224.   
  225.           INIT-RETRY decimal-number
  226.               Set the maximum number of retries allowed for the  initial  con-
  227.               nection before giving up. Default is 15.
  228.   
  229.           RECEIVE parameter value
  230.               These commands allow you to specify to the other Kermit what the 
  231.               packets it sends should look like, or to inform this Kermit what 
  232.               to expect.  Value may be specified as a decimal number, an octal
  233.               number  (B suffix), or a hexadecimal number (H suffix).  Charac-
  234.               ter values are specified as the numeric equivalent of the  ASCII
  235.               character.
  236.   
  237.               END-OF-LINE value
  238.                   The octal value of the ASCII character which will be used as
  239.                   a line terminator for packets by the other system.  Carriage
  240.                   return (15B) is the default.
  241.   
  242.               PACKET-LENGTH value
  243.                   Maximum  packet  length the other system may send, a decimal
  244.                   number, between 20 and 1000, 94 by default.   Size  used  is
  245.                   the  minimum of this parameter and the SEND PACKET-LENGTH of
  246.                   the other Kermit.
  247.   
  248.               PAD-CHARACTER value
  249.                   Character to use for padding.  Default is NUL.
  250.   
  251.               PAD-LENGTH value
  252.                   Set the number  of  padding  characters  to  send  before  a
  253.                   packet.  Default is no padding.
  254.   
  255.               QUOTE-CHARACTER value
  256.                   The printable  character  to  use  for  quoting  of  control
  257.                   characters.  Default  is # (43B).  There should be no reason
  258.                   to change this.
  259.   
  260.               SYNC-CHARACTER value 
  261.                   The  control  character  that  marks  the  beginning  of the
  262.                   packet.  Normally SOH (Control-A, ASCII 1).  There should be 
  263.                   no reason to change this.
  264.   
  265.               TIME-OUT value
  266.                   The number of seconds the other Kermit  should  wait  for  a
  267.                   packet  before  asking  for  retransmission.  Default  is 10
  268.                   seconds.
  269.   
  270.           RETRY decimal-number
  271.               Sets  the  maximum  number  of  retries allowed for a particular
  272.               packet before giving up. Default is 10.
  273.   
  274.           SEND parameter value
  275.               These  commands allow you to specify how outgoing packets should
  276.               look, in case the other Kermit has non-standard requirements.
  277.   
  278.               END-OF-LINE value
  279.                   The  octal value of the ASCII character to be used as a line 
  280.                   terminator for packets, if one is required by the other sys-
  281.                   tem.  Carriage return (15B) by default.
  282.   
  283.               PACKET-LENGTH value
  284.                   Maximum packet length to send, decimal  number,  between  20
  285.                   and  1000,  94 by default.  Size used is the minimum of this
  286.                   parameter and the RECEIVE PACKET-LENGTH of the other Kermit.
  287.   
  288.               PAD-CHARACTER value
  289.                   Character to use for padding.  Default is NUL.
  290.   
  291.               PAD-LENGTH value
  292.                   Set the number  of  padding  characters  to  send  before  a
  293.                   packet.  Default is no padding.
  294.   
  295.               QUOTE-CHARACTER value
  296.                   The printable  character  to  use  for  quoting  of  control
  297.                   characters.    The  default  is # (43B).  There should be no
  298.                   reason to change this.
  299.   
  300.               SYNC-CHARACTER value 
  301.                   The  control  character  that  marks  the  beginning  of the
  302.                   packet.  Normally SOH (Control-A, ASCII 1).  There should be 
  303.                   no reason to change this.
  304.   
  305.               TIME-OUT value
  306.                   How many seconds to wait for a packet before  trying  again.
  307.                   Default is 10 seconds.
  308.   
  309. -SHOW
  310. SHOW
  311.     Display current SET parameters, version of Kermit-170, and other
  312.     information.
  313.   
  314. -STATUS
  315. STATUS
  316.     Give statistics about the most recent file transfer. 
  317.   
  318. -TAKE
  319. TAKE filename or L:filename or P:filename
  320.     Take  Kermit  commands  from  a file.  Kermit looks first in the
  321.     user's local files; if not found it then looks in the  permanent
  322.     file  catalog.    You  may  restrict the search by prefixing the
  323.     filename with "P:" or "L:".  (See the SEND command above.)  When
  324.     an logical end-of-record is encountered on the TAKE file, Kermit
  325.     reverts to accepting commands from the terminal.  TAKE  commands
  326.     cannot  be nested; a TAKE command read from a file causes Kermit
  327.     to begin reading commands from the new file, but when the end of 
  328.     the  new  file  is  reached  Kermit does not revert to the first
  329.     file.
  330.