home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / honeywellcp6b / hcp6doc.txt < prev   
Text File  |  2020-01-01  |  17KB  |  568 lines
  1. PART I.  INSTALLATION
  2.  
  3. Program Kermit implements the KERMIT protocol under HONEYWELL/CP6.
  4.  
  5. Authors:   Philip Murton - original RT-11 PASCAL program.
  6.            Bruce W. Pinn - modified version for VAX/VMS.
  7.            Douglas Vaughan, Cheryl Poostay, Kevin Asplen, Jay Undercoffler
  8.                          - modified VAX/VMS version for HONEYWELL/CP6.
  9.  
  10. Date:  March 27, 1985
  11.  
  12. Site:  Bucknell University Computing Services
  13.        Lewisburg, Pennsylvania 17837
  14.        (717) 524-1801
  15.  
  16.  
  17. Files:
  18.      KERMIT - Source code and JCL to create the Kermit rununit.
  19.      INSTALL - Installation instructions, description of
  20.                operation, and summary of Kermit commands.
  21.      DRIBBLE - Dribble file of the transfers of a test file from
  22.                CP6 to an IBMPC and from the IBMPC back to CP6.
  23.      OCTAL - Octal listing of the dribble file.
  24.  
  25.  
  26.    The file 'KERMIT' is a BATCH  file containing the JCL and source
  27. code required to create the rununit KERMIT_RU.  The bulk of the code
  28. is written in PASCAL and was compiled at Bucknell using CP6 PASCAL
  29. Version B01.  The NDB (no debug) compiler option is used in an effort
  30. to maximize file transfer speed.  The CP6 system dependent routines
  31. are written in PL6 and were compiled at Bucknell using PL6 Version
  32. B02.
  33.  
  34.    To create the rununit KERMIT_RU, !BATCH KERMIT .
  35.  
  36.  
  37. PART II.  PROGRAM OPERATION
  38.  
  39.    Kermit-CP6 runs interactively with a user connected to CP6 via
  40. a remote Kermit.  File transfers from CP6 to the remote Kermit and
  41. from the remote Kermit to CP6 must originate from Kermit-CP6.
  42.  
  43.    The following Bucknell documentation illustrates the logging on
  44. and file transfer processes between CP6 and an IBMPC running Kermit-MS.
  45.  
  46. BUCKNELL KERMIT INSTRUCTIONS
  47.  
  48. LOGGING ON
  49.  
  50. 1....Obtain the KERMIT software from either the programming
  51.      assistant or the bulletin board adjacent to the phone.
  52.  
  53. 2....Open the door on Drive A (left drive).  With the label
  54.      side up and your thumb on the label insert the KERMIT
  55.      disk into Drive A.  Close the drive door.
  56.  
  57. 3....Power on the IBM.  If the IBM is powered on, press the
  58.      Del key while holding down both the Ctrl and Alt keys.
  59.  
  60. 4....Type KERMIT   <--'   in response to the A> prompt.
  61.  
  62. 6....Press   <--' .
  63.  
  64. 7....Log On.
  65.  
  66. 8....!PROFILE IBMPC
  67.  
  68. 9....Return the KERMIT software.
  69.  
  70. FILE TRANSFERS
  71.  
  72. TO SEND A CP6 FILE TO THE IBMPC
  73.  
  74.      1....LOGON to CP6.
  75.      2....Insert a formatted IBM disk into Drive B (right drive).
  76.      3....Start the CP6 file transfer program.
  77.               !START KERMIT_RU
  78.  
  79.      4....Initiate the file transfer.
  80.           Kermit-CP6>SEND CP6filename  <--'
  81.  
  82.      5....Within 10 seconds, hold down the Ctrl key and press ] ; release both
  83.           keys.  Type the letter C.
  84.  
  85.      6....Continue the file transfer.
  86.           Kermit-IBM>RECEIVE IBMfilename  <--'
  87.  
  88.           An IBM filename is 1-8 characters in length, and can be followed by a 1-3
  89.           character extension.  The following characters can be used for filenames
  90.           and extensions: A-Z  0-9  $  &  #  @  !  %  "  (  )  -  {  }  _  /  \
  91.  
  92.           To confirm the file transfer: Kermit-IBM>DIR
  93.  
  94.  
  95.      7....Return to CP6.
  96.           Kermit-IBM>CONNECT <--'  and press <--'
  97.  
  98.      8....Repeat Steps 4-6 to send another file
  99.                        OR
  100.           Kermit-CP6>Q  to quit CP6 Kermit.
  101.  
  102.      9....Logoff.
  103.  
  104. TO SEND AN IBMPC FILE TO CP6
  105.  
  106.     1.....LOGON to CP6.
  107.     2.....Insert the disk containing the IBM file to be sent into Drive B.
  108.     3.....Start the CP6 file transfer program.
  109.              !START KERMIT_RU
  110.  
  111.     4.....Initiate the file transfer.
  112.           Kermit-CP6>RECEIVE   CP6filename  <--'
  113.  
  114.     5.....Within 10 seconds, hold down the Ctrl key and press ] ; release both keys.
  115.           Type  C  .
  116.  
  117.     6.....Continue the file transfer.
  118.           Kermit-IBM>SEND IBMfilename  <--'
  119.  
  120.     7.....Return to CP6.
  121.           Kermit-IBM>CONNECT <--'  and press <--'
  122.  
  123.      8....Repeat Steps 4-6 to send another file
  124.                        OR
  125.           Kermit-CP6>Q  to quit CP6 Kermit.
  126.  
  127.      9....Logoff.
  128.  
  129. PART III.  SUMMARY OF KERMIT-CP6 COMMANDS.
  130.  
  131. The valid KERMIT-CP6 commands are:
  132.  
  133.    HELP        STATUS      EXIT/QUIT
  134.    SEND        RECEIVE     SET         SHOW
  135.  
  136. A description of each command follows.
  137.  
  138. 1.  HELP
  139.     In order to use the HELP facilities on KERMIT-CP6, type 'HELP command'.
  140.     Abbreviated HELP can be obtained on selected commands by typing 'command ?'.
  141.  
  142.  
  143. 2.  STATUS
  144.  
  145.     Description:
  146.       Displays information on the most recent file transmission of data.
  147.  
  148.     Example:
  149.         KERMIT-CP6> STATUS
  150.  
  151. 3.  EXIT/QUIT
  152.  
  153.     Description:
  154.         Exits KERMITCP6 and returns to IBEX.
  155.  
  156.     Examples:
  157.         KERMIT-CP6> QUIT
  158.         KERMIT-CP6> EXIT
  159.  
  160.  
  161. 4.  SEND filespec
  162.  
  163.     Description:
  164.         Sends the specified CP6 file to the remote Kermit.
  165.         Wildcarding is not allowed; only one file per SEND is allowed.
  166.  
  167.     filespec:
  168.         any valid, existing CP6 file-specification.
  169.  
  170.     Examples:
  171.         KERMIT-CP6> SEND MYFILE
  172.         KERMIT-CP6> SEND ANOTHER_FILE
  173.  
  174. 5.  RECEIVE filespec
  175.  
  176.     Description:
  177.         Prepares KERMITCP6 to receive a file being sent by the remote Kermit.
  178.         Wildcarding by the remote Kermit is allowed.
  179.  
  180.     filespec:
  181.         Any valid CP6 file-specification.
  182.         If omitted, the file-specification will be obtained from the
  183.            file header sent by the remote Kermit.
  184.         If the remote Kermit is sending more than one file, the first
  185.            CP6 filename will be obtained from filespec(if specified);
  186.            subsequent filenames will be obtained from the file headers
  187.            sent by the remote Kermit.
  188.  
  189.     WARNING!  KERMIT will overwrite an existing
  190.               file with the given filespec.
  191.  
  192.     Examples:
  193.         KERMIT-CP6> RECEIVE MYFILE
  194.         KERMIT-CP6> RECEIVE
  195.  
  196. 6.  SET keywords
  197.  
  198.           SEND  <option>
  199.           RECEIVE <option>
  200.           TRANSMODE <ASCII | binary>
  201.           EIGHT-QUOTE <character>
  202.           FILERECORD <CRLF | lf | cr>
  203.           PARITY <NONE | even | odd>
  204.           DEBUGGING <on | OFF>
  205.           SPEED  <decimal>
  206.           DELAY  <decimal>
  207.  
  208.  
  209. 6.1  SET SEND keyword
  210.  
  211.           PACKET-LENGTH <decimal>
  212.           PADDING <decimal>
  213.           PADCHAR <octal value>
  214.           TIMEOUT <decimal>
  215.           END-OF-LINE <octal value>
  216.           QUOTE <character>
  217.  
  218. 6.1.1  SHOW SEND PACKET-LENGTH par
  219.  
  220.        Description:
  221.            Shows the send packet length.
  222.        par:
  223.             may be any decimal value between 10 and 96
  224.             Default Value = 94
  225.  
  226.        Note that SETting this will have no effect since
  227.        the remote Kermit will send the value it requires.
  228.  
  229.        Affect this change by SETting the RECEIVE PACKET-LENGTH
  230.        parameter of the remote Kermit.
  231.  
  232.        Example:
  233.              KERMIT-CP6> SHOW SEND PACKET-LENGTH
  234.              KERMIT-IBM> SET RECEIVE PACKET-LENGTH 80
  235.  
  236.  
  237.  
  238. 6.1.2  SHOW SEND PADDING
  239.  
  240.        Description:
  241.            Shows the number of padding characters that will be
  242.            sent to the remote Kermit.
  243.  
  244.        Note that SETting this will have no effect since
  245.        the remote Kermit will send the value it requires.
  246.  
  247.        Affect this change by SETting the RECEIVE PADDING
  248.        parameter of the remote Kermit.
  249.  
  250.        Example:
  251.            KERMIT-CP6> SHOW SEND PADDING
  252.            KERMIT-IBM> SET RECEIVE PADDING 30
  253.  
  254.  
  255. 6.1.3    SHOW SEND PADCHAR
  256.  
  257.          Description:
  258.              Shows the character that will be sent as padding to the
  259.              remote Kermit.
  260.  
  261.          Note that SETting this parameter will have no effect since
  262.          the remote Kermit will send the value it requires.
  263.  
  264.          Example:
  265.              KERMIT-CP6> SHOW SEND PADCHAR
  266.  
  267.  
  268. 6.1.4    SHOW SEND TIMEOUT par
  269.  
  270.          Description:
  271.              Shows the number of seconds Kermit CP6 will wait for
  272.              a response to a packet sent to the remote Kermit.
  273.              The SEND is terminated if a timeout occurs.
  274.          par:
  275.              may be any positive decimal number, given in seconds
  276.              Default value = 20 seconds
  277.  
  278.          Note that SETting this will have no effect since
  279.          the remote Kermit will send the value it requires.
  280.  
  281.          Affect this change by SETting the RECEIVE TIMEOUT
  282.          parameter of the remote Kermit.
  283.  
  284.          Example:
  285.              KERMIT-CP6> SHOW SEND TIMEOUT
  286.              KERMIT-IBM> SET RECEIVE TIMEOUT 10
  287.  
  288.  
  289. 6.1.5    SET/SHOW SEND END-OF-LINE par
  290.  
  291.          Description:
  292.              This command sets/shows the end of line character KERMITCP6 will
  293.              send to the remote Kermit.
  294.  
  295.          par:
  296.              may be any ASCII value for a character, given in octal
  297.              Default value = 15 (ASCII CR, CTRL-M)
  298.  
  299.          Examples:
  300.              KERMIT-CP6> SET SEND END-OF-LINE 12
  301.              KERMIT-CP6> SHOW SEND END-OF-LINE
  302.  
  303.  
  304. 6.1.6    SET/SHOW SEND QUOTE par
  305.  
  306.          Description:
  307.              Sets/shows the printable character KERMITCP6 will
  308.              send to the remote Kermit to prefix control characters.
  309.          par:
  310.              may be any printable character
  311.              Default value = "#" (ASCII 35(dec) )
  312.              NOTE:  Change the quote character to send
  313.                     CP6 files with many '#' characters.
  314.          Affect this change by
  315.            SETting the RECEIVE QUOTE parameter of the remote KERMIT,
  316.                    the SEND QUOTE parameter of the remote KERMIT, and
  317.                    the SEND QUOTE parameter of Kermit CP6 to the same value.
  318.          Examples:
  319.              KERMIT-CP6> SHOW SEND  QUOTE
  320.              KERMIT-CP6> SET SEND QUOTE +
  321.              KERMIT-IBM> SET SEND QUOTE 43 (The ASCII value of '+' is 43.)
  322.              KERMIT-IBM> SET RECEIVE QUOTE 43
  323.  
  324.  
  325. 6.2     SET RECEIVE keyword
  326.  
  327.         Keywords:
  328.           PACKET-LENGTH <decimal>
  329.           PADDING <decimal>
  330.           PADCHAR <octal value>
  331.           TIMEOUT <decimal>
  332.           END-OF-LINE <octal value>
  333.           QUOTE <character>
  334.  
  335. 6.2.1    SET/SHOW RECEIVE PACKET-LENGTH par
  336.  
  337.          Description:
  338.              Sets/shows the maximum of number of characters
  339.              in a message received by KermitCP6.
  340.  
  341.          par:
  342.              may be any decimal value between 10 and 96
  343.              Default Value = 94
  344.  
  345.          Examples:
  346.              KERMIT-CP6> SET RECEIVE PACKET-LENGTH 60
  347.              KERMIT-CP6> SHOW RECEIVE PACKET-LENGTH
  348.  
  349.  
  350. 6.2.2    SET/SHOW RECEIVE PADDING par
  351.  
  352.          Description:
  353.              Sets/shows the number of padding characters will
  354.              precede a message received by KERMITCP6.
  355.  
  356.          par:
  357.              may be any positive decimal number
  358.              Default value = 0
  359.  
  360.          Examples:
  361.              KERMIT-CP6> SET RECEIVE PADDING 5
  362.              KERMIT-CP6> SHOW RECEIVE PADDING
  363.  
  364.  
  365. 6.2.3    SET/SHOW RECEIVE PADCHAR par
  366.  
  367.          Description:
  368.              Sets/shows the character that will precede
  369.              a message received by KERMITCP6.
  370.              See SET RECEIVE PADDING.
  371.  
  372.          par:
  373.              may be any ASCII value, given as an octal
  374.              number in the range: 0-37, or 177
  375.              Default value = 0  (ASCII NUL)
  376.  
  377.          Examples:
  378.              KERMIT-CP6> SET RECEIVE PADCHAR 15
  379.              KERMIT-CP6> SHOW RECEIVE PADCHAR
  380.  
  381.  
  382. 6.2.4    SET/SHOW RECEIVE TIMEOUT par
  383.  
  384.          Description:
  385.              Sets/shows the number of seconds KERMITCP6 will
  386.              wait while attempting to receive a message from the remote Kermit.
  387.  
  388.          par:
  389.              may be any positive decimal number, given in seconds
  390.              Default value = 20 seconds
  391.  
  392.          Examples:
  393.              KERMIT-CP6> SET RECEIVE TIMEOUT 15
  394.              KERMIT-CP6> SHOW RECEIVE TIMEOUT
  395.  
  396.  
  397.  
  398. 6.2.5    SET/SHOW RECEIVE END-OF-LINE par
  399.  
  400.          Description:
  401.              Sets/shows the end of line character KERMITCP6 will
  402.              expect to receive from the remote Kermit.
  403.  
  404.          par:
  405.              may be any ASCII value for a character, given in octal
  406.              Default value = 15 (ASCII CR, CTRL-M)
  407.  
  408.          Examples:
  409.              KERMIT-CP6> SET RECEIVE END-OF-LINE 12
  410.              KERMIT-CP6> SHOW RECEIVE END-OF-LINE
  411.  
  412.  
  413. 6.2.6    SET/SHOW RECEIVE QUOTE par
  414.  
  415.          Description:
  416.              Sets/shows the printable character KermitCP6 expects
  417.              to be prefixed to the control characters of messages sent
  418.              by the remote Kermit.
  419.          par:
  420.              may be any printable character
  421.              Default value = "#" (ASCII 35(dec) )
  422.          NOTE:  Change the quote character to receive remote Kermit
  423.                files with many '#' characters.
  424.          Affect this change by SETting
  425.              the SEND QUOTE parameter of the remote Kermit,
  426.              the SEND QUOTE parameter of CP6 Kermit, and
  427.              the RECEIVE QUOTE parameter of CP6 Kermit to the same value.
  428.          Examples:
  429.              KERMIT-CP6> SHOW SEND  QUOTE
  430.              KERMIT-CP6> SET RECEIVE QUOTE +
  431.              KERMIT-CP6> SET SEND QUOTE +
  432.              KERMIT-IBM> SET SEND QUOTE 43  (The ASCII value of '+' is 43.)
  433.  
  434.  
  435. 6.3    SET/SHOW TRANSMODE par
  436.  
  437.        Description:
  438.             Sets/shows the type of file KERMITCP6 will receive.
  439.  
  440.        par:
  441.            must be one of the following...
  442.                 ASCII  - for text files
  443.                 BINARY - for non-text files
  444.            Default value = ASCII
  445.  
  446.        Examples:
  447.            KERMIT-CP6> SET TRANSMODE BINARY
  448.            KERMIT-CP6> SHOW TRANSMODE
  449.  
  450.  
  451. 6.4    SET/SHOW EIGHT-QUOTE par
  452.  
  453.        Description:
  454.            Sets/shows the character KERMITCP6 will send
  455.            to the remote Kermit as a quote for eight-bit characters.
  456.  
  457.        par:
  458.            may be any printable character
  459.            Default value = "&"  (ASCII 38(dec) )
  460.  
  461.        Examples:
  462.            KERMIT-CP6> SET EIGHT-QUOTE %
  463.            KERMIT-CP6> SHOW EIGHT-QUOTE
  464.  
  465. 6.5    SET/SHOW FILERECORD par
  466.  
  467.          Description:
  468.              Sets/shows the end of line character being used
  469.              to separate records in a file being  sent from CP6
  470.              to the remote Kermit.
  471.  
  472.          par:
  473.              must be one of the following ...
  474.                 CR   - a carriage return
  475.                 LF   - a line feed
  476.                 CRLF  - a carriage return, followed by a linefeed
  477.              Default value = CRLF
  478.  
  479.          SUGGESTED USE:
  480.              SET FILERECORD LF to transmit a PASCAL source to an APPLE IIe.
  481.  
  482.          Examples:
  483.              KERMIT-CP6> SET FILERECORD LF
  484.              KERMIT-CP6> SHOW FILERECORD
  485.  
  486. 6.6    SET/SHOW PARITY par
  487.  
  488.        Description:
  489.            Sets/shows the type of parity being used on the
  490.            the transmission line.
  491.  
  492.        par:
  493.            must be EVEN, ODD, or NONE
  494.            Default value = NONE (others require eight-bit prefixing
  495.                                 for binary files)
  496.        Examples:
  497.            KERMIT-CP6> SET PARITY EVEN
  498.            KERMIT-CP6> SHOW PARITY
  499.  
  500.  
  501.  
  502. 6.7    SET/SHOW DEBUGGING par
  503.  
  504.        Description:
  505.            Sets/shows the state of KermitCP6's debugging
  506.            messages.  When on, messages are sent to the user's terminal.
  507.            Redirect messages to a CP6 file by using an
  508.            IBEX SET command '!SET DEBUGGING fid, CTG=YES'.
  509.  
  510.        par:
  511.            must be ON or OFF
  512.            Default value = OFF
  513.        NOTE:  Debugging is only meaningful for modification of Kermit code.
  514.  
  515.        Examples:
  516.            KERMIT-CP6> SET DEBUGGING ON
  517.            KERMIT-CP6> SHOW DEBUGGING
  518.  
  519.  
  520. 6.8    SHOW SPEED
  521.  
  522.        Description:
  523.            Shows the baud rate of transmission.
  524.  
  525.        NOTE:  SPEED must be SET by the microcomputer Kermit.
  526.  
  527.        Example:
  528.            KERMIT-CP6> SHOW SPEED
  529.  
  530. 6.9    SET/SHOW DELAY par
  531.  
  532.        Description:
  533.            Sets/shows the number of seconds KERMITCP6 will
  534.            wait before sending data following a SEND command.
  535.  
  536.        par:
  537.            may be any positive decimal number, given in seconds
  538.            Default value = 5 seconds
  539.  
  540.        Examples:
  541.            KERMIT-CP6> SET DELAY 25
  542.            KERMIT-CP6> SHOW DELAY
  543.            NOT YET IMPLEMENTED !!
  544.  
  545.  
  546. 7.0    SHOW keyword
  547.  
  548.        Keywords:
  549.          SEND  <option>    (Reference 6.1)
  550.          RECEIVE <option>  (Reference 6.2)
  551.          TRANSMODE         (Reference 6.3)
  552.          EIGHT-QUOTE       (Reference 6.4)
  553.          FILERECORD        (Reference 6.5)
  554.          PARITY            (Reference 6.6)
  555.          DEBUGGING         (Reference 6.7)
  556.          SPEED             (Reference 6.8)
  557.          DELAY             (Reference 6.9)
  558.          ALL
  559.  
  560. 7.1    SHOW ALL
  561.  
  562.        Description:
  563.            Shows the current values of the KermitCP6
  564.            SEND, RECEIVE, and Local System parameters.
  565.  
  566.        Example:
  567.            KERMIT-CP6> SHOW ALL
  568.