2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
|
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.
|
|
|
|
|
-->
|
2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-02-03 22:00:42 +00:00
|
|
|
<title>Unzip Task</title>
|
2001-02-13 12:32:01 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2001-11-21 07:31:01 +00:00
|
|
|
<h2><a name="unzip">Unjar/Untar/Unwar/Unzip</a></h2>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Description</h3>
|
2005-02-07 23:42:21 +00:00
|
|
|
<p>Unzips a zip-, war-, or jar file.</p>
|
2001-11-21 07:31:01 +00:00
|
|
|
<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>
|
2005-10-06 03:49:34 +00:00
|
|
|
|
|
|
|
|
<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
|
2006-04-14 15:04:54 +00:00
|
|
|
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>
|
2005-10-06 03:49:34 +00:00
|
|
|
|
2004-10-30 19:44:02 +00:00
|
|
|
<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>
|
2001-02-13 12:32:01 +00:00
|
|
|
<p>File permissions will not be restored on extracted files.</p>
|
2001-11-21 07:31:01 +00:00
|
|
|
<p>The untar task recognizes the long pathname entries used by GNU tar.<p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<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>
|
2001-11-21 07:31:01 +00:00
|
|
|
<td valign="top">archive file to expand.</td>
|
|
|
|
|
<td align="center" valign="top">Yes, if filesets are not used.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">dest</td>
|
|
|
|
|
<td valign="top">directory where to store the expanded files.</td>
|
2001-11-21 22:36:12 +00:00
|
|
|
<td align="center" valign="top">Yes</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
2001-07-27 06:52:51 +00:00
|
|
|
<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>
|
2002-04-24 03:09:06 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">compression</td>
|
2003-07-03 13:02:01 +00:00
|
|
|
<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>
|
2002-04-24 03:09:06 +00:00
|
|
|
<td valign="top" align="center">No</td>
|
|
|
|
|
</tr>
|
2003-07-03 13:02:01 +00:00
|
|
|
<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
|
2005-10-22 17:58:42 +00:00
|
|
|
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>
|
2003-07-03 13:02:01 +00:00
|
|
|
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>
|
2002-04-24 03:09:06 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
</table>
|
|
|
|
|
<h3>Examples</h3>
|
2005-03-10 13:01:55 +00:00
|
|
|
<pre>
|
|
|
|
|
<unzip src="${tomcat_src}/tools-src.zip" dest="${tools.home}"/>
|
|
|
|
|
</pre>
|
2005-04-29 18:58:16 +00:00
|
|
|
<p>
|
2005-03-10 13:01:55 +00:00
|
|
|
<pre>
|
|
|
|
|
<gunzip src="tools.tar.gz"/>
|
2001-11-21 07:31:01 +00:00
|
|
|
<untar src="tools.tar" dest="${tools.home}"/>
|
2005-03-10 13:01:55 +00:00
|
|
|
</pre>
|
|
|
|
|
<pre>
|
2001-11-21 07:31:01 +00:00
|
|
|
<unzip src="${tomcat_src}/tools-src.zip"
|
2001-11-21 22:36:12 +00:00
|
|
|
dest="${tools.home}">
|
2001-11-21 07:31:01 +00:00
|
|
|
<patternset>
|
|
|
|
|
<include name="**/*.java"/>
|
|
|
|
|
<exclude name="**/Test*.java"/>
|
2002-06-01 12:26:43 +00:00
|
|
|
</patternset>
|
|
|
|
|
</unzip>
|
2005-03-10 13:01:55 +00:00
|
|
|
</pre>
|
2005-04-29 18:58:16 +00:00
|
|
|
<p>
|
2005-03-10 13:01:55 +00:00
|
|
|
<pre>
|
2001-11-21 22:36:12 +00:00
|
|
|
<unzip dest="${tools.home}">
|
2001-11-21 07:31:01 +00:00
|
|
|
<patternset>
|
|
|
|
|
<include name="**/*.java"/>
|
|
|
|
|
<exclude name="**/Test*.java"/>
|
2002-06-01 12:26:43 +00:00
|
|
|
</patternset>
|
2001-11-21 07:31:01 +00:00
|
|
|
<fileset dir=".">
|
|
|
|
|
<include name="**/*.zip"/>
|
|
|
|
|
<exclude name="**/tmp*.zip"/>
|
2002-06-01 12:26:43 +00:00
|
|
|
</fileset>
|
|
|
|
|
</unzip>
|
2005-03-10 13:01:55 +00:00
|
|
|
</pre>
|
2005-04-29 18:58:16 +00:00
|
|
|
<p>
|
2005-03-10 13:01:55 +00:00
|
|
|
<pre>
|
2004-10-30 19:44:02 +00:00
|
|
|
<unzip src="apache-ant-bin.zip" dest="${tools.home}">
|
|
|
|
|
<patternset>
|
|
|
|
|
<include name="apache-ant/lib/ant.jar"/>
|
|
|
|
|
</patternset>
|
|
|
|
|
<mapper type="flatten"/>
|
|
|
|
|
</unzip>
|
2005-03-10 13:01:55 +00:00
|
|
|
</pre>
|
2005-10-19 18:37:15 +00:00
|
|
|
|
|
|
|
|
<h3>Related tasks</h3>
|
|
|
|
|
|
|
|
|
|
<pre>
|
2006-05-26 22:37:27 +00:00
|
|
|
<unzip src="some-archive" dest="some-dir">
|
2005-10-19 18:37:15 +00:00
|
|
|
<patternset>
|
|
|
|
|
<include name="some-pattern"/>
|
|
|
|
|
</patternset>
|
|
|
|
|
<mapper type="some-mapper"/>
|
|
|
|
|
</unzip>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
is identical to
|
|
|
|
|
|
|
|
|
|
<pre>
|
2006-05-26 22:37:27 +00:00
|
|
|
<copy todir="some-dir" preservelastmodified="true">
|
2005-10-19 18:37:15 +00:00
|
|
|
<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
|
2006-05-26 22:37:27 +00:00
|
|
|
href="../CoreTypes/filterchain.html">filtering files</a> on the fly,
|
2005-10-19 18:37:15 +00:00
|
|
|
allowing a file to be mapped to multiple destinations or a
|
|
|
|
|
configurable file system timestamp granularity.</p>
|
|
|
|
|
|
2006-09-11 04:33:25 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
