home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 138.lha / Iff_Archiver / README < prev    next >
Encoding:
Text File  |  1986-11-20  |  5.7 KB  |  170 lines
  1. iffar - IFF CAT Archiver, Release 1.2, 5/9/88
  2.  
  3. Written by: 
  4.  
  5.     Karl Lehenbauer
  6.     3918 Panorama
  7.     Missouri City, TX  77459
  8.     usenet:  ..uunet!nuchat!sugar!karl  or  ..bellcore!tness7!sugar!karl
  9.     BIX: kelehen
  10.  
  11. All liability is disclaimed!  This code is free.  We do not have a contract.
  12.  
  13. This software, source and binary, is released to the public domain, 5/9/88.
  14.  
  15. I ask that you retain my name as the original author in the source and
  16. documentation if you redistribute this and that I be credited in the user 
  17. manual if iffar is redistributed with a commercial product.
  18.  
  19. Regards,  Karl Lehenbauer @ The Hacker's Haven,  Missouri City, Texas, 5/9/88
  20.  
  21. ---------------------------------------------------------------------
  22.  
  23. NAME
  24.  
  25.     iffar - IFF CAT archiver
  26.  
  27. SYNOPSIS
  28.  
  29.     iffar option [posname] archive_file [IFF_file] ...
  30.  
  31. DESCRIPTION
  32.  
  33.     Iffar maintains archives of Interchange File Format (IFF) FORM, CAT 
  34.     and LIST  files in a manner  that complies with the IFF CAT specification.
  35.  
  36.     IFF CAT archives should be portable to different machines.  No promises.
  37.  
  38.     The option string must start with 'd', 'q', 'r', 't' or 'x' and may
  39.     additionally have modifiers of 'a', 'b', 'c', 'i' or 'v'.  Not all
  40.     modifiers are valid with all options.
  41.  
  42.     The options are:
  43.  
  44.         'd'        Delete named IFF files from the CAT archive.
  45.  
  46.         'q'        Quickly append named IFF files to the CAT archive.
  47.  
  48.         'r'        Replace named IFF files in the CAT archive; append new ones.
  49.  
  50.         't'        Print a table of contents of the CAT archive.
  51.  
  52.         'x'        Extract named IFF files from the CAT archive.
  53.                 If no names are specified, all files are extracted.
  54.  
  55.  
  56.     The modifiers are:
  57.         'a'        "after", replace or append IFF files after entry in CAT
  58.                     archive named by posname 
  59.  
  60.         'b'        "before", replace or append IFF files before entry in CAT
  61.                     archive named by posname
  62.  
  63.         'c'        Do not print a message indicating archive is being created
  64.                     when it must be created.
  65.  
  66.         'i'        a synonym for "before"
  67.  
  68.         'v'        print verbose description of all activity
  69.                 For table of contents, prints IDs, and
  70.                 lengths of chunks within the IFF file chunks
  71.                 in the CAT archive.  It prints the contents of
  72.                 chunks that it knows to be textual and short.
  73.  
  74.  
  75.     On all operations that modify the archive, except for "quick append",
  76.     the archive will be renamed with a ".old" extension and a new archive
  77.     will be created.
  78.  
  79.     The "quick append" option causes the named files to be added to the
  80.     end of the archive without rewriting the archive or looking to see
  81.     if the entry already exists.  This is to avoid quadratic behavior
  82.     when building up an archive one or just a few entries at a time.
  83.  
  84.     Wildcards of the semi-Unix-type as supplied by Manx are provided.
  85.  
  86.     Only the basename of the specified IFF filenames will be used for
  87.     element names within the archive.  In other words, pathnames are
  88.     stripped from filenames to create the archive element name.
  89.     This is also true for extracts.  
  90.     
  91. EXAMPLES
  92.  
  93.     iffar x foo ram:t/bar
  94.  
  95.         would extract element "bar" from archive "foo" into file 
  96.         "ram:t/bar"
  97.         
  98.     iffar ra sounds Cabasa dh0:sounds/Snare
  99.     
  100.         would replace a FORM, CAT or LIST named Snare in the 
  101.         archive with dh0:sounds/Snare, placing Snare directly 
  102.         after Cabasa.  If Cabasa is not found in the archive,
  103.         Snare is placed at the end.
  104.  
  105. BUGS
  106.  
  107.     The archive will be corrupted if a write error (including
  108.     running out of disk space) occurs during "quick 
  109.     append" mode and there won't be a ".old" backup file.
  110.  
  111.     Running out of disk space leaves corrupted archives.
  112.     For all options but "q" the ".old" backup file will contain
  113.     the archive in its state prior to the run that blew it up.
  114.     The program should delete the corrupted archive and restore 
  115.     the ".old" file, but it doesn't.
  116.  
  117. IMPLEMENTATION NOTES
  118.  
  119.     Iffar is written to run under Manx Aztec C 3.6a for the Amiga
  120.     under AmigaDOS version 1.2.
  121.  
  122.     My IFF archiving routines were written to be well-behaved from an 
  123.     IFF point of view; that is, they try to respect the virtual 
  124.     end-of-file defined by the size field of a chunk's header when 
  125.     diving through the chunk's subchunks.  It makes for more work to use
  126.     the routines, but adds some certainty that the program is working
  127.     properly.  I don't know.  The IFF spec requests that we do, so I do.
  128.  
  129.     Note that when converting your code to use a CAT file instead of
  130.     reading several FORM files (it's about twice as fast for an
  131.     application of mine involving about 25 files from two to ten
  132.     kilobytes each, reading them in from floppy.), your code needs 
  133.     to either be driven by the files  read from the CAT (you search 
  134.     a list of names you're looking for when you see a FORM and load 
  135.     what you want) or your code has to know what's coming from the 
  136.     CAT specifically.  I'd prefer that you do the former, of course.
  137.     The table of contents routines (toc.c) provide a reasonable template 
  138.     for your CAT-reading application.
  139.  
  140. NOTES FOR THOSE WISHING TO PORT THE ARCHIVER
  141.  
  142.     Knock yourselves out.  The code is written using standard C library
  143.     calls, with the exception of calls to "scdir", which Manx uses as
  144.     a means of expanding wildcards.  If you get it to work on a different
  145.     system, such as Unix System/V, please send me a copy, preferably
  146.     with #ifdefs so the Manx stuff still works.  Ultimately, I think an
  147.     alternative "_main" startup routine should be written for the Amiga
  148.     that expands wildcards inline to provide an argc and argv as they
  149.     would look on Unix after the shell had expanded all the wildcards.
  150.  
  151.  
  152. REVISION HISTORY
  153.  
  154. 4/25/88, version 1.1
  155.  
  156.     Initial version - never distributed, as far as I know
  157.  
  158. 5/9/88, version 1.2
  159.  
  160.     Made 'r' (replace) option create the archive if it isn't there.
  161.  
  162.     Fixed bug that caused the IFF reader to get lost when doing
  163.       a verbose table of contents on certain archives.
  164.  
  165.     Flattened the source directory structure.
  166.  
  167.     Updated the documentation.
  168.  
  169. -----------------------------------------------------------------------------
  170.