<?xml version="1.0"?>
<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-->
<document>

  <properties>
    <index value="1"/>
    <title>Compress Antlib</title>
  </properties>

  <body>
    <section name="Compress Antlib">
      <p>This Antlib contains tasks and resources that provide
        compression/uncompression and archival/unarchival capabilities
        based on <a href="http://commons.apache.org/compress/">Apache
        Commons Compress</a>.  Using Apache Commons Compress 1.0 this
        Antlib supports gzip and bzip2 compression and ar, cpio, tar
        and zip archives.</p>

      <p>The current code base is based on the 1.0 release of Commons
        Compress but it is expected that this Antlib follows Commons
        Compress' development and will add new compression or
        archiving formats as they are provided by the underlying
        library.</p>

      <p>The gzip and bzip2 tasks and resources are similar to the
        corresponding tasks and types in Ant's core and mainly just
        use a different code base for the implementation of the
        formats.</p>

      <p>The same is mostly true for the zip and tar resources as well
        as the unzip/tar task with the major difference being that
        unzip and zipfileset can work with non-File resources.</p>

      <p>The zip and tar tasks are completely new implementations and
        offer a superset of the functionality of the core tasks.</p>

      <p>Tasks and resources for the ar and cpio formats mirror those
        available for tar and zip.</p>

      <p>All tasks and types can be mixed with the core tasks and
        types; it is possible to use the core zip task to create an
        archive based on an cpiofileset for example.</p>
    </section>
  </body>
</document>

