| <!-- |
| 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. |
| --> |
| <html> |
| |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"> |
| <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> |
| <title>Unzip Task</title> |
| </head> |
| |
| <body> |
| |
| <h2><a name="unzip">Unjar/Untar/Unwar/Unzip</a></h2> |
| <h3>Description</h3> |
| <p>Unzips a zip-, war-, or jar 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/resources.html#collection">Resource |
| Collection</a>s may be used to select archived files to perform |
| unarchival upon. Only file system based resource collections are |
| supported by Unjar/Unwar/Unzip, this includes <a |
| href="../CoreTypes/fileset.html">fileset</a>, <a |
| href="../CoreTypes/filelist.html">filelist</a>, <a |
| href="../using.html#path">path</a>, and <a |
| href="../CoreTypes/resources.html#files">files</a>. |
| Untar supports arbitrary resource collections. |
| Prior to Ant 1.7 only fileset has been supported as a nested element.</p> |
| |
| <p>You can define filename transformations by using a nested <a href="../CoreTypes/mapper.html">mapper</a> element. The default mapper is the |
| <a href="../CoreTypes/mapper.html#identity-mapper">identity mapper</a>. |
| </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/j2se/1.5.0/docs/guide/intl/encoding.doc.html">http://java.sun.com/j2se/1.5.0/docs/guide/intl/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> |
| <pre> |
| <unzip src="${tomcat_src}/tools-src.zip" dest="${tools.home}"/> |
| </pre> |
| <p> |
| <pre> |
| <gunzip src="tools.tar.gz"/> |
| <untar src="tools.tar" dest="${tools.home}"/> |
| </pre> |
| <pre> |
| <unzip src="${tomcat_src}/tools-src.zip" |
| dest="${tools.home}"> |
| <patternset> |
| <include name="**/*.java"/> |
| <exclude name="**/Test*.java"/> |
| </patternset> |
| </unzip> |
| </pre> |
| <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> |
| <pre> |
| <unzip src="apache-ant-bin.zip" dest="${tools.home}"> |
| <patternset> |
| <include name="apache-ant/lib/ant.jar"/> |
| </patternset> |
| <mapper type="flatten"/> |
| </unzip> |
| </pre> |
| |
| <h3>Related tasks</h3> |
| |
| <pre> |
| <unzip src="some-archive" dest="some-dir"> |
| <patternset> |
| <include name="some-pattern"/> |
| </patternset> |
| <mapper type="some-mapper"/> |
| </unzip> |
| </pre> |
| |
| is identical to |
| |
| <pre> |
| <copy todir="some-dir" preservelastmodified="true"> |
| <zipfileset src="some-archive"> |
| <patternset> |
| <include name="some-pattern"/> |
| </patternset> |
| </zipfileset> |
| <mapper type="some-mapper"/> |
| </copy> |
| </pre> |
| |
| <p>The same is also true for <code><untar></code> and |
| <code><tarfileset></code>. <code><copy></code> offers |
| additional features like <a href="../CoreTypes/filterchain.html">filtering files</a> on the fly, |
| allowing a file to be mapped to multiple destinations or a |
| configurable file system timestamp granularity.</p> |
| |
| <pre><zip destfile="new.jar"> |
| <zipfileset src="old.jar"> |
| <exclude name="do/not/include/this/class"/> |
| </zipfileset> |
| </zip> |
| </pre> |
| <p>"Deletes" files from a zipfile.</p> |
| |
| |
| </body> |
| </html> |
