|
- <html>
-
- <head>
- <meta http-equiv="Content-Language" content="en-us">
- <title>Move Task</title>
- </head>
-
- <body>
-
- <h2><a name="move">Move</a></h2>
- <h3>Description</h3>
- <p>Moves a file to a new file or directory, or sets of files to
- a new directory. By default, the
- destination file is overwritten if it already exists. When <var>overwrite</var> is
- turned off, then files are only moved if the source file is newer than
- the destination file, or when the destination file does not exist.</p>
- <p><a href="../CoreTypes/fileset.html">FileSet</a>s are used to select sets of files
- to move to the <var>todir</var> directory.</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">file</td>
- <td valign="top">the file to move</td>
- <td valign="top" align="center">One of <var>file</var> or
- at least one nested fileset element</td>
- </tr>
- <tr>
- <td valign="top">tofile</td>
- <td valign="top">the file to move to</td>
- <td valign="top" align="center" rowspan="2">With the <var>file</var> attribute,
- either <var>tofile</var> or <var>todir</var> can be used. With nested filesets,
- if the fileset size is greater than 1 or if the only entry in the fileset is a
- directory or if the <var>file</var> attribute is already specified, only
- <var>todir</var> is allowed</td>
- </tr>
- <tr>
- <td valign="top">todir</td>
- <td valign="top">the directory to move to</td>
- </tr>
- <tr>
- <td valign="top">overwrite</td>
- <td valign="top">overwrite existing files even if the destination
- files are newer (default is "true")</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">filtering</td>
- <td valign="top">indicates whether token filtering should take place during
- the move. See the <a href="filter.html">filter</a> task for a description of
- how filters work.</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">flatten</td>
- <td valign="top">ignore directory structure of source directory,
- copy all files into a single directory, specified by the <var>todir</var>
- attribute (default is "false").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</td>
- </tr>
- <tr>
- <td valign="top">includeEmptyDirs</td>
- <td valign="top">Copy empty directories included with the nested FileSet(s).
- Defaults to "yes".</td>
- <td valign="top" align="center">No</td>
- </tr>
- </table>
- <h3>Parameters specified as nested elements</h3>
- <h4>mapper</h4>
- <p>You can define file name transformations by using a nested <a
- href="../CoreTypes/mapper.html">mapper</a> element. The default mapper used by
- <code><copy></code> is the <a
- href="../CoreTypes/mapper.html#identity-mapper">identity</a>.</p>
- <h4>filterchain</h4>
- <p>The Move task supports nested <a href="../CoreTypes/filterchain.html">
- FilterChain</a>s.</p>
-
- <p>
- If <filterset> and <filterchain> elements are used inside the
- same <move> task, all <filterchain> elements are processed first
- followed by <filterset> elements.
- </p>
-
- <h3>Examples</h3>
- <p><b>Move a single file (rename a file)</b></p>
- <pre>
- <move file="file.orig" tofile="file.moved"/>
- </pre>
- <p><b>Move a single file to a directory</b></p>
- <pre>
- <move file="file.orig" todir="dir/to/move/to"/>
- </pre>
- <p><b>Move a directory to a new directory</b></p>
- <pre>
- <move todir="new/dir/to/move/to">
- <fileset dir="src/dir"/>
- </move>
- </pre>
- <p><b>Move a set of files to a new directory</b></p>
- <pre>
- <move todir="some/new/dir">
- <fileset dir="my/src/dir">
- <include name="**/*.jar"/>
- <exclude name="**/ant.jar"/>
- </fileset>
- </move>
- </pre>
- <p><b>Append <code>".bak"</code> to the names of all files
- in a directory.</b></p>
- <pre>
- <move todir="my/src/dir">
- <fileset dir="my/src/dir">
- <exclude name="**/*.bak"/>
- </fileset>
- <mapper type="glob" from="*" to="*.bak"/>
- </move>
- </pre>
- <hr>
- <p align="center">Copyright © 2000-2002 Apache Software Foundation. All rights
- Reserved.</p>
-
- </body>
- </html>
|