2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2001-12-04 03:06:04 +00:00
|
|
|
<title>Copy Task</title>
|
2001-02-13 12:32:01 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<h2><a name="copy">Copy</a></h2>
|
|
|
|
|
<h3>Description</h3>
|
2002-04-01 03:49:51 +00:00
|
|
|
<p>Copies a file or FileSet to a new file or directory. By default, files are
|
2001-02-13 12:32:01 +00:00
|
|
|
only copied if the source file is newer than the destination file,
|
|
|
|
|
or when the destination file does not exist. However, you can explicitly
|
2002-04-01 03:49:51 +00:00
|
|
|
overwrite files with the <code>overwrite</code> attribute.</p>
|
|
|
|
|
<p><a href="../CoreTypes/fileset.html">FileSet</a>s are used to select a
|
|
|
|
|
set of files to copy.
|
|
|
|
|
To use a <code><fileset></code>, the <code>todir</code> attribute
|
|
|
|
|
must be set.</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">file</td>
|
|
|
|
|
<td valign="top">The file to copy.</td>
|
2002-04-01 03:49:51 +00:00
|
|
|
<td valign="top" align="center">Yes, unless a nested
|
|
|
|
|
<code><fileset></code> element is used.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">preservelastmodified</td>
|
|
|
|
|
<td valign="top">Give the copied files the same last modified
|
2002-04-01 03:49:51 +00:00
|
|
|
time as the original source files.
|
|
|
|
|
(<em>Note</em>: Ignored on Java 1.1)</td>
|
|
|
|
|
<td valign="top" align="center">No; defaults to false.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">tofile</td>
|
|
|
|
|
<td valign="top">The file to copy to.</td>
|
2002-04-01 03:49:51 +00:00
|
|
|
<td valign="top" align="center" rowspan="2">With the <code>file</code>
|
|
|
|
|
attribute, either <code>tofile</code> or <code>todir</code> can be used.
|
|
|
|
|
With nested <code><fileset></code> elements, if the set of files
|
|
|
|
|
is greater than 1, or if only the <code>dir</code> attribute is
|
|
|
|
|
specified in the <code><fileset></code>, or if the
|
|
|
|
|
<code>file</code> attribute is also specified, then only
|
|
|
|
|
<code>todir</code> is allowed.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">todir</td>
|
|
|
|
|
<td valign="top">The directory to copy to.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">overwrite</td>
|
|
|
|
|
<td valign="top">Overwrite existing files even if the destination
|
2002-04-01 03:49:51 +00:00
|
|
|
files are newer.</td>
|
|
|
|
|
<td valign="top" align="center">No; defaults to false.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">filtering</td>
|
2002-04-01 03:49:51 +00:00
|
|
|
<td valign="top">Indicates whether token filtering using the global
|
|
|
|
|
build-file filters should take place during the copy.
|
|
|
|
|
<em>Note</em>: Nested <code><filterset></code> elements will
|
|
|
|
|
always be used, even if this attribute is not specified, or its value is
|
|
|
|
|
<code>false</code> (<code>no</code>, or <code>off</code>).</td>
|
|
|
|
|
<td valign="top" align="center">No; defaults to false.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">flatten</td>
|
2002-04-01 03:49:51 +00:00
|
|
|
<td valign="top">Ignore the directory structure of the source files,
|
|
|
|
|
and copy all files into the directory specified by the <code>todir</code>
|
|
|
|
|
attribute. Note that you can achieve the same effect by using a
|
|
|
|
|
<a href="../CoreTypes/mapper.html#flatten-mapper">flatten mapper</a>.</td>
|
|
|
|
|
<td valign="top" align="center">No; defaults to false.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">includeEmptyDirs</td>
|
2002-04-01 03:49:51 +00:00
|
|
|
<td valign="top">Copy any empty directories included in the FileSet(s).
|
|
|
|
|
</td>
|
|
|
|
|
<td valign="top" align="center">No; defaults to true.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">failonerror</td>
|
|
|
|
|
<td valign="top">Log a warning message, but do not stop the build,
|
|
|
|
|
when the file to copy does not exist.
|
|
|
|
|
Only meaningful when copying a single file.
|
|
|
|
|
</td>
|
|
|
|
|
<td valign="top" align="center">No; defaults to true.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
<h3>Parameters specified as nested elements</h3>
|
2001-08-30 13:23:14 +00:00
|
|
|
|
|
|
|
|
<h4>fileset</h4>
|
2002-04-01 03:49:51 +00:00
|
|
|
<p><a href="../CoreTypes/fileset.html">FileSet</a>s are used to select
|
|
|
|
|
sets of files to copy.
|
|
|
|
|
To use a fileset, the <code>todir</code> attribute must be set.</p>
|
2001-08-30 13:23:14 +00:00
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h4>mapper</h4>
|
2002-04-01 03:49:51 +00:00
|
|
|
<p>You can define filename transformations by using a nested <a
|
2001-08-30 13:23:14 +00:00
|
|
|
href="../CoreTypes/mapper.html">mapper</a> element. The default mapper used by
|
|
|
|
|
<code><copy></code> is the <a
|
2002-04-01 03:49:51 +00:00
|
|
|
href="../CoreTypes/mapper.html#identity-mapper">identity mapper</a>.</p>
|
2001-08-30 13:23:14 +00:00
|
|
|
|
|
|
|
|
<h4>filterset</h4>
|
2002-04-01 03:49:51 +00:00
|
|
|
<p><a href="../CoreTypes/filterset.html">FilterSet</a>s are used to replace
|
|
|
|
|
tokens in files that are copied.
|
|
|
|
|
To use a FilterSet, use the nested <code><filterset></code> element.</p>
|
2001-08-30 13:23:14 +00:00
|
|
|
|
|
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Examples</h3>
|
|
|
|
|
<p><b>Copy a single file</b></p>
|
|
|
|
|
<pre>
|
|
|
|
|
<copy file="myfile.txt" tofile="mycopy.txt"/>
|
|
|
|
|
</pre>
|
2002-04-01 03:49:51 +00:00
|
|
|
<p><b>Copy a single file to a directory</b></p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<pre>
|
2002-04-01 03:49:51 +00:00
|
|
|
<copy file="myfile.txt" todir="../some/other/dir"/>
|
2001-02-13 12:32:01 +00:00
|
|
|
</pre>
|
|
|
|
|
<p><b>Copy a directory to another directory</b></p>
|
|
|
|
|
<pre>
|
|
|
|
|
<copy todir="../new/dir">
|
|
|
|
|
<fileset dir="src_dir"/>
|
|
|
|
|
</copy>
|
|
|
|
|
</pre>
|
|
|
|
|
<p><b>Copy a set of files to a directory</b></p>
|
|
|
|
|
<pre>
|
|
|
|
|
<copy todir="../dest/dir" >
|
2001-12-04 03:06:04 +00:00
|
|
|
<fileset dir="src_dir" >
|
2001-02-13 12:32:01 +00:00
|
|
|
<exclude name="**/*.java"/>
|
|
|
|
|
</fileset>
|
|
|
|
|
</copy>
|
|
|
|
|
|
|
|
|
|
<copy todir="../dest/dir" >
|
2001-12-04 03:06:04 +00:00
|
|
|
<fileset dir="src_dir" excludes="**/*.java"/>
|
2001-02-13 12:32:01 +00:00
|
|
|
</copy>
|
|
|
|
|
</pre>
|
2002-04-01 03:49:51 +00:00
|
|
|
<p><b>Copy a set of files to a directory, appending
|
|
|
|
|
<code>.bak</code> to the file name on the fly</b></p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<pre>
|
|
|
|
|
<copy todir="../backup/dir" >
|
2001-12-04 03:06:04 +00:00
|
|
|
<fileset dir="src_dir" />
|
2001-02-13 12:32:01 +00:00
|
|
|
<mapper type="glob" from="*" to="*.bak"/>
|
|
|
|
|
</copy>
|
|
|
|
|
</pre>
|
2001-08-30 13:23:14 +00:00
|
|
|
|
|
|
|
|
|
2002-04-01 03:49:51 +00:00
|
|
|
<p><b>Copy a set of files to a directory, replacing @TITLE@ with Foo Bar
|
|
|
|
|
in all files.</b></p>
|
2001-08-30 13:23:14 +00:00
|
|
|
<pre>
|
|
|
|
|
<copy todir="../backup/dir" >
|
|
|
|
|
<fileset dir="src_dir" />
|
|
|
|
|
<filterset>
|
|
|
|
|
<filter token="TITLE" value="Foo Bar" />
|
|
|
|
|
</filterset>
|
|
|
|
|
</copy>
|
|
|
|
|
</pre>
|
|
|
|
|
|
2002-04-01 03:49:51 +00:00
|
|
|
<p><strong>Unix Note:</strong> File permissions are not retained when files
|
2001-12-04 03:06:04 +00:00
|
|
|
are copied; they end up with the default UMASK permissions instead. This
|
|
|
|
|
is caused by the lack of any means to query or set file permissions in the
|
2002-04-01 03:49:51 +00:00
|
|
|
current Java runtimes. If you need a permission-preserving copy function,
|
2001-12-04 03:06:04 +00:00
|
|
|
use <exec executable="cp" ... > instead.
|
2001-08-30 13:23:14 +00:00
|
|
|
|
2002-04-01 03:49:51 +00:00
|
|
|
<hr><p align="center">Copyright © 2001,2002 Apache Software Foundation.
|
|
|
|
|
All rights Reserved.</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
