home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / d / cray.doc < prev    next >
Text File  |  2020-01-01  |  24KB  |  701 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.        February 1985                 - i -                     Kermit-CR
  7.  
  8.  
  9.  
  10.               __________________________________________________
  11.  
  12.                 Copyright, 1984, The Regents of the University
  13.                 of  California.   This  document  was produced
  14.                 under a U.S. Government contract  (W-7405-ENG-
  15.                 36)  by  the  Los  Alamos National Laboratory,
  16.                 which  is  operated  by  the   University   of
  17.                 California for the U.S.  Department of Energy.
  18.                 The  U.S.  Government  is  licensed  to   use,
  19.                 reproduce,   and   distribute  this  document.
  20.                 Permission is granted to the  public  to  copy
  21.                 and use this document without charge, provided
  22.                 that  this  notice  and   any   statement   of
  23.                 authorship   are  reproduced  on  all  copies.
  24.                 Neither  the  Government  nor  the  University
  25.                 makes  any  warranty,  express  or implied, or
  26.                 assumes any liability  or  responsibility  for
  27.                 the use of this document.
  28.               __________________________________________________
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                               Kermit for the Cray
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.        February 1985                 - 1 -                     Kermit-CR
  72.  
  73.  
  74.  
  75.        KERMIT-CR  KERMIT FOR THE CRAY
  76.        _________________________________________________________________
  77.  
  78.  
  79.        1. INTRODUCTION
  80.  
  81.  
  82.        Kermit-CR is an implementation of the Kermit protocol on the
  83.        Cray-1 and Cray X-MP computers.  It is written in CFT, the Cray
  84.        version of Fortran-77, and runs under the Cray Time-Sharing Sys-
  85.        tem (CTSS) operating system.  Kermit-CR is an advanced Kermit,
  86.        including all required features plus server mode, timeout capa-
  87.        bility, data compression, and 8th bit quoting.
  88.  
  89.        Specific features of Kermit-CR are described in section 2.  The
  90.        Kermit-CR commands are described in section 3.  Section 4 pro-
  91.        vides help for installing Kermit-CR.
  92.  
  93.  
  94.  
  95.        2. SPECIFIC FEATURES OF KERMIT-CR
  96.  
  97.  
  98.        2.1 Host Versus Local Kermits
  99.  
  100.        Kermit-CR is a host Kermit intended for shipping files between a
  101.        Cray and a local workstation.  The local Kermit controls the
  102.        screen during file transmission.
  103.  
  104.  
  105.  
  106.        2.2 Non-Server Mode
  107.  
  108.        Non-server mode is the default Kermit mode.  You CONNECT from
  109.        local to host Kermit, enter host Kermit command (e.g., send a
  110.        file), and escape back to the local Kermit to give it the
  111.        corresponding command (e.g., receive).  Some local Kermits lack
  112.        the commands for talking to a server and can only communicate
  113.        with Kermit-CR in this mode.
  114.  
  115.  
  116.  
  117.        2.3 Server Mode
  118.  
  119.        Server mode makes file transfer more automatic.  After entering
  120.        the Kermit-CR command "server," you escape back to local Kermit
  121.        and control subsequent file transfers exclusively from the local
  122.        side. Note that Kermit-CR lacks the ability to log itself out.
  123.        The local Kermit's server commands FINISH, BYE, or LOGOUT cause
  124.  
  125.  
  126.                               Kermit for the Cray
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.        Kermit-CR                     - 2 -                 February 1985
  134.  
  135.  
  136.  
  137.        termination of Kermit-CR and return to CTSS level on the host
  138.        machine.
  139.  
  140.  
  141.  
  142.        2.4 File Name Considerations
  143.  
  144.        If an incoming file arrives correctly, it replaces any file of
  145.        the same name in your Cray filespace.  If errors are detected
  146.        during transmission, the incoming file is discarded; your origi-
  147.        nal file remains intact.  Uppercase letters in incoming filenames
  148.        are converted to lowercase.
  149.  
  150.  
  151.  
  152.        2.5 Interrupting Transfers
  153.  
  154.        Kermit-CR understands transfer-interrupt messages from any local
  155.        Kermit which also has this capability (e.g., Kermit-MS on the IBM
  156.        PC).  Type CTRL-X during transmission to cancel shipment of the
  157.        current file, or CTRL-Z to cancel a group of files.
  158.  
  159.  
  160.  
  161.        2.6 Wildcard Characters
  162.  
  163.        Kermit-CR cannot do wildcard sends.  In non-server mode, Kermit-
  164.        CR can send multiple files with a single command via the command
  165.        "send <file1> .. <filen>".  Such files are considered a group
  166.        with respect to the interrupt capability described previously.
  167.  
  168.  
  169.  
  170.        2.7 CTSS Text Files
  171.  
  172.        In default mode, Kermit-CR converts all CTSS end-of-line charac-
  173.        ters (Ascii US) to CR, LF sequences on outgoing files and vice
  174.        versa for incoming files.  The CTSS end-of-file character (Ascii
  175.        FS) is treated as file terminator and is stripped from outgoing
  176.        files and appended to incoming files.  This is intended to ensure
  177.        compatibility of the received file with other standard utilities.
  178.  
  179.  
  180.  
  181.        2.8 Binary Files
  182.  
  183.        In a Cray network under CTSS, the line concentrator typically
  184.        uses the 8th bit of each byte/character to represent parity.
  185.  
  186.  
  187.  
  188.                               Kermit for the Cray
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.        February 1985                 - 3 -                     Kermit-CR
  196.  
  197.  
  198.  
  199.        Kermit-CR can exchange binary files with any local Kermit having
  200.        the optional 8th bit quoting feature of the protocol (e.g.,
  201.        Kermit-MS).  To ship a binary file, or to ship any file without
  202.        the conversions described above,  you must first give the
  203.        Kermit-CR command "set native off".  If your local Kermit lacks
  204.        8th bit quoting, binary file transmission will fail after a few
  205.        packets, because the packet checksum will not match the checksum
  206.        that is calculated upon arrival.  Note that a binary file shipped
  207.        to Kermit-CR and later down-loaded to a workstation may appear to
  208.        have gained a few bytes.  This is because Kermit-CR has padded
  209.        out its last word with nulls.
  210.  
  211.  
  212.  
  213.        2.9 Variant CTSS Text Files
  214.  
  215.        Before being written onto mass storage, CTSS text files are fre-
  216.        quently converted to a packed form via the STEXT utility.  In
  217.        this form, escape sequences represent blank strings.  The NTEXT
  218.        utility is used to reverse this transformation.  However, if
  219.        standard defaults are used, NTEXT does not expand the compressed
  220.        blanks.  These escape sequences are understood by most CTSS util-
  221.        ities, and may be inserted directly into the text by some editors
  222.        (see below).  If you want to export such files to a workstation,
  223.        you should expand blank compression sequences first.
  224.  
  225.  
  226.  
  227.        2.9.1 STEXT Files
  228.  
  229.        Text files in STEXT format can be sent unconverted to a worksta-
  230.        tion with the Kermit-CR native option set off.  If you want to
  231.        list or edit the file on the workstation, you should convert the
  232.        file to CTSS format before shipping, by using the command:
  233.  
  234.          ntext  filename1  [filename2]  -noc
  235.  
  236.        The -noc parameter is required.  The file should be sent with the
  237.        Kermit-CR native option on.
  238.  
  239.  
  240.  
  241.        2.9.2 TRIXGL Files
  242.  
  243.        Use the Ascii standard option CFA(file), instead of the compres-
  244.        sion option CFS(file), to close text files created with the
  245.        TRIXGL editor, if you want to edit or list the files on a works-
  246.        tation.  Files closed with the compression option can be con-
  247.        verted to standard Ascii by opening them and then closing them
  248.        using CFA.  The file can then be shipped with the Kermit-CR
  249.  
  250.  
  251.                               Kermit for the Cray
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.        Kermit-CR                     - 4 -                 February 1985
  259.  
  260.  
  261.  
  262.        native option on.  The TRIXGL trailer, which follows the CTSS
  263.        end-of-file character and extends to the physical end of file,
  264.        will be stripped from outgoing files.
  265.  
  266.  
  267.  
  268.        2.10 Screen Editor and Document Preparation Output
  269.  
  270.        Some screen editors allow the user to insert escape sequences
  271.        into a text file, and many document preparation packages insert
  272.        formatting characters or sequences.  The Kermit protocol guaran-
  273.        tees the integrity of files during transmission.  If you intend
  274.        to apply a software utility to such a file on the receiving side,
  275.        you should make sure that such characters or sequences are under-
  276.        stood by the utility.
  277.  
  278.  
  279.  
  280.        2.11 Data Compression
  281.  
  282.        Kermit-CR automatically performs data compression when talking to
  283.        a local Kermit that also has this optional capability (e.g.,
  284.        Kermit-MS, but not Kermit-86).  Otherwise, Kermit-CR omits data
  285.        compression.
  286.  
  287.  
  288.  
  289.        2.12 Automatic Logging
  290.  
  291.        For each Kermit-CR session, a logfile named "kmtlog" is created.
  292.        All user commands, status information for each transfer, and
  293.        error conditions are logged.
  294.  
  295.  
  296.  
  297.        2.13 Error Reporting
  298.  
  299.        All detected errors are reported in two ways:  1. An error packet
  300.        with a descriptive message is sent to the local Kermit for screen
  301.        display, and  2. The same message is written onto the Kermit-CR
  302.        logfile.  If the error is minor (e.g., you tried to send a file
  303.        not in your filespace), Kermit-CR will reissue its prompt.  If
  304.        the error is unrecoverable under CTSS, it will be necessary to
  305.        restart the resulting CTSS dropfile to allow Kermit-CR to log the
  306.        message, close the logfile, and abort.
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.                               Kermit for the Cray
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.        February 1985                 - 5 -                     Kermit-CR
  322.  
  323.  
  324.  
  325.        2.14 Establishing Transmission Parameters
  326.  
  327.        Under CTSS, Cray machines normally accept input from line-
  328.        concentrator hardware that echoes back local messages.  Usually,
  329.        echoback can be disabled by prefixing packets with the appropri-
  330.        ate pad character.  However, transmission parameters must be set
  331.        by the local Kermit at the start of a session with Kermit-CR, in
  332.        order to ensure that the first packet gets through.
  333.  
  334.        Kermit-MS as supported at LANL, includes a short initialization
  335.        file, MSKERMIT.INI, containing a macro definition for Cray com-
  336.        munication.  To invoke it, type:
  337.  
  338.          Kermit-MS>do cray
  339.  
  340.        For other local Kermits, the following parameter settings must be
  341.        used:
  342.  
  343.          npad    1
  344.          pad    26   (CTRL-Z = Ascii SUB)
  345.          end    23   (CTRL-W = Ascii ETB)
  346.  
  347.  
  348.        These settings are used to disable echoback from network line
  349.        concentrators.
  350.  
  351.        Long-distance dialup users should type the local Kermit CONNECT
  352.        command, log on to a Cray, start Kermit-CR, and escape back to
  353.        their local Kermits to set these parameters or invoke the macro.
  354.  
  355.  
  356.  
  357.        3. KERMIT-CR COMMANDS
  358.  
  359.        Kermit-CR follows standard CUCCA Kermit syntax with this single
  360.        exception:  in non-server mode, more than one file may be sent by
  361.        a single SEND command.  This facility substitutes for the use of
  362.        wildcard character file designators on sends.  Although Kermit-CR
  363.        Release 2 does not provide full interactive help facilities,  it
  364.        does display "helpful" error messages before returning to command
  365.        level.  For example, the user can type a question mark in place
  366.        of the value for a SET option to force a display of the valid
  367.        range for that value.
  368.  
  369.        Kermit-CR recognizes abbreviated command words where there is no
  370.        ambiguity.  The square-bracketed portions of the commands may be
  371.        omitted.
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.                               Kermit for the Cray
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.        Kermit-CR                     - 6 -                 February 1985
  386.  
  387.  
  388.  
  389.      s[end]                <list of 1-10 filenames delimited by spaces>
  390.                            send the listed files to a local Kermit.
  391.  
  392.  
  393.      r[eceive]             get a file from a local Kermit (both Kermits
  394.                            in non-server mode).
  395.  
  396.  
  397.      server                enter server mode.  All transfer information
  398.                            will come from the local Kermit, in packets.
  399.                            Command FINISH to the local Kermit terminates
  400.                            this mode and causes exit from Kermit-CR to
  401.                            CTSS.
  402.  
  403.  
  404.      e[xit]                Exit from Kermit-CR (non-server mode) to
  405.                            CTSS.
  406.  
  407.  
  408.      set <option> <value>  Set the value of a Kermit-CR parameter for
  409.                            the current session.  The SET options are:
  410.  
  411.                            time <n>         Set the timeout interval, in
  412.                                             seconds.  Use  0 <= n <= 99.
  413.                                             This value is automatically
  414.                                             doubled while the initial
  415.                                             connection to the local Ker-
  416.                                             mit is being made.  Default
  417.                                             is 5.
  418.  
  419.                            retry <n>        Set the number of times
  420.                                             Kermit-CR will try to send
  421.                                             the same packet.  After the
  422.                                             nth unsuccessful try,
  423.                                             Kermit-CR logs an error mes-
  424.                                             sage in the session log,
  425.                                             closes any open data file,
  426.                                             aborts the transfer and
  427.                                             issues its prompt.  Default
  428.                                             is 5.
  429.  
  430.                debug <on | off> Determine the extent of log-
  431.                                             ging.  Default is OFF: all
  432.                                             user commands, their status
  433.                                             at termination, any error
  434.                                             conditions and CTSS times
  435.                                             used are logged.  With debug
  436.                                             ON, all packet traffic is
  437.                                             also logged.
  438.  
  439.  
  440.  
  441.                               Kermit for the Cray
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.        February 1985                 - 7 -                     Kermit-CR
  449.  
  450.  
  451.  
  452.              bufsize <n>        Set the maximum packet size
  453.                                             for the other Kermit to use
  454.                                             when sending to the Cray.
  455.                                             This value does not include
  456.                                             any prefixed pad characters
  457.                                             or appended end-of-line
  458.                                             character.  Default is 82.
  459.                                             This value is site depen-
  460.                                             dent.  It may be constrained
  461.                                             to be less than the maximum
  462.                                             of 96 due to limitations on
  463.                                             physical or virtual buffer
  464.                                             lengths in front-end line
  465.                                             concentrator devices.  If
  466.                                             such constraints apply and
  467.                                             too large a value is used,
  468.                                             packet tails may be lost.
  469.                                             Arriving packets will then
  470.                                             appear to have had check-
  471.                                             sums.  If echoback is being
  472.                                             disabled by using special
  473.                                             PAD and END-OF-LINE charac-
  474.                                             ters, this may be disrupted
  475.                                             by truncation of the packet
  476.                                             portion containing the END-
  477.                                             OF-LINE character.
  478.  
  479.               native <on | off> Default value ON tells
  480.                                             Kermit-CR to convert all
  481.                                             CTSS end-of-line characters
  482.                                             (Ascii US) to CR,LF
  483.                                             sequences on outgoing files,
  484.                                             and vice-versa for incoming
  485.                                             files.  When sending,
  486.                                             Kermit-CR treats the first
  487.                                             occurrence of Ascii FS, the
  488.                                             CTSS end-of-file character,
  489.                                             as file terminator and
  490.                                             strips it.  This character
  491.                                             is appended to incoming
  492.                                             files.  Set this option OFF
  493.                                             to transfer binary files.
  494.  
  495.  
  496.      st[atus]              Display the current values of parameters that
  497.                            can be modified by the SET command.
  498.  
  499.  
  500.      h[elp]                Display short menu of Kermit-CR commands.
  501.  
  502.  
  503.  
  504.  
  505.  
  506.                               Kermit for the Cray
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.        Kermit-CR                     - 8 -                 February 1985
  514.  
  515.  
  516.  
  517.        4. KERMIT-CR INSTALLATION
  518.  
  519.  
  520.        Kermit-CR consists of the following 8 source modules:
  521.  
  522.  
  523.        cr.kermain  - main Kermit-CR program and local functions.
  524.  
  525.        cr.kutcmds  - SERVER, SET, STATUS, and HELP command inter-
  526.              preters.
  527.  
  528.        cr.send     - SEND command interpreter.
  529.  
  530.        cr.receive  - RECEIVE command interpreter.
  531.  
  532.        cr.filing   - virtual file I/O.
  533.  
  534.        cr.pktio    - virtual and physical packet I/O
  535.  
  536.        cr.stdutils - portable utility functions.
  537.  
  538.        cr.kfutil   - physical file and display I/O: procedures invok-
  539.              ing CTSS functions.
  540.  
  541.        Kermit-CR runs on both the Cray-1 and Cray X-MP.  Executable code
  542.        produced on a Cray X-MP will run on the Cray-1, but not vice
  543.        versa.  Kermit-CR does not exploit the vectorization or parallel
  544.        execution potential of its hosts, as maximum transfer speed is
  545.        limited by the baud rate available for packet communication and
  546.        the timesharing load on the host Cray.
  547.  
  548.        Disabling echoback is the major potential source of difficulty in
  549.        installing Kermit-CR.  Under CTSS, Cray-1 and Cray X-MP expect
  550.        line input from terminals.  Line input is provided by line con-
  551.        centrator hardware, which constitutes a normally transparent
  552.        intermediate node between a terminal or PC and a Cray machine.
  553.        This hardware echoes back terminal input.  When the terminal is a
  554.        PC running Kermit, this echoback must be selectively disabled so
  555.        that the packet being sent to Kermit-CR does not appear in the
  556.        local Kermit's input buffer.
  557.  
  558.        Kermit-CR disables packet echoback by asking the local Kermit to
  559.        bracket each packet between a single CTRL-Z pad character and a
  560.        single CTRL-W end-of-line character.  The appropriate values may
  561.        be site dependent.  The effect of the pad character is also site
  562.        dependent.  It may function as a disable echoback signal or act
  563.        as a toggle switch for turning echoback on and off.  The pad and
  564.        end-of-line characters themselves may echoback into the local
  565.        Kermit's serial input buffer.  Normally, this echoback is harm-
  566.        less.  However, there are local Kermits that do not throw away
  567.        characters preceding the SOH.  Consequently, transmission may
  568.  
  569.  
  570.                               Kermit for the Cray
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.        February 1985                 - 9 -                     Kermit-CR
  578.  
  579.  
  580.  
  581.        fail if the two echoed-back characters plus the incoming packet
  582.        overflow an internal buffer.  For this reason, Kermit-CR chooses
  583.        safety over efficiency and uses a send packet length two less
  584.        than requested by the local Kermit.
  585.  
  586.        Kermit-CR requests the pad and end-of-line character values in
  587.        its initial "S" packet.  However, if the local Kermit sends the
  588.        first packet for a particular transaction, there may be diffi-
  589.        culty establishing communication.  In order to assure getting the
  590.        first packet through, it is necessary to set the NPAD, PAD, and
  591.        END-OF-LINE parameters (to be used in sending) on the local Ker-
  592.        mit side.
  593.  
  594.        The bracketing technique is not without risk: if one or both of
  595.        the bracketing characters is lost, echoback may reoccur inap-
  596.        propriately.  The local Kermit will fail immediately, giving an
  597.        "unexpected packet type" error or giving no error description.
  598.  
  599.        Some recent workstation Kermits (e.g., MSKERMIT v2.27) check for
  600.        echoback by comparing incoming packet type to the type of the
  601.        last packet sent.  In this case, the user should be able to
  602.        ignore echoback and use the workstation Kermit's default NPAD,
  603.        PAD, and EOL parameters.  However, some line concentrators get
  604.        swamped by the data rate of a local Kermit that is sending files,
  605.        if echoback is not disabled.  Therefore, Kermit-CR still requests
  606.        the NPAD, PAD, and EOL parameters, described above, in its ini-
  607.        tial "S" packet.
  608.  
  609.        If Kermit-CR will be used only with echoback-detecting local Ker-
  610.        mits, the installer can recompile the logical function, KINIT,
  611.        omitting the line of code marked as a site dependency.  Kermit-CR
  612.        will then request standard parameters.  A symptom of line-
  613.        concentrator overload is truncated packets on upward sends.
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.                               Kermit for the Cray
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.        February 1985                - iii -                     CONTENTS
  643.  
  644.  
  645.  
  646.        CONTENTS
  647.        _________________________________________________________________
  648.  
  649.  
  650.              1. Introduction ......................................    1
  651.              2. Specific Features of Kermit-CR ....................    1
  652.               2.1 Host Versus Local Kermits .......................    1
  653.               2.2 Non-Server Mode .................................    1
  654.               2.3 Server Mode .....................................    1
  655.               2.4 File Name Considerations ........................    2
  656.               2.5 Interrupting Transfers ..........................    2
  657.               2.6 Wildcard Characters .............................    2
  658.               2.7 CTSS Text Files .................................    2
  659.               2.8 Binary Files ....................................    2
  660.               2.9 Variant CTSS Text Files .........................    3
  661.                2.9.1 STEXT Files ..................................    3
  662.                2.9.2 TRIXGL Files .................................    3
  663.           2.10 Screen Editor and Document Preparation Output...    4
  664.               2.11 Data Compression ...............................    4
  665.               2.12 Automatic Logging ..............................    4
  666.               2.13 Error Reporting ................................    4
  667.               2.14 Establishing Transmission Parameters ...........    5
  668.              3. Kermit-CR Commands ................................    5
  669.              4. Kermit-CR Installation ............................    8
  670.  
  671.  
  672.  
  673.  
  674.  
  675.  
  676.  
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.                               Kermit for the Cray
  700.  
  701.