You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by im...@apache.org on 2004/05/08 22:39:55 UTC
cvs commit: jakarta-commons-sandbox/vfs/xdocs anttasks.xml
imario 2004/05/08 13:39:55
Modified: vfs/xdocs anttasks.xml
Log:
added "tryRename" to allow to rename a file instead of copy/delete it. if rename is not possible the file is copied/deleted anyway.
Revision Changes Path
1.4 +68 -17 jakarta-commons-sandbox/vfs/xdocs/anttasks.xml
Index: anttasks.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/vfs/xdocs/anttasks.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- anttasks.xml 17 Mar 2003 09:07:11 -0000 1.3
+++ anttasks.xml 8 May 2004 20:39:55 -0000 1.4
@@ -13,32 +13,43 @@
</p>
<ul>
<li>
- <a href="#V-Copy"><code><v-copy></code></a>.
+ <a href="#V-Copy">
+ <code><v-copy></code>
+ </a>.
Copies a set of source folders and files to a destination
folder.
</li>
<li>
- <a href="#V-Delete"><code><v-delete></code></a>.
+ <a href="#V-Delete">
+ <code><v-delete></code>
+ </a>.
Deletes a file or folder.
</li>
<li>
- <a href="#V-Mkdir"><code><v-mkdir></code></a>.
+ <a href="#V-Mkdir">
+ <code><v-mkdir></code>
+ </a>.
Creates a folder.
</li>
<li>
- <a href="#V-Move"><code><v-move></code></a>.
+ <a href="#V-Move">
+ <code><v-move></code>
+ </a>.
Moves a set of source folders and files to a destination
folder.
</li>
<li>
- <a href="#V-Sync"><code><v-sync></code></a>.
+ <a href="#V-Sync">
+ <code><v-sync></code>
+ </a>.
Synchronises a destination folder with a set of source
folder and files.
</li>
</ul>
<p>
All file name attributes support relative and absolute local
- file names, and <a href="filesystems.html">absolute URI</a>.
+ file names, and
+ <a href="filesystems.html">absolute URI</a>.
File names are interpreted relative to the Ant project's base
directory.
</p>
@@ -46,13 +57,14 @@
<subsection name="Using the Tasks">
<p>
To use the Ant tasks, copy commons-jar.jar and its
- dependencies into the <code>$ANT_HOME/lib</code> directory,
+ dependencies into the
+ <code>$ANT_HOME/lib</code> directory,
and use the following in your Ant scipt to define the tasks:
</p>
<source><![CDATA[
<taskdef resource="/org/apache/commons/vfs/tasks/tasks.properties"/>
-]]></source>
+ ]]></source>
<p>
Alternatively, you can provide an explicit classpath when
@@ -63,7 +75,7 @@
<taskdef resource="/org/apache/commons/vfs/tasks/tasks.properties">
<classpath> ... </classpath>
</taskdef>
-]]></source>
+ ]]></source>
</subsection>
</section>
@@ -73,7 +85,11 @@
the source file. The copy task takes the following attributes:</p>
<table>
- <tr><th>Name</th><th>Description</th><th>Required</th></tr>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
<tr>
<td>destdir</td>
<td>The destination folder. This folder is created if it
@@ -89,14 +105,18 @@
<td>overwrite</td>
<td>Always copy files, ignoring the last-modified time of
the destination file.</td>
- <td>No, default is <code>false</code>.</td>
+ <td>No, default is
+ <code>false</code>.
+ </td>
</tr>
<tr>
<td>preservelastmodified</td>
<td>Set the last-modified time of destination files to
the same value as the source files. May not be supported
by the destination file system.</td>
- <td>No, default is <code>true</code>.</td>
+ <td>No, default is
+ <code>true</code>.
+ </td>
</tr>
<tr>
<td>src</td>
@@ -107,13 +127,21 @@
</table>
<subsection name="Nested Elements">
- <p><b><code><src></code></b></p>
+ <p>
+ <b>
+ <code><src></code>
+ </b>
+ </p>
<p>Defines a source file or folder to copy. It takes the
following attributes:</p>
<table>
- <tr><th>Name</th><th>Description</th><th>Required</th></tr>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
<tr>
<td>file</td>
<td>The source file.</td>
@@ -126,7 +154,22 @@
<section name="V-Move">
<p>Moves a set of files to a destination folder. Has the same
- attributes and elements as the copy task.</p>
+ attributes and elements as the copy task and following attributes:</p>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>tryRename</td>
+ <td>The destination folder. This folder is created if it
+ does not exist.</td>
+ <td>No, default is
+ <code>false</code>
+ </td>
+ </tr>
+ </table>
</section>
<section name="V-Sync">
@@ -138,7 +181,11 @@
<p>Deletes a file or folder. It takes the following attributes:</p>
<table>
- <tr><th>Name</th><th>Description</th><th>Required</th></tr>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
<tr>
<td>file</td>
<td>The file or folder to delete. All descendents of
@@ -152,7 +199,11 @@
<p>Creates a folder. It takes the following attributes:</p>
<table>
- <tr><th>Name</th><th>Description</th><th>Required</th></tr>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
<tr>
<td>dir</td>
<td>The folder create.</td>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org