ant/docs/manual/CoreTasks/unzip.html
Magesh Umasankar 80d371a3b4 1. Refactored Untar to extend from Expand, as untar is very similar to unjar, unwar and unzip.
2. Added 2 new attributes to these tasks - outfile and verbose
3. Nested Patternsets can be used to specify what files are to be extracted from within the archive.
4. Nested Filesets can be specified to select previously archived files for unarchival (PR: 3074)


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269973 13f79535-47bb-0310-9956-ffa450edef68
2001-11-21 07:31:01 +00:00

106 lines
3.3 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>Apache Ant User Manual</title>
</head>
<body>
<h2><a name="unzip">Unjar/Untar/Unwar/Unzip</a></h2>
<h3>Description</h3>
<p>Unzips a zip-, war-, tar- or jarfile.</p>
<p>For JDK 1.1 &quot;last modified time&quot; field is set to current time instead of being
carried from the archive file.</p>
<p><a href="../CoreTypes/patternset.html">PatternSet</a>s are used to select files to extract
<I>from</I> the archive. If no patternset is used, all files are extracted.
</p>
<p><a href="../CoreTypes/fileset.html">FileSet</a>s may be used used to select archived files
to perform unarchival upon.
</p>
<p>File permissions will not be restored on extracted files.</p>
<p>The untar task recognizes the long pathname entries used by GNU tar.<p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">src</td>
<td valign="top">archive file to expand.</td>
<td align="center" valign="top">Yes, if filesets are not used.</td>
</tr>
<tr>
<td valign="top">dest</td>
<td valign="top">directory where to store the expanded files.</td>
<td align="center" valign="top">Yes, if outfile is not specified.</td>
</tr>
<tr>
<td valign="top">overwrite</td>
<td valign="top">Overwrite files, even if they are newer than the
corresponding entries in the archive (true or false, default is
true).</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">outfile</td>
<td valign="top">List the contents of the archive into this file.</td>
<td align="center" valign="top">Yes, if dest is not specified.</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td valign="top">Include file details when listing contents of
the archive into outfile? Defaults to <I>false</I>.</td>
<td align="center" valign="top">No</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<p><code>&lt;unzip src=&quot;${tomcat_src}/tools-src.zip&quot; dest=&quot;${tools.home}&quot;
/&gt;</code></p>
</blockquote>
<blockquote>
<p><code>
&lt;gunzip src=&quot;tools.tar.gz&quot;/&gt;<br>
&lt;untar src=&quot;tools.tar&quot; dest=&quot;${tools.home}&quot;/&gt;
</code></p>
</blockquote>
<blockquote>
<p><pre>
&lt;unzip src=&quot;${tomcat_src}/tools-src.zip&quot;
dest=&quot;${tools.home}&quot;
outfile=&quot;${outfile}&quot;
vebose=&quot;on&quot;&gt;
&lt;patternset&gt;
&lt;include name=&quot;**/*.java&quot;/&gt;
&lt;exclude name=&quot;**/Test*.java&quot;/&gt;
&lt;patternset/&gt;
&lt;unzip/&gt;
</pre></p>
</blockquote>
<blockquote>
<p><pre>
&lt;unzip dest=&quot;${tools.home}&quot;
outfile=&quot;${outfile}&quot;
vebose=&quot;on&quot;&gt;
&lt;patternset&gt;
&lt;include name=&quot;**/*.java&quot;/&gt;
&lt;exclude name=&quot;**/Test*.java&quot;/&gt;
&lt;patternset/&gt;
&lt;fileset dir=&quot;.&quot;&gt;
&lt;include name=&quot;**/*.zip&quot;/&gt;
&lt;exclude name=&quot;**/tmp*.zip&quot;/&gt;
&lt;fileset/&gt;
&lt;unzip/&gt;
</pre></p>
</blockquote>
<hr>
<p align="center">Copyright &copy; 2000,2001 Apache Software Foundation. All rights
Reserved.</p>
</body>
</html>