ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject svn commit: r812969 - /ant/sandbox/antlibs/compress/trunk/docs/unpack.html
Date Wed, 09 Sep 2009 14:20:39 GMT
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 @@
 
 <head>
 <meta http-equiv="Content-Language" content="en-us">
-<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
-<title>GUnzip/BUnzip2 Task</title>
+<link rel="stylesheet" type="text/css" href="style.css">
+<title>Uncompressing Tasks</title>
 </head>
 
 <body>
 
-<h2><a name="unpack">GUnzip/BUnzip2</a></h2>
+<h2><a name="unpack">Uncompressing Tasks</a></h2>
 <h3>Description</h3>
-<p>Expands a resource packed using GZip or BZip2.</p>
+
+<p>For each of the supported compression formats there is a
+  correspondig task that uncompresses a resource.  These tasks are
+  based on
+  their <a href="http://ant.apache.org/manual/CoreTasks/unpack.html">core
+  cousin tasks</a>.</p>
 
 <p>If <i>dest</i> is a directory the name of the destination file is
-the same as <i>src</i> (with the &quot;.gz&quot; or &quot;.bz2&quot;
+the same as <i>src</i> (with the compression specific
 extension removed if present). If <i>dest</i> is omitted, the parent
 dir of <i>src</i> 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 @@
 </table>
 <h3>Parameters specified as nested elements</h3>
 
-<h4>any <a href="../CoreTypes/resources.html">resource</a> or single element
+<h4>any <a href="http://ant.apache.org/manual/CoreTypes/resources.html">resource</a>
or single element
 resource collection</h4>
 
 <p>The specified resource will be used as src.</p>
 
+<h3><a name="bunzip2">BUnZip2</a></h3>
+
+<p>Is an <a href="#unpack">uncompressing task</a> that uses the BZIP2
+  compression algorithm.</p>
+
+<h3><a name="gunzip">GUnZip</a></h3>
+
+<p>Is an <a href="#unpack">uncompressing task</a> that uses the GZIP
+  compression algorithm.</p>
+
 <h3>Examples</h3>
 <blockquote><pre>
-&lt;gunzip src=&quot;test.tar.gz&quot;/&gt;
+&lt;cmp:gunzip src=&quot;test.tar.gz&quot; xmlns:cmp="antlib:org.apache.ant.compress"/&gt;
 </pre></blockquote>
 <p>expands <i>test.tar.gz</i> to <i>test.tar</i></p>
 <blockquote><pre>
-&lt;bunzip2 src=&quot;test.tar.bz2&quot;/&gt;
+&lt;cmp:bunzip2 src=&quot;test.tar.bz2&quot; xmlns:cmp="antlib:org.apache.ant.compress"/&gt;
 </pre></blockquote>
 <p>expands <i>test.tar.bz2</i> to <i>test.tar</i></p>
 <blockquote><pre>
-&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;test2.tar&quot;/&gt;
+&lt;cmp:gunzip src=&quot;test.tar.gz&quot; dest=&quot;test2.tar&quot;
xmlns:cmp="antlib:org.apache.ant.compress"/&gt;
 </pre></blockquote>
 <p>expands <i>test.tar.gz</i> to <i>test2.tar</i></p>
 <blockquote><pre>
-&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;subdir&quot;/&gt;
+&lt;cmp:gunzip src=&quot;test.tar.gz&quot; dest=&quot;subdir&quot; xmlns:cmp="antlib:org.apache.ant.compress"/&gt;
 </pre></blockquote>
 <p>expands <i>test.tar.gz</i> to <i>subdir/test.tar</i> (assuming
 subdir is a directory).</p>
 <blockquote><pre>
-&lt;gunzip dest=&quot;.&quot;&gt;
+&lt;cmp:gunzip dest=&quot;.&quot; xmlns:cmp="antlib:org.apache.ant.compress"&gt;
   &lt;url url="http://example.org/archive.tar.gz"/&gt;
-&lt;/gunzip&gt;
+&lt;/cmp:gunzip&gt;
 </pre></blockquote>
 <p>downloads <i>http://example.org/archive.tar.gz</i> and expands it
 to <i>archive.tar</i> in the project's basedir on the fly.</p>
@@ -89,16 +104,16 @@
 <h3>Related tasks</h3>
 
 <pre>
-&lt;gunzip src="some-archive.gz" dest="some-dest-dir"/&gt;
+&lt;cmp:gunzip src="some-archive.gz" dest="some-dest-dir" xmlns:cmp="antlib:org.apache.ant.compress"/&gt;
 </pre>
 
 is identical to
 
 <pre>
 &lt;copy todir="some-dest-dir"&gt;
-  &lt;gzipresource&gt;
+  &lt;cmp:gzipresource xmlns:cmp="antlib:org.apache.ant.compress"&gt;
     &lt;file file="some-archive.gz"/&gt;
-  &lt;/gzipresource&gt;
+  &lt;/cmp:gzipresource&gt;
   &lt;mapper type="glob" from="*.gz" to="*"/&gt;
 &lt;/copy&gt;
 </pre>
@@ -106,12 +121,11 @@
 <p>The same is also true for <code>&lt;bunzip2&gt;</code> and
 <code>&lt;bzip2resource&gt;</code>.  <code>&lt;copy&gt;</code>
offers
 additional features like <a
-href="../CoreTypes/filterchain.html">filtering files</a> on the fly,
+href="http://ant.apache.org/manual/CoreTypes/filterchain.html">filtering
+files</a> on the fly,
 allowing a file to be mapped to multiple destinations, preserving the
 last modified time or a configurable file system timestamp
 granularity.</p>
 
-
-
 </body>
 </html>

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 = 



Mime
View raw message