home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / burroughs / b79kerhlp.txt < prev   
Text File  |  2020-01-01  |  15KB  |  340 lines
  1.     The available Kermit-Bur commands are:
  2.  
  3.       SET - SHOW(STAtus)- RECEIVE - SEND - SERVER - EXIT.
  4.  
  5.     Some commands may be abbreviated.  All  necessary  characters  of  a
  6.     command are printed in capitals.
  7.  
  8.     For more information type HELP <Kermit-Bur command>.
  9.  
  10.     The SET-command.
  11.     --- ------------
  12.  
  13.     The SET-command is necessary to set the FILEKIND of the file  to  be
  14.     received  from  the  PC and because some Kermits need other settings
  15.     than the default values of Kermit-Bur.
  16.  
  17.     The default setting is:
  18.  
  19.         FILE TYPE DATA RECORDLENGTH 80 CHARACTERS
  20.  
  21.         RECEIVE DIRECTORY: not specified
  22.  
  23.         SEND DIRECTORY: not specified
  24.  
  25.         DELAY: 5 seconds
  26.  
  27.         DEBUG: OFF
  28.  
  29.         EXTENSION: OFF
  30.  
  31.         SEND EOL: CR (carriage return)
  32.  
  33.         SEND PAKLEN: 94
  34.  
  35.         SEND QUOTE: #
  36.  
  37.         SEND SOP: SOH (Start Of Header)
  38.  
  39.         SEND TIMEOUT: 15
  40.  
  41.         No SEND PADDING
  42.  
  43.     Syntax :
  44.  
  45.     --SET--+--FILE--TYPE--+--BINary--+--RECordlength---< integer >-+---
  46.            |              |          |                             |
  47.            |              +---DATa---+-----------------------------+
  48.            |              |                                        |
  49.            |              +--<filekind>----------------------------+
  50.            |                                                       |
  51.            +--RECeive--DIRectory---+-----------------+-------------+
  52.            |                       |                 |             |
  53.            |                       +--< directory >--+             |
  54.            |                                                       |
  55.            +--DELAY----------< integer >---------------------------+
  56.            |                                                       |
  57.            +--DEBUG--------+--ON--+--------------------------------+
  58.            |               |      |                                |
  59.            |               +--OFF-+                                |
  60.            |                                                       |
  61.            +--EXTension----+--ON--+--------------------------------+
  62.            |               |      |                                |
  63.            |               +--OFF-+                                |
  64.            |                                                       |
  65.            +--SEND--+----DIRectory--+-----------------+------------+
  66.                     |               |                 |            |
  67.                     |               +--< directory >--+            |
  68.                     |                                              |
  69.                     +----EOL---------< integer >-------------------+
  70.                     |                                              |
  71.                     +----PAKLEN------< integer >-------------------+
  72.                     |                                              |
  73.                     +----QUOTE-------<character>-------------------+
  74.                     |                                              |
  75.                     +----SOP---------< integer >-------------------+
  76.                     |                                              |
  77.                     +----TIMEOUT-----< integer >-------------------+
  78.                     |                                              |
  79.                     +--PADDING--<integer>--PADCHAR--<integer>------+
  80.  
  81.     SET FILE TYPE BINary    : Kermit-Bur will do binary transport if the
  82.                               local  Kermit  agrees. When sending a file
  83.                               to the PC, the FILEKIND of that file  must
  84.                               be  DATA.  When  receiving a file from the
  85.                               PC, the FILEKIND  of  that  file  will  be
  86.                               DATA. If no recordlength is specified, the
  87.                               MAXRECSIZE of the file to be received from
  88.                               the  PC  will  be 128 bytes, otherwise the
  89.                               specified length in bytes. There  will  be
  90.                               no  translation from ASCII-code to EBCDIC-
  91.                               code.
  92.                               When receiving code-files from the PC, one
  93.                               is  advised to choose a wise recordlength.
  94.                               The last record is filled  up  with  NUL's
  95.                               (48"00"); so to avoid trailing NUL's, your
  96.                               code file should  be  a  multiple  of  the
  97.                               choosen recordlength.
  98.  
  99.     SET FILE TYPE DATa      : When receiving a file  from  the  PC,  the
  100.                               FILEKIND  of that file will be DATA. If no
  101.                               recordlength is specified, the  MAXRECSIZE
  102.                               of  the  file  to  be received from the PC
  103.                               will  be  80  characters,  otherwise   the
  104.                               specified  length  in characters. When the
  105.                               SET-command  isn't  used  ,  this  is  the
  106.                               default situation.
  107.  
  108.     SET FILE TYPE <filekind>: When receiving a file  from  the  PC,  the
  109.                               FILEKIND   of   that   file  will  be  the
  110.                               specified  filekind.  The  file-attributes
  111.                               are    set   according   to   the   CANDE-
  112.                               requirements.
  113.                               <filekind> ::= ALGol  |  PL/i  |  COBol  |
  114.                               FORtran  |  BASic  |  JOB | PAScal | SEQ |
  115.                               CSEq | CDAta
  116.  
  117.     SET RECeive DIRectory   : When a directory is specified, the  files,
  118.                               received by Kermit-Bur, are stored in that
  119.                               directory. When no directory is mentioned,
  120.                               Kermit-Bur   stores   received   files  as
  121.                               explained in the RECEIVE-command. This  is
  122.                               the default situation.
  123.  
  124.                               e.g.  SET REC DIR KERMIT
  125.                               The file with filename TEST,  received  by
  126.                               Kermit-Bur is stored with TITLE
  127.                               KERMIT/TEST.
  128.  
  129.     SET DELAY <xx>   : <xx> is an integer value in the range  0  through
  130.                        30.  It  represents  the  time  (in seconds) that
  131.                        Kermit-Bur will wait  before  sending  the  first
  132.                        packet. The defaultvalue is 5.
  133.  
  134.     SET DEBUG ON     : a printerfile is created for  logging/statistics.
  135.                        The defaultvalue is OFF (no printerfile).
  136.  
  137.     SET EXTension ON : When receiving a  file  on  your  PC,  Kermit-Bur
  138.                        creates  a  filename  that  consists  of the last
  139.                        identifier of the TITLE  of  the  Burroughs-file,
  140.                        followed by a period, followed by the first three
  141.                        letters of the FILEKIND of the Burroughs-file.
  142.  
  143.                        e.g. When your  PC  receives  the  Burroughs-file
  144.                        with  TITLE KERMIT/RECORDS/NEW and FILEKIND DATA,
  145.                        the filename will be NEW.DAT.
  146.  
  147.                        When EXTENSION is OFF (default), the filename  of
  148.                        the file to be received on your PC will be:
  149.  
  150.                             if the TITLE of the Burroughs-file  consists
  151.                             of only one identifier, that identifier.
  152.  
  153.                             if the TITLE of the Burroughs-file  consists
  154.                             of   two  ore  more  identifiers,  the  last
  155.                             identifier but one  of  the  Burroughs-file,
  156.                             followed  by a period, followed by the first
  157.                             three letters/digits of the last  identifier
  158.                             of the Burroughs-file.
  159.  
  160.                        e.g. When your  PC  receives  the  Burroughs-file
  161.                        with  TITLE  KERMIT/RECORDS, the filename will be
  162.                        KERMIT.REC.
  163.  
  164.                        Naturally the actual filename on your PC  depends
  165.                        upon   the  filename-conventions  on  your  local
  166.                        machine.
  167.  
  168.     SET SEND <parm>  : <parm> are the following  parameters,  which  are
  169.                        described below.
  170.  
  171.            DIRectory   : When a directory is specified,  files  send  by
  172.                          Kermit-Bur are retrieved in that directory.
  173.  
  174.                          e.g. SET SEND DIR KERMIT
  175.                               SEND TEST
  176.                          Kermit-Bur  looks  for  a   file   with   TITLE
  177.                          KERMIT/TEST.
  178.  
  179.                          When  no  directory  is  specified,  Kermit-Bur
  180.                          looks  for  the actual TITLE given in the SEND-
  181.                          command. This is the default situation.
  182.  
  183.            EOL <xx>    : <xx> is an integer value (decimal value of  the
  184.                          ASCII-code).  It  represents  the  end  of line
  185.                          character to be used as a line  terminator  for
  186.                          packets,  if  one  is  required  by  the  local
  187.                          Kermit, carriage return (CR) by  default.  Only
  188.                          LF (10) or CR (13) is accepted.
  189.  
  190.                          e.g.  SET SEND EOL 13
  191.  
  192.            PAKLEN <xx> : <xx> is  an  integer  value  in  the  range  10
  193.                          through   94.   It   represents   the   maximum
  194.                          packetlength to send. The defaultvalue is 94.
  195.  
  196.                          e.g.  SET SEND PAKLEN  90
  197.  
  198.            QUOTE <xx>  : <xx> is a printable character (decimal value in
  199.                          the ASCII-range: 33 through 61, except 38 (&)).
  200.                          It represents the quoting-character  the  local
  201.                          Kermit   requires   for  control-characters.  A
  202.                          control-character is considered to be any  byte
  203.                          whose  value  is  in the range 0 through 31, or
  204.                          equal to 127  (decimal  value  off  the  ASCII-
  205.                          code).  When  a  control-character appears in a
  206.                          file to send, it  is  changed  in  a  printable
  207.                          representation  (increased  by  64 mod 128) and
  208.                          preceeded   by   the    QUOTE-character.    The
  209.                          defaultvalue  is  an  #  and there should be no
  210.                          reason to change this.
  211.  
  212.                          e.g.  SET SEND QUOTE #
  213.  
  214.            SOP <xx>    : <xx> is an integer value (decimal value off the
  215.                          ASCII- code). It represents the Start-Of-Packet
  216.                          character  the  local  Kermit   requires.   The
  217.                          defaultvalue  is  SOH (Start-Of-Header, decimal
  218.                          value 1). If this  character  causes  problems,
  219.                          you  can use this command to select a different
  220.                          control-character  to  mark  the  start  of   a
  221.                          packet.  You  must  also  issue  the reciprocal
  222.                          command (SET RECEIVE SOP) to the Kermit on  the
  223.                          other system (providing it has such a command).
  224.  
  225.                          e.g.  SET SEND SOP  1
  226.  
  227.            TIMEOUT <xx>: <xx> is a positive integer value (maximum  90).
  228.                          It tells how many seconds the local Kermit will
  229.                          wait for a  packet  before  trying  again.  The
  230.                          default value is 15.
  231.  
  232.                          e.g.  SET SEND TIMEOUT  10
  233.  
  234.            PADDING <xx> PADCHAR <yy> : Two integer values. <xx> repre-
  235.                          sents the number of padding-characters (maximum
  236.                          20)  and  <yy> represents the padding-character
  237.                          (decimal value off the ASCII-code).  <yy>  must
  238.                          be  a  control-character.  They  should be send
  239.                          before sending each packet to the other Kermit.
  240.                          The  default  values are 0 (no padding) and NUL
  241.                          (0) for the padding-character.
  242.  
  243.                          e.g.  SET SEND PADDING 0  PADCHAR 0
  244.  
  245.     Caution:
  246.  
  247.       The values of EOL, QUOTE, SOP and PADCHAR must be distinct.
  248.  
  249.     The SHOW-command.
  250.     --- -------------
  251.  
  252.     Syntax:
  253.  
  254.     SHOW
  255.     STAtus
  256.  
  257.     The SHOW-command will display the values of the  settings  mentioned
  258.     in the SET-command.
  259.  
  260.     The RECEIVE-command.
  261.     --- ----------------
  262.  
  263.     Syntax :
  264.  
  265.      RECEIVE
  266.  
  267.     Receives a file or filegroup from the other Kermit. In the  filename
  268.     a  period  is  replaced by a slash and special characters, which are
  269.     prohibit in Burroughs-files, are replaced by "X".
  270.     If an  incoming  filename  already  exists,  then  the  filename  is
  271.     extended  with <integer> (the integer is in the range 01 through 99)
  272.     and Kermit-Bur writes a warning to a permanent disk  file  (TITLE  :
  273.     KERMIT/WARNINGS).  With the SET-command you can specify the FILEKIND
  274.     of the file(s) to be received.
  275.  
  276.     The SEND-command.
  277.     --- -------------
  278.  
  279.     Syntax :
  280.  
  281.        ---SEND---|---< filename >----------------------|----
  282.                  |                                     |
  283.                  |---< directory >----- < /=> ---------|
  284.  
  285.     Send a file or filegroup to the other Kermit. To transfer more files
  286.     within one SEND-command you must use a directory.
  287.     In Kermit-Bur multiple file transfer is implemented as the  transfer
  288.     of all the files in one directory.
  289.  
  290.         e.g.  SEND KERMIT/TEXT ,
  291.               SEND KERMIT/=
  292.  
  293.     The SERVER-command.
  294.     --- ---------------
  295.  
  296.     Syntax:
  297.  
  298.     SERVER
  299.  
  300.     When giving the SERVER-command you set Kermit-Bur in a special  mode
  301.     the  so  called  SERVER-mode. You must still connect to the B7900 to
  302.     log-in and start the SERVER with  the  SERVER-command,  but  you  no
  303.     longer have to tell one side to SEND and the other to RECEIVE. After
  304.     giving the SERVER-command you escape back to the local Kermit and do
  305.     as  many  SEND-  and  RECEIVE-operations  as you like. For receiving
  306.     files you use the local GET-command (if implemented). To  shut  down
  307.     the  SERVER  you  have  to  give a local FINISH-command (a so called
  308.     generic  command),  after  which  Kermit-Bur  waits  for  your  next
  309.     command.  If  you  want  to  finish  the Kermit-session, you have to
  310.     CONNECT again, issue the EXIT-command to Kermit-Bur and log-out from
  311.     the Burroughs host.
  312.     At the moment the FINISH-command is  the  only  implemented  generic
  313.     command.
  314.     The available local commands can be found in your local Kermit  User
  315.     Guide.
  316.  
  317.     The EXIT-command.
  318.     --- -------------
  319.  
  320.     Syntax:
  321.  
  322.     EXIT
  323.  
  324.     To terminate Kermit (i.e. to halt & close).
  325.  
  326.     The HELP-command.
  327.     --- -------------
  328.  
  329.     Syntax :
  330.  
  331.          ---- HELP----|----------------------------|-------
  332.                       |                            |
  333.                       |---< Kermit-Bur command >---|
  334.  
  335.     HELP gives a survey  of  the  possible  commands.  HELP  <Kermit-Bur
  336.     command> gives the information of the specified command.
  337.  
  338.         e.g.   HELP,
  339.                HELP RECEIVE
  340.