Return-Path: Delivered-To: apmail-ant-notifications-archive@minotaur.apache.org Received: (qmail 39733 invoked from network); 9 Sep 2009 14:21:03 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 9 Sep 2009 14:21:03 -0000 Received: (qmail 47950 invoked by uid 500); 9 Sep 2009 14:21:03 -0000 Delivered-To: apmail-ant-notifications-archive@ant.apache.org Received: (qmail 47910 invoked by uid 500); 9 Sep 2009 14:21:03 -0000 Mailing-List: contact notifications-help@ant.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@ant.apache.org Delivered-To: mailing list notifications@ant.apache.org Received: (qmail 47895 invoked by uid 99); 9 Sep 2009 14:21:02 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 09 Sep 2009 14:21:02 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 09 Sep 2009 14:20:59 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 80F5E23888EC; Wed, 9 Sep 2009 14:20:39 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r812969 - /ant/sandbox/antlibs/compress/trunk/docs/unpack.html Date: Wed, 09 Sep 2009 14:20:39 -0000 To: notifications@ant.apache.org From: bodewig@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20090909142039.80F5E23888EC@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: bodewig Date: Wed Sep 9 14:20:39 2009 New Revision: 812969 URL: http://svn.apache.org/viewvc?rev=812969&view=rev Log: document uncompressing tasks Added: ant/sandbox/antlibs/compress/trunk/docs/unpack.html (contents, props changed) - copied, changed from r812756, ant/core/trunk/docs/manual/CoreTasks/unpack.html Copied: ant/sandbox/antlibs/compress/trunk/docs/unpack.html (from r812756, ant/core/trunk/docs/manual/CoreTasks/unpack.html) URL: http://svn.apache.org/viewvc/ant/sandbox/antlibs/compress/trunk/docs/unpack.html?p2=ant/sandbox/antlibs/compress/trunk/docs/unpack.html&p1=ant/core/trunk/docs/manual/CoreTasks/unpack.html&r1=812756&r2=812969&rev=812969&view=diff ============================================================================== --- ant/core/trunk/docs/manual/CoreTasks/unpack.html (original) +++ ant/sandbox/antlibs/compress/trunk/docs/unpack.html Wed Sep 9 14:20:39 2009 @@ -18,18 +18,23 @@ - -GUnzip/BUnzip2 Task + +Uncompressing Tasks -

GUnzip/BUnzip2

+

Uncompressing Tasks

Description

-

Expands a resource packed using GZip or BZip2.

+ +

For each of the supported compression formats there is a + correspondig task that uncompresses a resource. These tasks are + based on + their core + cousin tasks.

If dest is a directory the name of the destination file is -the same as src (with the ".gz" or ".bz2" +the same as src (with the compression specific extension removed if present). If dest is omitted, the parent dir of src is taken. The file is only expanded if the source resource is newer than the destination file, or when the destination file @@ -55,33 +60,43 @@

Parameters specified as nested elements

-

any resource or single element +

any resource or single element resource collection

The specified resource will be used as src.

+

BUnZip2

+ +

Is an uncompressing task that uses the BZIP2 + compression algorithm.

+ +

GUnZip

+ +

Is an uncompressing task that uses the GZIP + compression algorithm.

+

Examples

-<gunzip src="test.tar.gz"/>
+<cmp:gunzip src="test.tar.gz" xmlns:cmp="antlib:org.apache.ant.compress"/>

expands test.tar.gz to test.tar

-<bunzip2 src="test.tar.bz2"/>
+<cmp:bunzip2 src="test.tar.bz2" xmlns:cmp="antlib:org.apache.ant.compress"/>

expands test.tar.bz2 to test.tar

-<gunzip src="test.tar.gz" dest="test2.tar"/>
+<cmp:gunzip src="test.tar.gz" dest="test2.tar" xmlns:cmp="antlib:org.apache.ant.compress"/>

expands test.tar.gz to test2.tar

-<gunzip src="test.tar.gz" dest="subdir"/>
+<cmp:gunzip src="test.tar.gz" dest="subdir" xmlns:cmp="antlib:org.apache.ant.compress"/>

expands test.tar.gz to subdir/test.tar (assuming subdir is a directory).

-<gunzip dest=".">
+<cmp:gunzip dest="." xmlns:cmp="antlib:org.apache.ant.compress">
   <url url="http://example.org/archive.tar.gz"/>
-</gunzip>
+</cmp:gunzip>

downloads http://example.org/archive.tar.gz and expands it to archive.tar in the project's basedir on the fly.

@@ -89,16 +104,16 @@

Related tasks

-<gunzip src="some-archive.gz" dest="some-dest-dir"/>
+<cmp:gunzip src="some-archive.gz" dest="some-dest-dir" xmlns:cmp="antlib:org.apache.ant.compress"/>
is identical to 
 <copy todir="some-dest-dir">
-  <gzipresource>
+  <cmp:gzipresource xmlns:cmp="antlib:org.apache.ant.compress">
     <file file="some-archive.gz"/>
-  </gzipresource>
+  </cmp:gzipresource>
   <mapper type="glob" from="*.gz" to="*"/>
 </copy>
@@ -106,12 +121,11 @@

The same is also true for <bunzip2> and <bzip2resource>. <copy> offers additional features like filtering files on the fly, +href="http://ant.apache.org/manual/CoreTypes/filterchain.html">filtering +files on the fly, allowing a file to be mapped to multiple destinations, preserving the last modified time or a configurable file system timestamp granularity.

- - Propchange: ant/sandbox/antlibs/compress/trunk/docs/unpack.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/sandbox/antlibs/compress/trunk/docs/unpack.html ------------------------------------------------------------------------------ svn:keywords = Author Date Id Revision Propchange: ant/sandbox/antlibs/compress/trunk/docs/unpack.html ------------------------------------------------------------------------------ svn:mergeinfo =