| <html> |
| |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"> |
| <title>Unzip Task</title> |
| <link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css"> |
| </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 "last modified time" 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</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">compression</td> |
| <td valign="top"><b>Note:</b> This attribute is only available for |
| the <code>untar</code> task.<br> |
| compression method. Allowable values are "none", |
| "gzip" and "bzip2". Default is |
| "none".</td> |
| <td valign="top" align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">encoding</td> |
| <td valign="top"><b>Note:</b> This attribute is not available for |
| the <code>untar</code> task.<br> |
| The character encoding that has been used for filenames |
| inside the zip file. For a list of possible values see <a |
| href="http://java.sun.com/products/jdk/1.2/docs/guide/internat/encoding.doc.html">http://java.sun.com/products/jdk/1.2/docs/guide/internat/encoding.doc.html</a>.<br> |
| Defaults to "UTF8", use the magic value |
| <code>native-encoding</code> for the platform's default character |
| encoding.</td> |
| <td align="center" valign="top">No</td> |
| </tr> |
| |
| </table> |
| <h3>Examples</h3> |
| <blockquote> |
| <p><code><unzip src="${tomcat_src}/tools-src.zip" dest="${tools.home}"/></code></p> |
| </blockquote> |
| <blockquote> |
| <p><code> |
| <gunzip src="tools.tar.gz"/><br> |
| <untar src="tools.tar" dest="${tools.home}"/> |
| </code></p> |
| </blockquote> |
| <blockquote> |
| <p><pre> |
| <unzip src="${tomcat_src}/tools-src.zip" |
| dest="${tools.home}"> |
| <patternset> |
| <include name="**/*.java"/> |
| <exclude name="**/Test*.java"/> |
| </patternset> |
| </unzip> |
| </pre></p> |
| </blockquote> |
| <blockquote> |
| <p><pre> |
| <unzip dest="${tools.home}"> |
| <patternset> |
| <include name="**/*.java"/> |
| <exclude name="**/Test*.java"/> |
| </patternset> |
| <fileset dir="."> |
| <include name="**/*.zip"/> |
| <exclude name="**/tmp*.zip"/> |
| </fileset> |
| </unzip> |
| </pre></p> |
| </blockquote> |
| <hr> |
| <p align="center">Copyright © 2000-2003 Apache Software Foundation. All rights |
| Reserved.</p> |
| |
| </body> |
| </html> |
| |