home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / music / imusicdoc.txt < prev   
Text File  |  2020-01-01  |  13KB  |  287 lines
  1. 1
  2.             Indiana University - Purdue University in Indianopolis
  3.  
  4.                          IUPUI MUSIC-KERMIT USERS GUIDE
  5.  
  6.        (MUSIC is the McGill University System for Interactive Computing,
  7.          a timesharing system for IBM 370-series mainframe computers.)
  8.  
  9.        Kermit is a protocol for reliable file transfer between computers.
  10.     The version of Kermit which runs on MUSIC (MUSIC-Kermit) may be used
  11.     in conjunction with Kermit on an IBM PC to transfer files between the
  12.     PC and MUSIC.  Data and other information is passed back and forth in
  13.     small units called packets.  Each packet has a specific format which
  14.     includes check data to help insure that the data transfer is correct.
  15.     MUSIC-Kermit can currently transfer only character data.  Binary files
  16.     will not be transferred correctly.  Files to be transferred may have a
  17.     fixed or variable record format, and the logical record length may be
  18.     up to 256 characters long.
  19.         Listed below are the commands which MUSIC-Kermit accepts, the error
  20.     messages which may be issued, and a section on how to run MUSIC-Kermit.
  21.     For more information on Kermit, see the Kermit Users Guide, Fourth
  22.     Edition.
  23.  
  24.  
  25.  
  26.     MUSIC-KERMIT COMMANDS
  27.     _____________________
  28.          The commands for MUSIC-Kermit are listed below.  All commands may
  29.     be abbreviated to 3 characters.  A description of a command may be
  30.     obatined by entering the commaned followed by a ' ?'.
  31.  
  32.     RECEIVE (filename)
  33.          The receive command is used to tell MUSIC-Kermit that a file will
  34.     be sent to it. The filename is optional.  If given, the file being
  35.     received by MUSIC will be stored under the file name specified.  If not,
  36.     it will be stored under the name sent to MUSIC from PC-Kermit.  MUSIC
  37.     file names can be up to 17 characters long. The characters may be
  38.     alpha-numeric, '.', '$', '#', or '@'.  The first character may not be a
  39.     '#' or '$'.  If an invalid file name is sent to MUSIC-Kermit, an error
  40.     packet will be sent back to the PC.
  41.  
  42.     SENd filename1 (filename2)
  43.          The send command is used to send a MUSIC file to the PC.  Filename1
  44.     is the MUSIC name of the file to be sent.  The file name is put in the
  45.     File Packet and sent to the PC-Kermit before the file.  PC-Kermit may
  46.     alter the name to fit it's naming conventions.  Filename2 is optional.
  47.     If specified, it is put into the File Packet and sent to the PC instead
  48.     of the MUSIC file name (filename1).  Filename2 will then be the name of
  49.     the file on the PC after it is sent.
  50.  
  51.     HELP
  52.          Help lists all the available commands with a brief summary of each.
  53.  
  54.     STATUS
  55.          The STATUS command gives the completion status of the previous
  56.     MUSIC-Kermit command.  After a SEND or RECEIVE has been issued, the
  57.     user generally goes back to PC-Kermit and issues the opposite command
  58.     there.  If an error occurs during the file transfer, the PC user can
  59.     re-connect to MUSIC-Kermit and issue a STATUS to find out what error
  60.     occurred on the MUSIC side.
  61. 1
  62.  
  63.     SET
  64.          The SET command is used to set the following parameters:
  65.               RECFM   The record format for files being received by
  66.                       MUSIC-Kermit.  It may be set to V (variable),
  67.                       VC (variable compressed), F (fixed), or FC (fixed
  68.                       compressed).  FC is the default.
  69.               EOL     The end-of-line character that the PC should send
  70.                       to MUSIC-Kermit.  The default is a carriage return,
  71.                       x'0D'.
  72.               QUOTE   The quote character which MUSIC-Kermit should use
  73.                       to send control characters.  The default is #.
  74.               LRECL   The logical record length for files being received by
  75.                       MUSIC-Kermit.  The value may be from 1 - 256.  80 is
  76.                       the default.
  77.               PACKET  The packet size that the PC should send to MUSIC. It
  78.                       must be between 26 - 94.  The default is 94.
  79.               DELAY   The delay time is the number of seconds that MUSIC-
  80.                       Kermit waits after a SEND command before sending the
  81.                       first packet to the PC.  This allows the user time
  82.                       to return to PC-Kermit and issue a RECEIVE command.
  83.                       The value must be between 0 - 99.  The default is 15.
  84.               RETRY   The retry count is the number of times that MUSIC-
  85.                       Kermit will try to re-send a packet to the PC if there
  86.                       is an error in the transmission.  The value must be
  87.                       from 0 to 100.  The default is 5.
  88.               SERIES1 The type of connection to the mainframe running MUSIC.
  89.                       If the terminal is connected through a SERIES/1 or
  90.                       7171 protocol converter, this should be set ON other-
  91.                       wise it should be set OFF.  The default is OFF.
  92.  
  93.     SHOW
  94.          The SHOW command will display the current value of any of the
  95.     parameters listed under the SET command.
  96.  
  97.     EXIT or QUIT
  98.          The EXIT or QUIT commands will cause MUSIC-Kermit to end and
  99.     the user will be returned to MUSIC.
  100.  
  101.  
  102.  
  103.     MUSIC-KERMIT ERROR MESSAGES
  104.     ---------------------------
  105.          MUSIC-Kermit may issue the following error messages during
  106.     transmission of a file after a SEND or RECEIVE command:
  107.  
  108.     1. 'Bad send packet size' The packet size being sent to or from MUSIC
  109.                               was less than 26 or greater than the maximum
  110.                               allowed size.  Re-start the transmission.
  111.     2. 'Bad message number'   The message number in the last packet read
  112.                               by MUSIC-Kermit was not a valid number.
  113.                               Re-start the transmission.
  114.     3. 'Unrecognozed state'   MUSIC-Kermit had an error.  Contact
  115.                               technical services.
  116.     4. 'No SOH encountered'   All packets must start with an SOH (Start Of
  117.                               Header).  The last data read contained no SOH.
  118.                               Re-start the transmission.
  119.     5. 'Bad character count'  The character count in the packet header is
  120.                               bad.  Re-start the transmission.
  121.     6. 'Bad checksum'         The checksum from the receive side did not
  122.                               match the one that was sent.  This indicates
  123.                               that the data did not transmit correctly.
  124.                               This error should only occur after the
  125.                               transmission retry count is exceeded.
  126.                               Re-start the transmission.
  127. 1
  128.  
  129.     7. 'Illegal packet type'  The packet type in the packet header is
  130.                               invalid.  Re-start the transmission.
  131.     8. 'Lost a packet'        The message number in the packet indicates
  132.                               that a whole packet was lost during
  133.                               transmission.  Re-start.
  134.     9. 'Micro sent a NAK'     The micro received a bad packet from MUSIC
  135.                               and returned a NAK.  This type of error must
  136.                               be examined on the PC side.
  137.     10.'Micro aborted'        The micro sent an error packet to MUSIC-
  138.                               Kermit.  Check the PC side to determine what
  139.                               kind of error occurred.
  140.     11.'Illegal file name'    A file packet was received by MUSIC-Kermit
  141.                               which contained no file name.  Re-start.
  142.  
  143.          The error messages which may occur when MUSIC-Kermit is reading
  144.     or writing a file are listed in the MUSIC User's GuIde under the
  145.     section, Dynamic Access to Save Library Files.  These errors would occur
  146.     after a SEND or RECEIVE command.  Some of the more common ones are
  147.     listed below.
  148.  
  149.     1.  'File name invalid'   If a filename was entered on a SEND or RECEIVE
  150.                               command, the name was invalid to MUSIC.  Re-
  151.                               issue the command with a valid filename.  If
  152.                               no filename was specified on a RECEIVE, then
  153.                               the PC sent a filename which is invalid.
  154.                               Use a 'RECEIVE filename' command to give
  155.                               MUSIC a valid filename.
  156.     2.  'Data set not found'  The filename specified in a SEND command does
  157.                               not exist.  Re-issue the command with the
  158.                               correct file name.
  159.     3.  'File already exists' A file already exists with the same name as
  160.                               the one being received.  Re-issue the RECEIVE
  161.                               command and specify a new filename, or rename
  162.                               the old file.
  163.     4.  'Space quota exceeded  The file being sent is too large.  Try to
  164.          for this file'       send several smaller files instead of one
  165.                               large one.
  166.  
  167.          The following error messages may be issued after the SET command.
  168.  
  169.     1. 'Illegal SET command'     The parameter specified after SET was not a
  170.                                  valid parameter.
  171.     2. 'Error in record format.  Either an invalid parameter or no parameter
  172.         F,FC,V,VC allowed.'      was specified after SET RECFM.
  173.     3. 'No record length given.  No parameter was specified after SET LRECL.
  174.         Re-specify.'
  175.     4. 'LRECL must be a number   An invalid value was given for LRECL.
  176.         from 0 to 256.'
  177.     5. 'No End-of-Line           No parameter was specified after SET EOL.
  178.         character specified.'
  179.     6. 'Must be a 2 digit value  The EOL value specified was invalid.
  180.         less than 31 (decimal).'
  181.     7. 'No receive packet        No parameter was specified after SET PACKET
  182.         size specified.'
  183.     8. 'Bad packet size - must   An invalid packet size was given.
  184.         be between 26-94
  185.         (decimal).'
  186.     9. 'The delay time cannot    No parameter was specified after SET DELAY.
  187.         be blank.  Re-specify.'
  188. 1
  189.  
  190.     10.'Delay must be a number   An invalid number was given for DELAY.
  191.         from 0-120.'
  192.     11.'No retry count given.    No parameter was specified after SET RETRY.
  193.         Re-specify.'
  194.     12.'RETRY count must be a    The RETRY count specified was invalid.
  195.         number from 0-100.'
  196.     13.'Quote character          No parameter was specified after SET QUOTE.
  197.         cannot be a blank.
  198.         Re-specify.'
  199.     14.'Must fall between        An invalid character was given for the
  200.         41-76,140, or 173-176    QUOTE control character.
  201.         (octal).
  202.  
  203.  
  204.     HOW TO USE MUSIC-KERMIT at IUPUI
  205.     --------------------------------
  206.  
  207.     System        Action                     Comments
  208.     ------        ------                     --------
  209.     PC            A. Execute KERMIT.
  210.  
  211.     PC_Kermit     B. SET BAUD XXXX           (if not 1200)
  212.                   C. SET IBM ON
  213.                   D. Connect
  214.  
  215.                   E. Dial the IUPUI network: 634-7041
  216.  
  217.     DCA           F. 0 (for MUSIC0) or 1 (for MUSIC1)
  218.  
  219.     MUSIC         G. /ID MusicId
  220.                   H. Password
  221.                   I. KERMIT
  222.  
  223.     MUSIC_Kermit  J. Set options if needed.
  224.                      Type  SET ?  for a list
  225.                      of options.
  226.                   K. Enter a Kermit command.
  227.                          RECEIVE                  Receive a file from the PC.
  228.                          RECEIVE FILENAME         Receive a file and store it
  229.                                                   under the name FILENAME.
  230.                          SEND FILENAME            Send a MUSIC file to the PC.
  231.                   L. CNTL-] C                     Return to PC-Kermit.
  232.  
  233.     PC-Kermit     M. Enter a Kermit command.
  234.                          RECEIVE                  Receive a file from MUSIC.
  235.                          SEND FILENAME            Send a PC file to MUSIC.
  236.  
  237.                   N. Wait for file to be transferred!
  238.  
  239.                   O. Connect                      Return to MUSIC-Kermit.
  240.  
  241.     MUSIC-Kermit  P. If more files are to be sent
  242.                      or received, go to Step J.
  243.                   Q. EXIT
  244.  
  245.     MUSIC         R. /OFF
  246.     DCA           S. CNTL-] C                     Return to PC-Kermit.
  247.     PC-Kermit     T. EXIT
  248. 1
  249.  Installation instructions:
  250.  
  251.  To assemble:
  252.  
  253.  /FILE SYSPUNCH NAME(KERMIT.OBJ) NEW(REPLACE)
  254.  /SYS NOPRINT,TIME=MAX
  255.  /FILE SOURCE PDS(*.S) DEF
  256.  /FILE SYSLIB PDS($MCC:*.M,$MCM:*.VV.M,$MCM:*.M) DEF
  257.  /FILE SYSUT1 N(&&TEMP) NEW DELETE RECFM(V) SP(300) DEF
  258.  /FILE SYSUT2 N(&&TEMP) NEW DELETE RECFM(V) SP(300) DEF
  259.  /FILE SYSUT3 N(&&TEMP) NEW DELETE RECFM(V) SP(300) DEF
  260.  /FILE SYSPRINT NAME(KERMIT.LISTING) NEW(REPL) LRECL(133) SPACE(100)
  261.  /LOAD ASM
  262.  /JOB NOGO
  263.  
  264.  To linkedit:
  265.  
  266.  /FILE LMOD N(KERMIT.LMOD) NEW(REPLACE)  PUBL SP(100)
  267.  /LOAD LKED
  268.  /JOB MAP,NOGO,PRINT,STATS,NAME=KERMIT
  269.  /INCLUDE KERMIT.OBJ
  270.  
  271.  To exec:
  272.  
  273.  /SYS TIME=MAX,REG=500
  274.  /FILE 5 RDR
  275.  /FILE SYSTERM  TERM
  276.  /FILE LMOD NAME(KERMIT.LMOD) SHR
  277.  /LOAD EXEC
  278.  KERMIT LMOD
  279.  
  280.  Further information:
  281.  
  282.  Marie Schriefer
  283.  Computing Services - IUPUI
  284.  799 W. Michigan Street, Room 1023
  285.  Indianapolis, Indiana  46202
  286.  317-264-2983
  287.