home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / znode3 / uploads / z3help43.lbr / CRCBLD.HZP / CRCBLD.HLP
Encoding:
Text File  |  1991-11-03  |  5.3 KB  |  118 lines
  1. ;
  2.                                   CRCBLD.COM                                  
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                3k (18)   04D5  1.4        Gene Pizzetta 9/91       Z3COM3
  6.  
  7.   1- Syntax  2- Configuration  3- Errors  4- Notes                            
  8.  
  9.  
  10.    CRCBLD is a ZCPR3 utility that writes a  SIG/M-type  catalog  and CRC file.
  11. Based on SIG/M's  CRCBUILD  program,  this version  works in any drive or user
  12. and obtains the disk number automatically from the disk  label,  if one exists
  13. in the target directory.
  14. :1
  15.  Syntax   CRCBLD {dir:}{afn.aft}
  16.  
  17.    If no DIR or DU specification is given,  the current  directory is assumed.
  18. If no filename is given, CRCBLD defaults to all files ("*.*").
  19.  
  20.    If a disk label exists in the target directory,  the disk  number  from the
  21. filetype area of that label will be used as the  volume number.   If  no  disk
  22. label is found,  or if the filetype of the label is  non-numeric,  CRCBLD will
  23. prompt for a three-digit number.
  24.  Catalog File - 1/2 
  25.  
  26.    The catalog file (-CATALOG.nnn, where "nnn" is the disk number) is  written
  27. in the target directory.   Each line of the  catalog  file  includes  the disk
  28. volume number, the sequence number of the file, the filename and filetype, the
  29. file's size in kilobytes, and the file's CRC (cyclic redundancy checksum based
  30. on the CCITT standard polynominal:  X^16 + X^15 + X^13 + X^7 + X^4 + X^2 + X +
  31. 1.  For example:
  32.  
  33.      456.01    INTEL   .MAC    9K   5E 6C
  34.      456.02    TEST    .Z80    1K   62 25
  35.      456.03    TVI-CHAR.MAC    2K   FB 32
  36.      456.04    TVI-CSET.Z80    1K   28 E7
  37.      456.05    WS4-TV65.MAC    6K   70 33
  38.      Archival Libraries Volume 456 -- 05 Files Cataloged.
  39.  
  40.    The final line of the file includes a summary  message  ("Archival  Librar-
  41. ies", above), the volume number, and the number of matching files found.
  42.  
  43.    The format of the catalog file is compatible with the  CRCZ utility,  which
  44. can be used to automatically validate the CRC's of the files on the disk.
  45.  Catalog File - 2/2 
  46.  
  47.    The area on each line beyond the CRC is available for comments, if desired,
  48. which can be added with any ASCII text editor:
  49.  
  50.      456.01    INTEL   .MAC    9K   5E 6C  Extended Intel test file
  51.      456.02    TEST    .Z80    1K   62 25  Zilog test file
  52.      456.03    TVI-CHAR.MAC    2K   FB 32  Creates new TVI character
  53.      456.04    TVI-CSET.Z80    1K   28 E7  Displays TVI character set
  54.      456.05    WS4-TV65.MAC    6K   70 33  TVI patch file for WordStar 4
  55.      Archival Libraries Volume 456 -- 05 Files Cataloged.
  56.  
  57.    DateStamper !!!TIME&.DAT files  are ignored,  as are temporary files with a
  58. dollar sign in their filetype.   Whether system files are included  or ignored
  59. is a configurable option.  As distributed, CRCBLD includes system files.
  60. :2
  61.  Configuration 
  62.  
  63.   The tag character for your disk labels and whether CRCBLD finds system files
  64. are  configurable  options that can be set  using  ZCNFG  and the accompanying
  65. CRCBLDnn.CFG file.
  66.  
  67.    The summary message ("Archival Libraries" in the example above) can also be
  68. set to anything your heart desires, up to 30 characters.  This message must be
  69. changed using a file patching utility,  such as ZPATCH.   The patch area is in
  70. the first of the CRCBLD.COM file and is delimited by "-->"  and "<--" markers.
  71. The string must be terminated by a null character (binary zero).
  72. :3
  73.  Errors 
  74.  
  75.    The program error flag will be set on exit to standard error codes as found
  76. in Z34ERR.LIB.  On error, the error handler will also be invoked.
  77. :4
  78.  Notes 
  79.  
  80.    a. Vs 1.4 updates (09/30/91, Gene Pizzetta):
  81.       - Made summary message configurable.  
  82.       - Did a lot of code tweeking.  
  83.       - Now sets program error flag and invokes error handler on error.  
  84.       - Added documentation file.  
  85.       - Minor changes to configuration file.
  86.  
  87.    b. Vs 1.3 updates (04/06/91, Gene Pizzetta):
  88.       - Now accepts DU spec for target directory.  
  89.       - Looks for disk label with number in  filetype.   If disk label exists,
  90.         number from its filetype is used.   If no  disk label is  found,  asks
  91.         user for disk number.  
  92.       - Converted from absolute to linked  assembly,  and from  Intel to Zilog
  93.         mnemonics.  
  94.       - Added library routines.  
  95.       - Added internal editor and tab expansion.  
  96.       - Now uses BIOS for console I/O.  
  97.       - Eliminated much redundant and unused code.  
  98.       - Tag character for disk  label  and  whether  system  files  should  be
  99.         included are configurable with ZCNFG. 
  100.  Notes - 2/ 
  101.  
  102.       - Program name changed to CRCBLD from CRCBUILD.  
  103.       - DateStamper TIME&.DAT files are now ignored.
  104.  
  105.    c. Vs 1.2 updates (03/31/90, Gene Pizzetta):
  106.       - Modified to ignore system files.  
  107.       - File size routine now handles files larger than 255K.  
  108.       - This version runs only on Z80 or compatible machine.
  109.  
  110.    d. Vs 1.1 updates (04/15/89, Gene Pizzetta):
  111.       - Modified messages for achival libraries.
  112.  
  113.    e. Vs 1.0 (04/08/83, John L. Raff WB2MDG/KAPP8107):
  114.       - A program to build a CP/M file in  SIG/M  -CATALOG format and  print a
  115.         cyclic-redundancy check number based on the  CCITT  standard  polynom-
  116.         inal: X^16 + X^15 + X^13 + X^7 + X^4 + X^2 + X + 1
  117.  
  118.