home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / d / aatape.hlp < prev    next >
Text File  |  2020-01-01  |  13KB  |  279 lines
  1. AATAPE.HLP                                                          June 1991
  2.  
  3.                     COLUMBIA UNIVERSITY KERMIT DISTRIBUTION
  4.  
  5.  
  6. The complete Kermit is divided into five reels of 9-track magnetic tape, Tapes
  7. A through E.  Tape A contains Kermit versions for the more popular PCs
  8. (MS-DOS, CP/M, Apple II, Commodore 64, etc), Tape B for the more popular
  9. workstations, minis, and mainframes (DEC operating systems, IBM mainframes,
  10. UNIX, etc), Tape C for less popular PCs, Tape D for less popular minis and
  11. mainframes, and Tape E for online documentation plus utilitity programs
  12. (including programs for reading tapes).  See the file AAFILES.HLP for an
  13. explanation of where the files are and what they're called.
  14.  
  15. All tapes are 9-track, 1600 bpi, odd parity, 2400-foot half-inch reels.
  16. Blocksize is marked on the external label, and will be between 2K and 10K
  17. depending upon various factors.
  18.  
  19. Your tape is in one of the following formats, as you requested.  The format
  20. should be clearly marked on the external label.
  21.  
  22. ANSI -- ANSI standard label, volume label KERMIT, ASCII encoding, format D,
  23.   variable length records.  Readable by most computer systems, should be
  24.   readable by all since it's a national standard format.  On VAX/VMS, readable
  25.   with the DCL COPY command. The ANSI tape format is described in detail below.
  26.  
  27. OS -- IBM OS standard label, volume label KERMIT, EBCDIC encoding, format
  28.   VB, variable length records.  Format described in detail below.  First file
  29.   on OS tapes is a 370 assembly program to read OS tapes under CMS.
  30.   For MVS, use JCL.
  31.  
  32. TAR -- Unix Tar format, 10K blocksize.  This format is used by Unix computers
  33.   only.
  34.  
  35. All formats contain only "printable" files -- program source, binaries in
  36. "hex" or other printably-encoded format along with conversion programs,
  37. documentation, etc.
  38.  
  39. Each Kermit distribution tape, A-E, comes with a directory listing showing
  40. names of all the files that are on it, in the order in which they appear on
  41. the tape.  In addition, the file AAFILES.HLP lists the files and gives a
  42. fuller explanation of the naming conventions, and some information about the
  43. various Kermit implementations.
  44.  
  45. ANSI and OS are the two formats most commonly used for exchanging information
  46. on tape between unlike systems.  These formats are now described in some
  47. detail; in case you don't have a utility handy to read your ANSI or OS tape,
  48. the following information should be sufficient to allow a programmer to write a
  49. procedure to get the information from the tape.
  50.  
  51. - ANSI LABELED TAPES -
  52.  
  53. All systems are supposed to be able to read ANSI labeled tapes, which,
  54. according to ANSI standard X3.27-1978: "Magnetic Tape Labels and File
  55. Structure for Information Exchange", should be the universal medium for
  56. exchange between mainframe computers.  Our tape is written on any of several
  57. types of computers, including a VAX with Unix (using an ANSI tape-writing
  58. utility) or a VAX with VMS (using the COPY command), and conform to the ANSI
  59. standard, level 3.  The tape is written as follows:
  60.  
  61.               Tracks:  9
  62.              Density:  1600 bits per inch
  63.               Parity:  Odd
  64.   Character Encoding:  ASCII (ANSI X3.4-1968)
  65.         Block Length:  8192 (unless indicated otherwise on external label)
  66.  
  67. ANSI labels (each label is an 80-byte record, encoded in ASCII):
  68.  
  69. Each label begins with a 4-character identifier, like VOL1, HDR1, EOV1, etc.
  70. - Volume label  (VOL1): Volume name is KERMIT, in character positions 5-10.
  71.     The volume label appears only at the beginning of the tape.
  72. - File Header 1 (HDR1): File name is in character positions 5-21.
  73. - File Header 2 (HDR2): Record Format (F, D, or S) in 5 (it's always "D"),
  74.                         Block length in 6-10, ASCII numeric, leading 0's.
  75.                         Record length in 11-15, ditto.
  76.   After HDR1 and HDR2 comes a single tape mark (tm) then the contents of the
  77.   file, terminated by another tm.  The (HDR1, HDR2, tm, file data, tm) sequence
  78.   is repeated for each file.  At the end of file, there may be EOF1 and EOF2
  79.   labels followed by a tm; if present, they may be ignored.
  80.  
  81. - At the end of tape may be EOV1 and EOV2 labels to indicate end of volume.
  82.   There is a double tape mark at the end of the tape.
  83.  
  84. Record Format: "D" -- variable length records with a 4-digit ASCII length field
  85.   at the beginning of each record (the length includes the length field
  86.   itself), line terminators stripped, and no record crossing a block boundary.
  87.   The record may be padded at the end with 0 to 3 circumflex characters,
  88.   which are NOT included in the length field.  A null record ("blank line")
  89.   is indicated by "0004" followed immediately by the length field of the
  90.   next line.  "F" (fixed length record) format, although simpler to read, is
  91.   not used because the Kermit distribution will not fit on a 2400-foot
  92.   fixed-block tape because of the space wasted by padding each record with
  93.   blanks.  Only printable files (text, program source, text formatter source,
  94.   or hex) are included on this tape. 
  95.  
  96. Record Length:  Variable, max 800 (no lines of text in Kermit distribution
  97.   files are more than 800 characters long; very few are longer than 200).
  98.  
  99. Block length: Since 8192 is longer than the normal block length on some
  100. systems, you may need special procedures to read the tape.  For instance, on
  101. VAX/VMS, you must "MOUNT/BLOCK=8192/DENSITY=1600 MTA0: KERMIT" (not /FOREIGN).
  102.  
  103. DEC PDP-11s may have trouble with these tapes.  RT-11 doesn't support them.
  104. In RSTS, MOUNT MM0:/FOR=ANS KERMIT (or ASSIGN MM0:.ANSI), and use PIP to read.
  105. In RSX, MOU MM0:/OV=ID and use PIP to read.  In both RSTS and RSX, you may
  106. have to extend PIP's buffer size:
  107.   RSTS: $ def/com/sys pip lb:[1,2]pip.sav/lin=8228, $ pip sy:=mm0:k11???.*
  108.   RSX:  >rem ...pip, >ins $pip/inc=50000, >pip sy:=mm0:k11*.*
  109. Decode K11*.HEX files on RSTS with K11HEX.FTN or K11HEX.B2S, not K11HEX.BAS.
  110.  
  111. - OS STANDARD LABELED TAPES -
  112.  
  113. The tape is written on either a SUN 4/280 running Unix, using a local utility,
  114. or an IBM 370-Series machine running VM/CMS, using MOVEFILE.  The tape may be
  115. read on IBM OS or MVS systems using normal JCL procedures.  The tape may be
  116. read on CMS using the program provided as the first file on the tape.
  117.  
  118. The tape is written as follows:
  119.  
  120. Tracks:   9
  121. Density:  1600 bits per inch
  122. Parity:   Odd
  123.  
  124. Character Encoding:  EBCDIC
  125.  
  126. Labels (each label is an 80-byte record, encoded in EBCDIC):
  127. Each label begins with a 4-character identifier, like VOL1, HDR1, EOV1, etc.
  128.   Volume label  (VOL1): Volume name is KERMIT, in character positions 5-10.
  129.     The volume label appears only at the beginning of the tape.
  130.   File Header 1 (HDR1): File name is in character positions 5-21.
  131.   File Header 2 (HDR2): Record Format in 5 (it's always "V"),
  132.                         Block length in 6-10, printable EBCDIC digits,
  133.                       filled to 5 columns with leading zeroes.
  134.                         Record length in 11-15, printable EBCDIC digits,
  135.                       filled with leading zeroes.
  136.             Blocking attribute in 39 (always "B").
  137.   After HDR1 and HDR2 comes a single tape mark (tm) then the contents
  138.   of the file, terminated by another tm.  Finally, there are EOF1 and
  139.   EOF2 labels, also terminated by a tm.  The (HDR1, HDR2, tm, file
  140.   data, tm, EOF1, EOF2, tm) sequence is repeated for each file.
  141.  
  142.   At the end of the tape there is a double tape mark.
  143.  
  144. Block Format: "B" -- Each block begins with a 4-byte length field (the
  145.   length includes the block length field) which is the actual length
  146.   of the block.  The length field is encoded as two binary bytes (high
  147.   order byte first) followed by two zero bytes.  Following the length
  148.   are as many records as will fit in the block; no record spans
  149.   multiple blocks.
  150.  
  151. Record Format: "V" -- variable length records with a 4-byte length field
  152.   at the beginning of each record (the length includes the length
  153.   field itself), line terminators stripped, and no record crossing a
  154.   block boundary.  The length field is encoded the same was as the
  155.   block length field, above.  "F" (fixed length record) format,
  156.   although simpler to read, is not used because the Kermit
  157.   distribution will not fit on a 2400-foot fixed-block tape because of
  158.   the space wasted by padding each record with blanks.
  159.  
  160. Record Length: Variable, maximum 800 bytes. (No lines of text or program
  161.   source in the Kermit distribution are more than 800 characters long,
  162.   indeed very few are more than 200.  All of the Kermit-370 files are 80
  163.   bytes long.)
  164.  
  165. Block Length:  Maximum of 8192 bytes.
  166.  
  167. Only printable files (text, program source, text formatter source, or hex) are
  168. included on this tape.
  169.  
  170. JCL FOR READING AN OS-FORMAT KERMIT TAPE ON AN IBM MAINFRAME:
  171.  
  172. Use this template for the JCL.  It must be replicated for each tape file
  173. to be read:
  174.  
  175. //  EXEC  PGM=IEBGENER
  176. //SYSPRINT DD  SYSOUT=A
  177. //SYSIN    DD  DUMMY
  178. //SYSUT1   DD  DSN=tapefilename,
  179. //             UNIT=tapeunit,VOL=SER=tapevol,DISP=SHR,
  180. //             LABEL=(filenum,SL,,IN)
  181. //SYSUT2   DD  DSN=diskfilename,
  182. //             UNIT=diskunit,VOL=SER=diskvol,DISP=(NEW,CATLG),
  183. //             SPACE=(TRK,(20,20),RLSE)
  184.  
  185. where:
  186.  
  187.    "tapefilename" is the name of the data set on the tape
  188.    "tapeunit"     is the installation's unit name for a tape drive
  189.    "tapevol"      is the volume serial number of the tape
  190.    "filenum"      is the sequence number of the data set on the tape
  191.  
  192.    "diskfilename" is the name the data set is to be on disk
  193.    "diskunit"     is the installation's unit name for disk drives
  194.    "diskvol"      is the volume serial number of the disk, if needed
  195.  
  196. For example, if the file IKTKER.INS (TSO Kermit installation instructions) is
  197. the 176th file on tape B, which (like all Kermit tapes) has the volume label
  198. KERMIT, the following JCL would read this file (you still have to fill in the
  199. tapeunit, diskunit, and diskvol parameters appropriate to your site):
  200.  
  201. //  EXEC  PGM=IEBGENER
  202. //SYSPRINT DD  SYSOUT=A
  203. //SYSIN    DD  DUMMY
  204. //SYSUT1   DD  DSN=IKTKER.INS,
  205. //             UNIT=tapeunit,VOL=SER=KERMIT,DISP=SHR,
  206. //             LABEL=(176,SL,,IN)
  207. //SYSUT2   DD  DSN=IKTKER.INS,
  208. //             UNIT=diskunit,VOL=SER=diskvol,DISP=(NEW,CATLG),
  209. //             SPACE=(TRK,(20,20),RLSE)
  210.  
  211. READING OS-FORMAT TAPES UNDER VM/CMS
  212.  
  213. CMS does not come equipped with a utility to read groups of files from an
  214. OS-format tape.  OS-format Kermit distribution tapes contain two such
  215. utilities as the first two files on the tape.  Use CMS TAPE, FILEDEF, and
  216. MOVEFILE commands to read these files from the tape, then use them to read the
  217. other files automatically.
  218.  
  219. Method 1: VM version 4 or later.  Use the REXX Exec OSTAPE EXEC (the second
  220. file on your OS-format tape).  This program can read groups of files
  221. selectively from the tape.  Instructions for use are in comments at the top of
  222. the OSTAPE EXEC.  OSTAPE EXEC was written by Bob Meizlik of Pan American World
  223. Airways, Rockleigh, NJ, USA, December 1990.
  224.  
  225. To copy this program from tape to a CMS disk, issue the following commands:
  226.  
  227.       TAPE REW
  228.       TAPE FSF
  229.       FILEDEF  INMOVE TAP1 (RECFM VB LRECL 800 BLOCK 8192)
  230.       FILEDEF OUTMOVE DISK OSTAPE EXEC A (RECFM VB LRECL 100)
  231.       MOVEFILE
  232.  
  233. Then, to clear the FILEDEF's before you run the exec, say:
  234.  
  235.       FILEDEF * CLEAR
  236.  
  237. Method 2: Any version of VM.  Use the assembly language program SPROSC
  238. ASSEMBLE, provided as the first file on the OS format tapes, to read selected
  239. files from the tape.  CMS style help is included at the beginning of the file.
  240.  
  241. To copy this program from tape to a CMS disk, issue the following commands:
  242.  
  243.       TAPE REW
  244.       TAPE FSF
  245.       TAPE FSF
  246.       FILEDEF  INMOVE TAP1 (RECFM VB LRECL 80 BLOCK 8160)
  247.       FILEDEF OUTMOVE DISK SPROSC ASSEMBLE A (RECFM VB LRECL 100)
  248.       MOVEFILE
  249.       COPYFILE SPROSC ASSEMBLE A (RECFM F LRECL 80)
  250.  
  251. To generate this program enter the following CMS commands:
  252.  
  253.       ASSEMBLE SPROSC
  254.       LOAD SPROSC
  255.       GENMOD SPROSC
  256.       NUCXLOAD SPROSC
  257.  
  258. You should now have a runnable module called SPROSC.  To install the files,
  259. the installation tape must be attached as 181, which might look something
  260. like the following (note that the method for mounting tapes is
  261. site-dependent):
  262.  
  263.       SMSG BATCH SETUP NOTAPE
  264. or
  265.       SMSG BATCH SETUP VOL KERMCO NORING SECOND
  266.  
  267. Once you have the tape attached as 181 or TAP1, the following is an example
  268. of correct syntax:
  269.  
  270.       SPROSC TAP1 = = (EOF 217 PREFIX IK
  271.  
  272. This command will load all files with names beginning "IK" from among the
  273. next 217 files on tape 181.  If the tape is ANSI, the files will be
  274. translated into EBCDIC.  If the tape is not labeled, SPROSC will halt.
  275.  
  276.  
  277. [End of AATAPE.HLP]
  278.  
  279.