home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / util / zoo-2.1.lha / zoo / zoo.man < prev    next >
Text File  |  1991-07-17  |  50KB  |  1,100 lines
  1.  
  2. ZOO(1)                  REFERENCE MANUAL                   ZOO(1)
  3.  
  4. NAME
  5.      zoo - manipulate archives of files in compressed form
  6.  
  7. SYNOPSIS
  8.      zoo {acfDeghHlLPTuUvVx}[aAcCdEfghImMnNoOpPqSu1:/.@n+-=]
  9.      archive [file] ...
  10.      zoo -command archive [file] ...
  11.      zoo h
  12.  
  13. DESCRIPTION
  14.      Zoo is used to create and maintain collections of files in
  15.      compressed form.  It uses a Lempel-Ziv compression algorithm
  16.      that gives space savings in the range of 20% to 80% depend-
  17.      ing on the type of file data.  Zoo can store and selectively
  18.      extract multiple generations of the same file.  Data can be
  19.      recovered from damaged archives by skipping the damaged por-
  20.      tion and locating undamaged data with the help of fiz(1).
  21.  
  22.      This documentation is for version 2.1.  Changes from previ-
  23.      ous versions are described in the section labelled CHANGES.
  24.  
  25.      The command zoo h gives a summary of commands.  Extended
  26.      multiscreen help can be obtained with zoo H.
  27.  
  28.      Zoo will not add an archive to itself, nor add the archive's
  29.      backup (with .bak extension to the filename) to the archive.
  30.  
  31.      Zoo has two types of commands:  Expert commands, which con-
  32.      sist of one command letter followed by zero or more modifier
  33.      characters, and Novice commands, which consist of a hyphen
  34.      (`-') followed by a command word that may be abbreviated.
  35.      Expert commands are case-sensitive but Novice commands are
  36.      not.
  37.  
  38.      When zoo adds a file to an existing archive, the default
  39.      action is to maintain one generation of each file in an
  40.      archive and to mark any older generation as deleted.  A
  41.      limit on the number of generations to save can be specified
  42.      by the user for an entire archive, or for each file indivi-
  43.      dually, or both.  Zoo deletes a stored copy of an added file
  44.      if necessary to prevent the number of stored generations
  45.      from exceeding the user-specified limit.
  46.  
  47.      Deleted files may be later undeleted.  Archives may be
  48.      packed to recover space occupied by deleted files.
  49.  
  50.      All commands assume that the archive name ends with the
  51.      characters .zoo unless a different extension is supplied.
  52.  
  53.      Novice commands
  54.  
  55.      Novice commands may be abbreviated to a hyphen followed by
  56.      at least one command character.  Each Novice command works
  57.      in two stages. First, the command does its intended work.
  58.      Then, if the result was that one or more files were deleted
  59.      in the specified archive, the archive is packed.  If packing
  60.      occurs, the original unpacked archive is always left behind
  61.      with an extension of .bak.
  62.  
  63.      No Novice command ever stores the directory prefix of a
  64.      file.
  65.  
  66.      The Novice commands are as follows.
  67.  
  68.      -add    Adds the specified files to the archive.
  69.  
  70.      -freshen
  71.           Adds a specified file to the archive if and only if an
  72.           older file by the same name already exists in the
  73.           archive.
  74.  
  75.      -delete
  76.           Deletes the specified files from the archive.
  77.  
  78.      -update
  79.           Adds a specified file to the archive either:  if an
  80.           older file by the same name already exists in the
  81.           archive or:  if a file by the same name does not
  82.           already exist in the archive.
  83.  
  84.      -extract
  85.           Extracts the specified files from the archive.  If no
  86.           file is specified all files are extracted.
  87.  
  88.      -move
  89.           Equivalent to -add except that source files are deleted
  90.           after addition.
  91.  
  92.      -print
  93.           Equivalent to -extract except that extracted data are
  94.           sent to standard output.
  95.  
  96.      -list
  97.           Gives information about the specified archived files
  98.           including any attached comments.  If no files are
  99.           specified all files are listed.  Deleted files are not
  100.           listed.
  101.  
  102.      -test
  103.           Equivalent to -extract except that the extracted data
  104.           are not saved but any errors encountered are reported.
  105.  
  106.      -comment
  107.           Allows the user to add or update comments attached to
  108.           archived files.  When prompted, the user may:  type a
  109.           carriage return to skip the file, leaving any current
  110.           comment unchanged;  or type a (possibly null) comment
  111.           of up to 32,767 characters terminated by /end (case-
  112.           insensitive) on a separate line;  or type the end-of-
  113.           file character (normally control D) to skip all remain-
  114.           ing files.
  115.  
  116.      -delete
  117.           Deletes the specified files.
  118.  
  119.      The correspondence between Novice and Expert commands is as follows.
  120.  
  121.      Novice                                        Equivalent
  122.      Command    Description                        Expert Command
  123.      ____________________________________________________________
  124.      -add       add files to archive               aP:
  125.      -extract   extract files from archive         x
  126.      -move      move files to archive              aMP:
  127.      -test      test archive integrity             xNd
  128.      -print     extract files to standard output   xp
  129.      -delete    delete files from archive          DP
  130.      -list      list archive contents              VC
  131.      -update    add new or newer files             aunP:
  132.      -freshen   by add newer files                 auP:
  133.      -comment   add comments to files              c
  134.  
  135.      Expert commands
  136.  
  137.      The general format of expert commands is:
  138.  
  139.      zoo {acfDeghHlLPTuUvVx}[aAcCdEfghImMnNoOpPqSu1:/.@n+-=]
  140.      archive [file] ...
  141.  
  142.      The characters enclosed within {} are commands.  Choose any
  143.      one of these.  The characters enclosed within [] just to the
  144.      right of the {} are modifiers and zero or more of these may
  145.      immediately follow the command character.  All combinations
  146.      of command and modifier characters may not be valid.
  147.  
  148.      Files are added to an archive with the command:
  149.  
  150.      zoo {au}[cfhIMnPqu:+-] archive [file] ...
  151.  
  152.      Command characters are:
  153.  
  154.      a    Add each specified file to archive.  Any already-
  155.           archived copy of the file is deleted if this is neces-
  156.           sary to avoid exceeding the user-specified limit on the
  157.           number of generations of the file to maintain in the
  158.           archive.
  159.  
  160.      u    Do an update of the archive.  A specified file is added
  161.           to the archive only if a copy of it is already in the
  162.           archive and the copy being added is newer than the copy
  163.           already in the archive.
  164.  
  165.      The following modifiers are specific to these commands.
  166.  
  167.      M    Move files to archive.  This makes zoo delete (unlink)
  168.           the original files after they have been added to the
  169.           archive.  Files are deleted after addition of all files
  170.           to the archive is complete and after any requested
  171.           packing of the archive has been done, and only if zoo
  172.           detected no errors.
  173.  
  174.      n    Add new files only.  A specified file is added only if
  175.           it isn't already in the archive.
  176.  
  177.      h    Use the high performance compression algorithm. This
  178.           option may be used with either the add (a) or filter
  179.           (f) commands to gain extra compression at the expense
  180.           of using somewhat more processor time. Extracting files
  181.           compressed with the method is usually slightly faster
  182.           than those saved with the default method.
  183.  
  184.      P    Pack archive after files have been added.
  185.  
  186.      u    Applied to the a command, this modifier makes it behave
  187.           identically to the u command.
  188.  
  189.           The combination of the n modifier with the u modifier
  190.           or u command causes addition of a file to the archive
  191.           either if the file is not already in the archive, or if
  192.           the file is already in the archive but the archived
  193.           copy is older than the copy being added.
  194.  
  195.      :    Do not store directory names.  In the absence of this
  196.           modifier zoo stores the full pathname of each archived
  197.           file.
  198.  
  199.      I    Read filenames to be archived from standard input. Zoo
  200.           will read its standard input and assume that each line
  201.           of text contains a filename.  Under AmigaDOS and the
  202.           **IX family, the entire line is used.  Under