@@ -11,9 +11,10 @@
<h1>Ant User Manual</h1> <h1>Ant User Manual</h1>
<p>by</p> <p>by</p>
<!-- Names are in alphabetical order, on last name -->
<ul> <ul>
<li>Arnout J. Kuiper (<a href="mailto:(ajkuiper@wxs.nl">ajkuiper@wxs.nl</a>)</li>
<li>James Duncan Davison (<a href="mailto:(duncan@x180.com">duncan@x180.com</a>)</li> <li>James Duncan Davison (<a href="mailto:(duncan@x180.com">duncan@x180.com</a>)</li>
<li>Arnout J. Kuiper (<a href="mailto:(ajkuiper@wxs.nl">ajkuiper@wxs.nl</a>)</li>
<li>Stefano Mazzocchi (<a href="mailto:(stefano@apache.org">stefano@apache.org</a>)</li> <li>Stefano Mazzocchi (<a href="mailto:(stefano@apache.org">stefano@apache.org</a>)</li>
</ul> </ul>
<p>Version 1.0.3 - 2000/02/06</p> <p>Version 1.0.3 - 2000/02/06</p>
@@ -644,11 +645,11 @@ preferred, because of speed.</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><cvs cvsRoot=":pserver:anoncvs@jakarta.apache.org:/home/cvspublic "
package="jakarta-tools" dest="${ws.dir}" /></code></p>
</blockquot e>
<p>This checks out the package/module "jakarta-tools" from the CVS
<pre> <cvs cvsRoot=":pserver:anoncvs@jakarta.apache.org:/home/cvspublic"
package="jakarta-tools "
dest="${ws.dir}"
/></pr e>
<p>checks out the package/module "jakarta-tools" from the CVS
repository pointed to by the cvsRoot attribute, and stores the files in "${ws.dir}".</p> repository pointed to by the cvsRoot attribute, and stores the files in "${ws.dir}".</p>
<hr> <hr>
<h2><a name="delete">Delete</a></h2> <h2><a name="delete">Delete</a></h2>
@@ -668,10 +669,10 @@ repository pointed to by the cvsRoot attribute, and stores the files in "${
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquot e>
<p><code><delete file="/lib/ant.jar" /></code> </p>
<p><code><delete file="${ant}" /></code></p >
</blockquote >
<pre> <delete file="/lib/ant.jar" /></pr e>
<p>deletes the file <code>/lib/ant.jar</code>. </p>
<pre> <delete file="${ant}" /></pre >
<p>deletes the file <code>${ant}</code>.</p >
<hr> <hr>
<h2><a name="deltree">Deltree</a></h2> <h2><a name="deltree">Deltree</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -690,10 +691,12 @@ repository pointed to by the cvsRoot attribute, and stores the files in "${
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><deltree dir="dist" /></code></p>
<p><code><deltree dir="${dist}" /></code></p>
</blockquote>
<pre> <deltree dir="dist" /></pre>
<p>deletes the directory <code>dist</code>, including its files and
subdirectories.</p>
<pre> <deltree dir="${dist}" /></pre>
<p>deletes the directory <code>${dist}</code>, including its files and
subdirectories.</p>
<hr> <hr>
<h2><a name="echo">Echo</a></h2> <h2><a name="echo">Echo</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -712,9 +715,7 @@ repository pointed to by the cvsRoot attribute, and stores the files in "${
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><echo message="Hello world" /></code></p>
</blockquote>
<pre> <echo message="Hello world" /></pre>
<hr> <hr>
<h2><a name="exec">Exec</a></h2> <h2><a name="exec">Exec</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -815,10 +816,8 @@ archive with http/ftp.</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><get src="http://jakarta.apache.org/" dest="help/index.html"
/></code></p>
</blockquote>
<pre> <get src="http://jakarta.apache.org/" dest="help/index.html" /></pre>
<p>gets the index page of http://jakarta.apache.org/, and stores it in the file <code>help/index.html</code>.</p>
<hr> <hr>
<h2><a name="gzip">GZip</a></h2> <h2><a name="gzip">GZip</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -995,13 +994,13 @@ the one that is currently running Ant.</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquot e>
<p><code><java class="test.Main" /></code></p >
<p><code><java class="test.Main" args="-h" /></code></p>
<p><code><java class="test.Main" args="-h"
fork="yes" jvmargs="-Xrunhprof:cpu=samples,file=log.txt,depth=3"
/></code></p>
</blockquot e>
<pre> <java class="test.Main" /></pr e>
<pre> <java class="test.Main" args="-h" /></pre >
<pre> <java class="test.Main"
args="-h"
fork="yes"
jvmargs="-Xrunhprof:cpu=samples,file=log.txt,depth=3"
/></pr e>
<hr> <hr>
<h2><a name="javac">Javac</a></h2> <h2><a name="javac">Javac</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -1395,18 +1394,16 @@ instead.</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<pre><javadoc packagenames="com.dummy.test.*"
sourcepath="src"
destdir="docs/api"
author="true"
version="true"
use="true"
windowtitle="Test API"
doctitle="<h1>Test</h1>"
bottom="<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>"
/></pre>
</blockquote>
<pre> <javadoc packagenames="com.dummy.test.*"
sourcepath="src"
destdir="docs/api"
author="true"
version="true"
use="true"
windowtitle="Test API"
doctitle="<h1>Test</h1>"
bottom="<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>"
/></pre>
<hr> <hr>
<h2><a name="keysubst">KeySubst</a></h2> <h2><a name="keysubst">KeySubst</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -1448,10 +1445,7 @@ separator, which might we changed with the <i>sep</i> attribute.</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><keysubst src="abc.txt" dest="def.txt"
keys="VERSION=1.0.3*DATE=2000-01-10" /></code></p>
</blockquote>
<pre> <keysubst src="abc.txt" dest="def.txt" keys="VERSION=1.0.3*DATE=2000-01-10" /></pre>
<hr> <hr>
<h2><a name="mkdir">Mkdir</a></h2> <h2><a name="mkdir">Mkdir</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -1471,10 +1465,10 @@ necessary.</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquot e>
<p><code><mkdir dir="${dist}" /></code> </p>
<p><code><mkdir dir="${dist}/lib" /></code></p >
</blockquote >
<pre><mkdir dir="${dist}" /></pr e>
<p>creates a directory <code>${dist}</code>. </p>
<pre><mkdir dir="${dist}/lib" /></pre >
<p>creates a directory <code>${dist}/lib</code>.</p >
<hr> <hr>
<h2><a name="property">Property</a></h2> <h2><a name="property">Property</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -1530,16 +1524,16 @@ This also holds for properties loaded from a property file.</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><property name="foo.dist" value="dist"/></code></p>
<p><code><property file="foo.properties" /></code></p>
<p><code><property resource="foo.properties" /></code></p>
</blockquote>
<pre> <property name="foo.dist" value="dist" /></pre>
<p>sets the property <code>foo.dist</code> to the value "dist".</p>
<pre> <property file="foo.properties" /></pre>
<p>reads a set of properties from a file called "foo.properties".</p>
<pre> <property resource="foo.properties" /></pre>
<p>reads a set of properties from a resource called "foo.properties".</p>
<hr> <hr>
<h2><a name="replace">Replace</a></h2> <h2><a name="replace">Replace</a></h2>
<h3>Description</h3> <h3>Description</h3>
<p>Replaces the occurrence of a given string with another string in a file. When
the <i>value</i> attribute is omitted, it defaults to "".</p>
<p>Replaces the occurrence of a given string with another string in a file.</p>
<h3>Parameters</h3> <h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0"> <table border="1" cellpadding="2" cellspacing="0">
<tr> <tr>
@@ -1549,25 +1543,25 @@ the <i>value</i> attribute is omitted, it defaults to "".</p>
</tr> </tr>
<tr> <tr>
<td valign="top">file</td> <td valign="top">file</td>
<td valign="top">file for which the token should be replaced</td>
<td valign="top">file for which the token should be replaced. </td>
<td valign="top" align="center">Yes</td> <td valign="top" align="center">Yes</td>
</tr> </tr>
<tr> <tr>
<td valign="top">token</td> <td valign="top">token</td>
<td valign="top">the token which must be replaced</td>
<td valign="top">the token which must be replaced. </td>
<td valign="top" align="center">Yes</td> <td valign="top" align="center">Yes</td>
</tr> </tr>
<tr> <tr>
<td valign="top">value</td> <td valign="top">value</td>
<td valign="top">the new value for the token</td>
<td valign="top">the new value for the token. When omitted, an empty string
("") is used.</td>
<td valign="top" align="center">No</td> <td valign="top" align="center">No</td>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><replace file="${src}/index.html" token="@@@"
value="wombat" /></code></p>
</blockquote>
<pre> <replace file="${src}/index.html" token="@@@" value="wombat" /></pre>
<p>replaces occurrences of the string "@@@" with the string
"wombat", in the file <code>${src}/index.html</code>.</p>
<hr> <hr>
<h2><a name="rmic">Rmic</a></h2> <h2><a name="rmic">Rmic</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -1591,10 +1585,9 @@ the <i>value</i> attribute is omitted, it defaults to "".</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><rmic class="com.xyz.FooBar"
base="${build}/classes" /></code></p>
</blockquote>
<pre> <rmic class="com.xyz.FooBar" base="${build}/classes" /></pre>
<p>runs the rmic compiler for the class <code>com.xyz.FooBar</code>. The
compiled files will be stored in the directory <code>${build}/classes</code>.</p>
<hr> <hr>
<h2><a name="taskdef">Taskdef</a></h2> <h2><a name="taskdef">Taskdef</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -1623,10 +1616,9 @@ href="#writingowntask">Writing your own task</a>".</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><taskdef name="myjavadoc" value="com.mydomain.JavadocTask"
/></code></p>
</blockquote>
<pre> <taskdef name="myjavadoc" value="com.mydomain.JavadocTask" /></pre>
<p>makes a task called <code>myjavadoc</code> available to Ant. The class <code>com.mydomain.JavadocTask</code>
implements the task.</p>
<hr> <hr>
<h2><a name="tstamp">Tstamp</a></h2> <h2><a name="tstamp">Tstamp</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -1646,9 +1638,7 @@ href="#inittarget">init target</a>.</p>
</tr> </tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<blockquote>
<p><code><tstamp/></code></p>
</blockquote>
<pre> <tstamp/></pre>
<hr> <hr>
<h2><a name="zip">Zip</a></h2> <h2><a name="zip">Zip</a></h2>
<h3>Description</h3> <h3>Description</h3>
@@ -1747,10 +1737,17 @@ or files with the name <code>todo.html</code> are excluded.</p>
in the <code>${dist}</code> directory. Only html files under the directory <code>api</code> in the <code>${dist}</code> directory. Only html files under the directory <code>api</code>
are zipped, and files with the name <code>todo.html</code> are excluded.</p> are zipped, and files with the name <code>todo.html</code> are excluded.</p>
<h3>Deprecated examples</h3> <h3>Deprecated examples</h3>
<pre> <zip zipfile="${dist}/manual.zip" basedir="htdocs/manual" items="*" /></pre>
<pre> <zip zipfile="${dist}/manual.zip"
basedir="htdocs/manual"
items="*"
/></pre>
<p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code> <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>
in the <code>${dist}</code> directory.</p> in the <code>${dist}</code> directory.</p>
<pre> <zip zipfile="${dist}/manual.zip" basedir="htdocs/manual" items="*" ignore="mydocs, todo.html"/></pre>
<pre> <zip zipfile="${dist}/manual.zip"
basedir="htdocs/manual"
items="*"
ignore="mydocs, todo.html"
/></pre>
<p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code> <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>
in the <code>${dist}</code> directory. Files/directories with the names <code>mydocs</code> in the <code>${dist}</code> directory. Files/directories with the names <code>mydocs</code>
and <code>todo.html</code> are excluded.</p> and <code>todo.html</code> are excluded.</p>
Arnout J. Kuiper