youys
/
ant
Not watched
1
0
Fork 1
Code
Releases 0 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: a2ba0e964f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'a2ba0e964f'
${ noResults }
ant/docs/index.html

6193 lines
243 KiB
Raw Blame History 

  1. <html>

  2. 

  3. <head>

  4. <meta http-equiv="Content-Language" content="en-us">

  5. <title>Ant User Manual</title>

  6. </head>

  7. 

  8. <body>

  9. 

  10. <h1>Ant User Manual</h1>

  11. <p>by</p>

  12. <!-- Names are in alphabetical order, on last name -->

  13. <ul>

  14.   <li>Jacques Bergeron (<a href="mailto:jacques.bergeron@dogico.com">jacques.bergeron@dogico.com</a>)</li>

  15.   <li>Stefan Bodewig (<a href="mailto:stefan.bodewig@epost.de">stefan.bodewig@epost.de</a>)</li>

  16.   <li>Patrick Chanezon (<a href="mailto:chanezon@netscape.com">chanezon@netscape.com</a>)</li>

  17.   <li>James Duncan Davison (<a href="mailto:duncan@x180.com">duncan@x180.com</a>)</li>

  18.   <li>Tom Dimock (<a href="mailto:tad1@cornell.edu">tad1@cornell.edu</a>)</li>

  19.   <li>Bill Kelly (<a href="mailto:bill.kelly@softwired-inc.com">bill.kelly@softwired-inc.com</a>)</li>

  20.   <li>Arnout J. Kuiper (<a href="mailto:ajkuiper@wxs.nl">ajkuiper@wxs.nl</a>)</li>

  21.   <li>Conor MacNeill (<a href="mailto:conor@cortexebusiness.com.au">conor@cortexebusiness.com.au</a>)</li>

  22.   <li>Stefano Mazzocchi (<a href="mailto:stefano@apache.org">stefano@apache.org</a>)</li>

  23.   <li>Erik Meade (<a href="mailto:emeade@geekfarm.org">emeade@geekfarm.org</a>)</li>

  24.   <li>Sam Ruby (<a href="mailto:rubys@us.ibm.com">rubys@us.ibm.com</a>)</li>

  25.   <li>Nico Seessle (<a href="mailto:nico@seessle.de">nico@seessle.de</a>)</li>

  26.   <li>Jon S. Stevens (<a href="mailto:jon@latchkey.com">jon@latchkey.com</a>)</li>

  27.   <li>Roger Vaughn (<a href="mailto:rvaughn@seaconinc.com">rvaughn@seaconinc.com</a>)</li>

  28.   <li>Dave Walend (<a href="mailto:dwalend@cs.tufts.edu">dwalend@cs.tufts.edu</a>)</li>

  29. </ul>

  30. 

  31. <p>Version: @VERSION@</p>

  32. <p>$Id$</p>

  33. 

  34. <hr>

  35. <h2>Table of Contents</h2>

  36. <ul>

  37.   <li><a href="#introduction">Introduction</a></li>

  38.   <li><a href="#getting">Getting Ant</a></li>

  39.   <li><a href="#sysrequirements">System Requirements</a></li>

  40.   <li><a href="#buildingant">Building Ant</a></li>

  41.   <li><a href="#installing">Installing Ant</a></li>

  42.   <li><a href="#running">Running Ant</a></li>

  43.   <li><a href="#buildfile">Writing a simple buildfile</a>

  44.   <li><a href="#directorybasedtasks">Directory based tasks</a></li>

  45.   <li><a href="#tasks">Built in Tasks</a>

  46.   <li><a href="#optionaltasks">Optional Tasks</a>

  47.   <li><a href="#buildevents">Build Events</a>

  48.   <li><a href="#writingowntask">Writing your own task</a></li>

  49.   <li><a href="#faq">FAQ, DTD, external resources</a>

  50.   <li><a href="../LICENSE">License</a></li>

  51.   <li><a href="#feedback">Feedback</a></li>

  52. </ul>

  53. 

  54. <hr>

  55. <h2><a name="introduction">Introduction</a></h2>

  56. <p>Ant is a Java based build tool. In theory it is kind of like make without

  57. make's wrinkles.</p>

  58. <h3>Why?</h3>

  59. <p>Why another build tool when there is already make, gnumake, nmake, jam, and

  60. others? Because all of those tools have limitations that its original author

  61. couldn't live with when developing software across multiple platforms. Make like

  62. tools are inherently shell based. They evaluate a set of dependencies and then

  63. execute commands not unlike what you would issue on a shell. This means that you

  64. can easily extend these tools by using or writing any program for the OS that

  65. you are working on. However, this also means that you limit yourself to the OS,

  66. or at least the OS type such as Unix, that you are working on.</p>

  67. <p>Makefiles are inherently evil as well. Anybody who has worked on them for any

  68. time has run into the dreaded tab problem. &quot;Is my command not executing

  69. because I have a space in front of my tab!!!&quot; said the original author of

  70. Ant way too many times. Tools like Jam took care of this to a great degree, but

  71. still use yet another format to use and remember.</p>

  72. <p>Ant is different. Instead a model where it is extended with shell based

  73. commands, it is extended using Java classes. Instead of writing shell commands,

  74. the configuration files are XML based calling out a target tree where various

  75. tasks get executed. Each task is run by an object which implements a particular

  76. Task interface.</p>

  77. <p>Granted, this removes some of the expressive power that is inherent by being

  78. able to construct a shell command such as `find . -name foo -exec rm {}` but it

  79. gives you the ability to be cross platform. To work anywhere and everywhere. And

  80. hey, if you really need to execute a shell command, Ant has an exec rule that

  81. allows different commands to be executed based on the OS that it is executing

  82. on.</p>

  83. 

  84. <hr>

  85. <h2><a name="getting">Getting Ant</a></h2>

  86. <h3>Binary edition</h3>

  87. <p>The latest stable version of Ant can be downloaded from <a

  88. href="http://jakarta.apache.org/builds/ant/release/v1.2/bin/">

  89. http://jakarta.apache.org/builds/ant/release/v1.2/bin/</a>.

  90. If you like living on the edge, you can download the latest version from <a

  91. href="http://jakarta.apache.org/builds/ant/nightly/">http://jakarta.apache.org/builds/ant/nightly/</a>.</p>

  92. <h3>Source edition</h3>

  93. <p>If you prefer the source edition, you can download Ant from <a

  94. href="http://jakarta.apache.org/builds/ant/release/v1.2/src/">

  95. http://jakarta.apache.org/builds/ant/release/v1.2/src/</a>

  96. (latest stable) or from <a

  97. href="http://jakarta.apache.org/from-cvs/jakarta-tools/">http://jakarta.apache.org/from-cvs/jakarta-ant/</a>

  98. (current). See the section <a href="#buildingant">Building Ant</a> on how to

  99. build Ant from the source code.</p>

  100. 

  101. <hr>

  102. <h2><a name="sysrequirements">System Requirements</a></h2>

  103. <p>

  104.   To build and use ant you must have a JAXP compliant XML parser installed and available on your classpath.

  105.   <p>

  106.   If you do not have a JAXP compliant XML parse installed, you may use the reference implementation 

  107.   available from Sun. It is available from <a href="http://java.sun.com/xml/">http://java.sun.com/xml/</a>.

  108.   Once installed make sure the &quot;jaxp.jar&quot; and &quot;parser.jar&quot; files are in your classpath.

  109.   <p>

  110.   You will also need the JDK installed on your system, version 1.1 or later. 

  111.   </p>

  112. <hr>  

  113. <h2><a name="buildingant">Building Ant</a></h2>

  114. <p>Go to the directory <code>jakarta-ant</code>.</p>

  115. <p>Make sure the JDK is in you path.</p>

  116. <p>Set the JAVA_HOME environment variable. This should be set to the

  117. directory where the JDK is installed. See <a href="#installing">Installing Ant</a>

  118. for examples on how to do this for your operating system.</p>

  119. <p>Make sure you have downloaded any auxilliary jars required to build tasks you are interested in. The list of auxilliary tasks and requirements is in lib/README </p>

  120. <p>Run <code>bootstrap.bat</code> (Windows) or <code>bootstrap.sh</code> (UNIX)

  121. to build a bootstrap version of Ant.</p>

  122. <p>When finished, use</p>

  123. <blockquote>

  124.   <p><code>build.bat -Dant.dist.dir=&lt;directory to install Ant&gt; dist</code></p>

  125. </blockquote>

  126. <p>for Windows, and</p>

  127. <blockquote>

  128.   <p><code>build.sh -Dant.dist.dir=&lt;directory to install Ant&gt; dist</code></p>

  129. </blockquote>

  130. <p>for UNIX, to create a binary distribution of Ant. This distribution can be

  131. found in the directory you specified.</p>

  132. <hr>

  133. <h2><a name="installing">Installing Ant</a></h2>

  134. <p>The binary distribution of Ant consists of three directories: <code>bin</code>,

  135. <code>docs</code> and <code>lib</code>. Only the <code>bin</code> and <code>lib</code>

  136. directory are crucial for running Ant. To run Ant, the following must be done:</p>

  137. <ul>

  138.   <li>Add the <code>bin</code> directory to your path.</li>

  139.   <li>Set the ANT_HOME environment variable. This should be set to the directory

  140.     which contains the <code>bin</code> and <code>lib</code> directory.</li>

  141.   <li>Set the JAVA_HOME environment variable. This should be set to the

  142.     directory where the JDK is installed.</li>

  143. </ul>

  144. <h3>Windows</h3>

  145. <p>Assume Ant is installed in <code>c:\ant\</code>. The following sets up the

  146. environment:</p>

  147. <pre>set ANT_HOME=c:\ant

  148. set JAVA_HOME=c:\jdk1.2.2

  149. set PATH=%PATH%;%ANT_HOME%\bin</pre>

  150. <h3>Unix (bash)</h3>

  151. <p>Assume Ant is installed in <code>/usr/local/ant</code>. The following sets up

  152. the environment:</p>

  153. <pre>export ANT_HOME=/usr/local/ant

  154. export JAVA_HOME=/usr/local/jdk-1.2.2

  155. export PATH=${PATH}:${ANT_HOME}/bin</pre>

  156. <h3>Advanced</h3>

  157. <p>There are lots of variants that can be used to run Ant. What you need is at

  158. least the following:</p>

  159. <p>The classpath for Ant must contain <code>ant.jar</code> and any jars/classes 

  160. needed for your chosen JAXP compliant XML parser.</p>

  161. <p>When you need JDK functionality (like a <a href="#javac">javac</a> task, or a

  162. <a href="#rmic">rmic</a> task), then for JDK 1.1, the <code>classes.zip</code>

  163. file of the JDK must be added to the classpath; for JDK 1.2 or JDK 1.3, <code>tools.jar</code>

  164. must be added. The scripts supplied with ant, in the bin directory, will add 

  165. <code>tools.jar</code> automatically if the JAVA_HOME environment variable is set.</p>

  166. <p>When you are executing platform specific applications (like the <a

  167. href="#exec">exec</a> task, or the <a href="#cvs">cvs</a> task), the property <code>ant.home</code>

  168. must be set to the directory containing a bin directory, which contains the <code>antRun</code> 

  169. shell script necessary to run execs on Unix.</p>

  170. <hr>

  171. <h2><a name="running">Running Ant</a></h2>

  172. <p>Running Ant is simple, when you installed it as described in the previous

  173. section. Just type <code>ant</code>.</p>

  174. <p>When nothing is specified, Ant looks for a <code>build.xml</code>

  175. file in the current directory. When found, it uses that file as a

  176. buildfile, otherwise it searches in the parent directory and so on

  177. until the root of the filesystem has been reached. To make Ant use

  178. another buildfile, use the commandline option <i>-buildfile

  179. &lt;file&gt;</i>, where <i>&lt;file&gt;</i> is the buildfile you want

  180. to use.</p>

  181. <p>You can also set properties which override properties specified in the

  182. buildfile (see the <a href="#property">property task</a>). 

  183. This can be done with the <i>-D&lt;property&gt;=&lt;value&gt;</i>

  184. option, where <i>&lt;property&gt;</i> is the name of the property and <i>&lt;value&gt;</i>

  185. the value. This can also be used (and is the only way since Java can not access them) 

  186. to have access to your environment variables, just pass -DMYVAR=%MYVAR% (Windows) or

  187. -DMYVAR=$MYVAR (Unix) to Ant, you can then access these variables inside your build-file

  188. as ${MYVAR}.</p>

  189. <p>Two more options are <i>-quiet</i> which instructs Ant to print less

  190. information on the console when running. The option <i>-verbose</i> on the other

  191. hand makes Ant print more information on the console.</p>

  192. <p>It is also possible to specify one or more targets that should be executed. When omitted the target that is mentioned in the <i>default</i> attribute of the project is

  193. used.</p>

  194. <p>The <i>-projecthelp</i> option gives a list of this projects targets. First those with a description and then those without one.</p>

  195. <p>Commandline option summary:</p>

  196. <pre>ant [options] [target [target2 [target3] ...]]

  197. Options:

  198. -help                  print this message

  199. -projecthelp           print project help information

  200. -version               print the version information and exit

  201. -quiet                 be extra quiet

  202. -verbose               be extra verbose

  203. -debug                 print debugging information

  204. -emacs                 produce logging information without adornments

  205. -logfile &lt;file&gt;        use given file for log

  206. -logger &lt;classname&gt;    the class which is to perform logging

  207. -listener &lt;classname&gt;  add an instance of class as a project listener

  208. -buildfile &lt;file&gt;      use given buildfile

  209. -find &lt;file&gt;           search for buildfile towards the root of the filesystem and use it

  210. -D&lt;property&gt;=&lt;value&gt;   use value for given property</pre>

  211. <h3>Examples</h3>

  212. <blockquote>

  213.   <pre>ant</pre>

  214. </blockquote>

  215. <p>runs Ant using the <code>build.xml</code> file in the current directory, on

  216. the default target.</p>

  217. <blockquote>

  218.   <pre>ant -buildfile test.xml</pre>

  219. </blockquote>

  220. <p>runs Ant using the <code>test.xml</code> file in the current directory, on

  221. the default target.</p>

  222. <blockquote>

  223.   <pre>ant -buildfile test.xml dist</pre>

  224. </blockquote>

  225. <p>runs Ant using the <code>test.xml</code> file in the current directory, on a

  226. target called <code>dist</code>.</p>

  227. <blockquote>

  228.   <pre>ant -buildfile test.xml -Dbuild=build/classes dist</pre>

  229. </blockquote>

  230. <p>runs Ant using the <code>test.xml</code> file in the current directory, on a

  231. target called <code>dist</code>. It also sets the <i>build</i> property to the

  232. value <i>build/classes</i>.</p>

  233. <h3>Running Ant by hand</h3>

  234. <p>When you have installed Ant in the do-it-yourself way, Ant can be started

  235. with:</p>

  236. <blockquote>

  237.   <pre>java -Dant.home=c:\ant org.apache.tools.ant.Main [options] [target]</pre>

  238. </blockquote>

  239. 

  240. <p>These instructions actually do exactly the same as the <code>ant</code>

  241. command. The options and target are the same as when running Ant with the <code>ant</code>

  242. command. This example assumes you have set up your classpath to include

  243. <ul>

  244. <li>ant.jar

  245. <li>jars/classes for your XML parser

  246. <li>the JDK's tools.jar

  247. </ul>

  248. <hr>

  249. <h2><a name="buildfile">Writing a simple buildfile</a></h2>

  250. <p>The buildfile is written in XML. Each buildfile contains one project.</p>

  251. <p>Each element of the buildfile can have an <code>id</code> attribute and

  252. can later be referred to by the value supplied to this. The value has

  253. to be unique.</p>

  254. <h3>Projects</h3>

  255. <p>A project has three attributes:</p>

  256. <table border="1" cellpadding="2" cellspacing="0">

  257.   <tr>

  258.     <td valign="top"><b>Attribute</b></td>

  259.     <td valign="top"><b>Description</b></td>

  260.     <td align="center" valign="top"><b>Required</b></td>

  261.   </tr>

  262.   <tr>

  263.     <td valign="top">name</td>

  264.     <td valign="top">the name of the project.</td>

  265.     <td align="center" valign="top">No</td>

  266.   </tr>

  267.   <tr>

  268.     <td valign="top">default</td>

  269.     <td valign="top">the default target to use when no target is supplied.</td>

  270.     <td align="center" valign="top">Yes</td>

  271.   </tr>

  272.   <tr>

  273.     <td valign="top">basedir</td>

  274.     <td valign="top">the base directory from which all path calculations are

  275.       done. This attribute might be overridden by setting the &quot;basedir&quot;

  276.       property on forehand. When this is done, it must be omitted in the

  277.       project tag. If neither the attribute not the property have

  278.       been set, the parent directory of the build file will be used.</td>

  279.     <td align="center" valign="top">No</td>

  280.   </tr>

  281. </table>

  282. <p>Each project defines one or more targets. A target is a set of tasks you want

  283. to be executed. When starting Ant, you can select which target you want to have

  284. executed. When no target is given, the project's default is used.</p>

  285. <h3>Targets</h3>

  286. <p>A target can depend on other targets. You might have a target for compiling,

  287. for instance, and a target for creating a distributable. You can only build a

  288. distributable when you have compiled first, so the distribute target depends on

  289. the compile target. Ant resolves all these dependencies.</p>

  290. <p>Ant tries to execute the targets in the <i>depends</i> attribute in the order

  291. they appear (from left to right). Keep in mind that it is possible that a target

  292. can get executed earlier when an earlier target depends on it:</p>

  293. <blockquote>

  294. <pre>&lt;target name=&quot;A&quot;/&gt;

  295. &lt;target name=&quot;B&quot; depends=&quot;A&quot;/&gt;

  296. &lt;target name=&quot;C&quot; depends=&quot;B&quot;/&gt;

  297. &lt;target name=&quot;D&quot; depends=&quot;C,B,A&quot;/&gt;</pre>

  298. </blockquote>

  299. <p>Suppose we want to execute target D. From its <i>depends</i> attribute, you

  300. might think that first target C, then B and then A is executed. Wrong! C depends

  301. on B, and B depends on A, so first A is executed, then B, then C, and finally D.</p>

  302. <p>A target gets executed only once. Even when more targets depend on it (see

  303. the previous example).</p>

  304. <p>A target has also the ability to perform its execution if (or

  305. unless) a property has been set. This allows, for example, better

  306. control on the building process depending on the state of the system

  307. (java version, OS, command line properties, etc...).  To make target

  308. <i>sense</i> this property you should add the <i>if</i> (or

  309. <i>unless</i>) attribute with the name of the property that the target

  310. should react to, for example</p>

  311. <blockquote>

  312.   <pre>&lt;target name=&quot;build-module-A&quot; if=&quot;module-A-present&quot;/&gt;</pre>

  313.   <pre>&lt;target name=&quot;build-own-fake-module-A&quot; unless=&quot;module-A-present&quot;/&gt;</pre>

  314. </blockquote>

  315. <p>If no <i>if</i> and no <i>unless</i> attribute is present, the target will 

  316. always be executed.</p>

  317. <p>It is a good practice to place your <a

  318. href="#tstamp">tstamp</a> tasks in a so called initialization target, on which

  319. all other targets depend. Make sure that target is always the first one in

  320. the depends list of the other targets. In this manual, most initialization targets

  321. have the name &quot;init&quot;.</p>

  322. <p>The optional <i>description</i> attribute can be used to provide a one line description of this target that is printed by the <i>-projecthelp</i> commandline option.</p>

  323. <p>A target has the following attributes:</p>

  324. <table border="1" cellpadding="2" cellspacing="0">

  325.   <tr>

  326.     <td valign="top"><b>Attribute</b></td>

  327.     <td valign="top"><b>Description</b></td>

  328.     <td align="center" valign="top"><b>Required</b></td>

  329.   </tr>

  330.   <tr>

  331.     <td valign="top">name</td>

  332.     <td valign="top">the name of the target.</td>

  333.     <td align="center" valign="top">Yes</td>

  334.   </tr>

  335.   <tr>

  336.     <td valign="top">depends</td>

  337.     <td valign="top">a comma separated list of names of targets on which this

  338.       target depends.</td>

  339.     <td align="center" valign="top">No</td>

  340.   </tr>

  341.   <tr>

  342.     <td valign="top">if</td>

  343.     <td valign="top">the name of the property that must be set in order for this

  344.       target to execute.</td>

  345.     <td align="center" valign="top">No</td>

  346.   </tr>

  347.   <tr>

  348.     <td valign="top">unless</td>

  349.     <td valign="top">the name of the property that must not be set in order 

  350.       for this target to execute.</td>

  351.     <td align="center" valign="top">No</td>

  352.   </tr>

  353.   <tr>

  354.     <td valign="top">description</td>

  355.     <td valign="top">a short description of this targets function.</td>

  356.     <td align="center" valign="top">No</td>

  357.   </tr>

  358. </table>

  359. <h3>Tasks</h3>

  360. <p>A task is a piece of code that can be executed.</p>

  361. <p>A task can have multiple attributes (or arguments if you prefer). The value

  362. of an attribute might contain references to a property. These references will be

  363. resolved before the task is executed.</p>

  364. <p>Tasks have a common structure:</p>

  365. <blockquote>

  366.   <pre>&lt;name attribute1=&quot;value1&quot; attribute2=&quot;value2&quot; ... /&gt;</pre>

  367. </blockquote>

  368. <p>where name is the name of the task, attribute-x the attribute name, and

  369. value-x the value of this attribute.</p>

  370. <p>There is a set of <a href="#tasks">built in tasks</a>, but it is also very

  371. easy to <a href="#writingowntask">write your own</a>.</p>

  372. <p>All tasks share a <code>taskname</code> attribute. The value of

  373. this attribute will be used in the logging messages generated by

  374. Ant.</p>

  375. <h3>Properties</h3>

  376. <p>A project can have a set of properties. These might be set in the buildfile

  377. by the <a href="#property">property task</a>, or might be set outside Ant. A

  378. property has a name and a value. Properties might be used in in the value of

  379. task attributes. This is done by placing the property name between

  380. &quot;${&quot; and &quot;}&quot; in the attribute value.</p>

  381. <p>If there is a property called &quot;builddir&quot; with the value

  382. &quot;build&quot;, then this could be used in an attribute like this: &quot;${builddir}/classes&quot;.

  383. This is resolved as &quot;build/classes&quot;.</p>

  384. <h3>Built in Properties</h3>

  385. <p>Ant provides access to all system properties as if they had been

  386. defined using a property task, for example ${os.name} expands to the

  387. name of the operating system.</p>

  388. <p>In addition Ant knows some built in properties:</p>

  389. <ul>

  390.   <li>basedir - the absolute path of the project's basedir (as set

  391.     with the basedir attribute of &lt;project&gt;).</li>

  392.   <li>ant.file - the absolute path of the build file.</li>

  393.   <li>ant.project.name - the name of the project that is currently executing. It is 

  394.       set by the name attribute in project tag of build file.</li>

  395.   <li>ant.java.version - the JVM version Ant detected. Currently it

  396.     can hold the values &quot;1.1&quot;, &quot;1.2&quot; and

  397.     &quot;1.3&quot;.</li>

  398. </ul>

  399. <h3>Example</h3>

  400. <blockquote>

  401.   <pre>

  402. &lt;project name=&quot;MyProject&quot; default=&quot;dist&quot; basedir=&quot;.&quot;&gt;

  403. 

  404.   &lt;!-- set global properties for this build --&gt;

  405.   &lt;property name=&quot;src&quot; value=&quot;.&quot; /&gt;

  406.   &lt;property name=&quot;build&quot; value=&quot;build&quot; /&gt;

  407.   &lt;property name=&quot;dist&quot;  value=&quot;dist&quot; /&gt;

  408. 

  409.   &lt;target name=&quot;prepare&quot;&gt;

  410.     &lt;!-- Create the time stamp --&gt;

  411.     &lt;tstamp/&gt;

  412.     &lt;!-- Create the build directory structure used by compile --&gt;

  413.     &lt;mkdir dir=&quot;${build}&quot; /&gt;

  414.   &lt;/target&gt;

  415. 

  416.   &lt;target name=&quot;compile&quot; depends=&quot;prepare&quot;&gt;

  417.     &lt;!-- Compile the java code from ${src} into ${build} --&gt;

  418.     &lt;javac srcdir=&quot;${src}&quot; destdir=&quot;${build}&quot; /&gt;

  419.   &lt;/target&gt;

  420. 

  421.   &lt;target name=&quot;dist&quot; depends=&quot;compile&quot;&gt;

  422.     &lt;!-- Create the ${dist}/lib directory --&gt;

  423.     &lt;mkdir dir=&quot;${dist}/lib&quot; /&gt;

  424. 

  425.     &lt;!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file --&gt;

  426.     &lt;jar jarfile=&quot;${dist}/lib/MyProject-${DSTAMP}.jar&quot; basedir=&quot;${build}&quot; /&gt;

  427.   &lt;/target&gt;

  428. 

  429.   &lt;target name=&quot;clean&quot;&gt;

  430.     &lt;!-- Delete the ${build} and ${dist} directory trees --&gt;

  431.     &lt;delete dir=&quot;${build}&quot; /&gt;

  432.     &lt;delete dir=&quot;${dist}&quot; /&gt;

  433.   &lt;/target&gt;

  434. &lt;/project&gt;

  435.   </pre>

  436. </blockquote>

  437. 

  438. <h3>Token Filters</h3>

  439. <p>A project can have a set of tokens that might be automatically expanded if

  440. found when a file is copied, when the filtering-copy behavior is selected in the

  441. tasks that support this. These might be set in the buildfile

  442. by the <a href="#filter">filter task</a>.&nbsp;</p>

  443. <p>Since this can be a very harmful behavior, the tokens in the files <b>must</b>

  444. be of the form<i> @token@</i> where <i>token</i> is the token name that is set

  445. in the filter task. This token syntax matches the syntax of other build systems

  446. that perform such filtering and remains sufficiently orthogonal to most

  447. programming and scripting languages, as well with documentation systems.</p>

  448. <p>Note: in case a token with the format @token@ is found in a file but no

  449. filter is associated with that token, no changes take place. So, no escaping

  450. method is present, but as long as you choose appropriate names for your tokens,

  451. this should not cause problems.</p>

  452. 

  453. <h3><a name="path">PATH like structures</a></h3>

  454. <p>You can specify PATH and CLASSPATH variables using both

  455. &quot;:&quot; and &quot;;&quot; as separator characters, Ant will

  456. convert it to the correct character of the current operating

  457. system.</p>

  458. <p>Wherever PATH like values need to be specified a nested element can

  459. be used. This takes the general form of</p>

  460. <pre>

  461.     &lt;classpath&gt;

  462.       &lt;pathelement path=&quot;${classpath}&quot; /&gt;

  463.       &lt;pathelement location=&quot;lib/helper.jar&quot; /&gt;

  464.     &lt;/classpath&gt;

  465. </pre>

  466. <p>The <code>location</code> attribute specifies a single file or

  467. directory relative to the project's base directory (or an absolute

  468. filename), while the <code>path</code> attribute accepts &quot;:&quot;

  469. or &quot;;&quot; separated lists of locations. The <code>path</code>

  470. attribute is intended to be used with predefined paths - in any other

  471. case multiple elements with <code>location</code> attributes should be

  472. preferred.</p>

  473. <p>As a shortcut the surrounding PATH element supports path and

  474. location attributes of its own, so</p>

  475. <pre>

  476.     &lt;classpath&gt;

  477.       &lt;pathelement path=&quot;${classpath}&quot; /&gt;

  478.     &lt;/classpath&gt;

  479. </pre>

  480. <p>can be abreviated to</p>

  481. <pre>

  482.     &lt;classpath path=&quot;${classpath}&quot; /&gt;

  483. </pre>

  484. <p>In addition, <a href="#fileset">FileSet</a>s can be specified via

  485. nested <code>&lt;fileset&gt;</code> elements. The order in which the files

  486. building up FileSet are added to the PATH like structure is not

  487. defined.</p>

  488. <pre>

  489.     &lt;classpath&gt;

  490.       &lt;pathelement path=&quot;${classpath}&quot; /&gt;

  491.       &lt;fileset dir=&quot;lib&quot;&gt;

  492.         &lt;include name=&quot;**/*.jar&quot; /&gt;

  493.       &lt;/fileset&gt;

  494.       &lt;pathelement location=&quot;classes&quot; /&gt;

  495.     &lt;/classpath&gt;

  496. </pre>

  497. <p>Builds a PATH which holds the value of <code>${classpath}</code>

  498. followed by all JAR files in the <code>lib</code> directory, followed

  499. by the <code>classes</code> directory.</p>

  500. <p>If you want to use the same PATH like structure for several tasks,

  501. you can define them with a <code>&lt;path&gt;</code> element at the

  502. same level as <em>target</em>s and reference them via their

  503. <em>id</em> attribute - see <a href="#references">References</a> for an

  504. example.</p>

  505. <p>A PATH like structure can include a reference to another PATH like

  506. structure via a nested <code>&lt;path&gt;</code> elements.</p>

  507. <pre>

  508.     &lt;path id=&quot;base.path&quot;&gt;

  509.       &lt;pathelement path=&quot;${classpath}&quot; /&gt;

  510.       &lt;fileset dir=&quot;lib&quot;&gt;

  511.         &lt;include name=&quot;**/*.jar&quot; /&gt;

  512.       &lt;/fileset&gt;

  513.       &lt;pathelement location=&quot;classes&quot; /&gt;

  514.     &lt;/path&gt;

  515. 

  516.     &lt;path id=&quot;tests.path&quot;&gt;

  517.       &lt;path refid=&quot;base.path&quot; /&gt;

  518.       &lt;pathelement location=&quot;testclasses&quot; /&gt;

  519.     &lt;/path&gt;

  520. </pre>

  521. 

  522. <h3><a name="arg">Command line arguments</a></h3>

  523. 

  524. <p>Several tasks take arguments that shall be passed to another

  525. process on the command line. To make it easier to specify arguments

  526. that contain space characters, nested elements can be used.</p>

  527. <table border="1" cellpadding="2" cellspacing="0">

  528. <tr>

  529.   <td width="12%" valign="top"><b>Attribute</b></td>

  530.   <td width="78%" valign="top"><b>Description</b></td>

  531.   <td width="10%" valign="top"><b>Required</b></td>

  532. </tr>

  533.   <tr>

  534.     <td valign="top">value</td> 

  535.     <td valign="top">a single command line argument, can contain space

  536.       characters.</td>

  537.     <td align="center" rowspan="4">Exactly one of these.</td>

  538.   </tr>

  539.   <tr>

  540.     <td valign="top">line</td> 

  541.     <td valign="top">a space delimited list of command line arguments.</td>

  542.   </tr>

  543.   <tr>

  544.     <td valign="top">file</td> 

  545.     <td valign="top">The name of a file as a single command line

  546.       argument. Will be replaced with the absolute filename of the file

  547.       by Ant.</td>

  548.   </tr>

  549.   <tr>

  550.     <td valign="top">path</td> 

  551.     <td valign="top">A string that shall be treated as a PATH like

  552.       string as a single command line argument. You can use ; or : as

  553.       path separators and Ant will convert it to the platform's local

  554.       conventions.</td>

  555.   </tr>

  556. </table>

  557. <h4>Examples</h4>

  558. <blockquote><pre>

  559.   &lt;arg value=&quot;-l -a&quot; /&gt;

  560. </pre></blockquote>

  561. <p>is a single command line argument containing a space character.</p>

  562. <blockquote><pre>

  563.   &lt;arg line=&quot;-l -a&quot; /&gt;

  564. </pre></blockquote>

  565. <p>stands for two separate command line arguments.</p>

  566. <blockquote><pre>

  567.   &lt;arg path=&quot;/dir;/dir2:\dir3&quot; /&gt;

  568. </pre></blockquote>

  569. <p>is a single command line argument with value

  570. <code>\dir;\dir2;\dir3</code> on DOS based systems and

  571. <code>/dir:/dir2:/dir3</code> on Unix like systems.</p>

  572. <h3><a name="references">References</a></h3>

  573. <p>The <code>id</code> attribute of the buildfile's elements can be

  574. used to refer to them. This can useful if you are going to replicate

  575. the same snippet of XML over and over again - using a

  576. <code>&lt;classpath&gt;</code> structure more than once for

  577. example.</p>

  578. <p>The following example</p>

  579. <blockquote><pre>

  580. &lt;project ... &gt;

  581.   &lt;target ... &gt;

  582.     &lt;rmic ...&gt;

  583.       &lt;classpath&gt;

  584.         &lt;pathelement location=&quot;lib/&quot; /&gt;

  585.         &lt;pathelement path=&quot;${java.class.path}/&quot; /&gt;

  586.         &lt;pathelement path=&quot;${additional.path}&quot; /&gt;

  587.       &lt;/classpath&gt;

  588.     &lt;/rmic&gt;

  589.   &lt;/target&gt;

  590. 

  591.   &lt;target ... &gt;

  592.     &lt;javac ...&gt;

  593.       &lt;classpath&gt;

  594.         &lt;pathelement location=&quot;lib/&quot; /&gt;

  595.         &lt;pathelement path=&quot;${java.class.path}/&quot; /&gt;

  596.         &lt;pathelement path=&quot;${additional.path}&quot; /&gt;

  597.       &lt;/classpath&gt;

  598.     &lt;/javac&gt;

  599.   &lt;/target&gt;

  600. &lt;/project&gt;

  601. </pre></blockquote>

  602. <p>could be rewritten as</p>

  603. <blockquote><pre>

  604. &lt;project ... &gt;

  605.   &lt;path id=&quot;project.class.path&quot;&gt;

  606.     &lt;pathelement location=&quot;lib/&quot; /&gt;

  607.     &lt;pathelement path=&quot;${java.class.path}/&quot; /&gt;

  608.     &lt;pathelement path=&quot;${additional.path}&quot; /&gt;

  609.   &lt;/path&gt;

  610. 

  611.   &lt;target ... &gt;

  612.     &lt;rmic ...&gt;

  613.       &lt;classpath refid=&quot;project.class.path&quot; /&gt;

  614.     &lt;/rmic&gt;

  615.   &lt;/target&gt;

  616. 

  617.   &lt;target ... &gt;

  618.     &lt;javac ...&gt;

  619.       &lt;classpath refid=&quot;project.class.path&quot; /&gt;

  620.     &lt;/javac&gt;

  621.   &lt;/target&gt;

  622. &lt;/project&gt;

  623. </pre></blockquote>

  624. <p>All tasks that use nested elements for <a

  625. href="#patternset">PatternSet</a>s, <a href="#fileset">FileSet</a>s or

  626. <a href="#path">PATH like structures</a> accept references to these

  627. structures as well.</p>

  628. <hr>

  629. <h2><a name="directorybasedtasks">Directory based tasks</a></h2>

  630. <p>Some tasks use directory trees for the task they perform. For instance, the <a

  631. href="#javac">Javac task</a> which works upon a directory tree with .java files.

  632. Sometimes it can be very useful to work on a subset of that directory tree. This

  633. section describes how you can select a subset of such a directory tree.</p>

  634. <p>Ant gives you two ways to create a subset, both of which can be used at the same

  635. time:</p>

  636. <ul>

  637.   <li>Only include files/directories that match at least one pattern of a set of

  638.     patterns</li>

  639.   <li>Exclude files/directories that match at least one pattern a set of

  640.     patterns</li>

  641. </ul>

  642. <p>When both inclusion and exclusion are used, only files/directories that match

  643. the include patterns, and don't match the exclude patterns are used.</p>

  644. <p>Patterns can be specified inside the buildfile via task attributes or

  645. nested elements and via external files. Each line of the external file

  646. is taken as pattern that is added to the list of include or exclude 

  647. patterns.</p>

  648. <h3>Patterns</h3>

  649. <p>As described earlier, patterns are used for the inclusion and exclusion.

  650. These patterns look very much like the patterns used in DOS and UNIX:</p>

  651. <p>'*' matches zero or more characters, '?' matches one character.</p>

  652. <p>Examples:</p>

  653. <p>'*.java' matches '.java', 'x.java' and 'FooBar.java', but not 'FooBar.xml'

  654. (does not end with '.java').</p>

  655. <p>'?.java' matches 'x.java', 'A.java', but not '.java' or 'xyz.java' (both

  656. don't have one character before '.java').</p>

  657. <p>Combinations of '*'s and '?'s are allowed.</p>

  658. <p>Matching is done per-directory. This means that first the first directory in

  659. the pattern is matched against the first directory in the path to match. Then

  660. the second directories are matched, and so on. E.g. when we have the pattern '/?abc/*/*.java'

  661. and the path '/xabc/foobar/test.java', then first '?abc' is matched with 'xabc',

  662. then '*' is matched with 'foobar' and finally '*.java' is matched with 'test.java'.

  663. They all match so the path matches the pattern.</p>

  664. <p>Too make things a bit more flexible, we add one extra feature, which makes it

  665. possible to match multiple directory levels. This can be used to match a

  666. complete directory tree, or a file anywhere in the directory tree. To do this, '**'

  667. must be used as the name of a directory. When '**' is used as the name of a

  668. directory in the pattern, it matches zero or more directories. For instance:

  669. '/test/**' matches all files/directories under '/test/', such as '/test/x.java',

  670. or '/test/foo/bar/xyz.html', but not '/xyz.xml'.</p>

  671. <p>There is one &quot;shorthand&quot;, if a pattern ends with '/' or '\', then '**'

  672. is appended. E.g. &quot;mypackage/test/&quot; is interpreted as were it &quot;mypackage/test/**&quot;.</p>

  673. <p>Examples:</p>

  674. <table border="1" cellpadding="2" cellspacing="0">

  675.   <tr>

  676.     <td valign="top">**/CVS/*</td>

  677.     <td valign="top">Matches all files in CVS directories, that can be located

  678.       anywhere in the directory tree.

  679.       <p>Matches:</p>

  680.       <p>CVS/Repository<br>

  681.       org/apache/CVS/Entries<br>

  682.       org/apache/jakarta/tools/ant/CVS/Entries</p>

  683.       <p>But not:</p>

  684.       <p>org/apache/CVS/foo/bar/Entries ('foo/bar/' part does not match)</td>

  685.   </tr>

  686.   <tr>

  687.     <td valign="top">org/apache/jakarta/**</td>

  688.     <td valign="top">Matches all files in the org/apache/jakarta directory tree.

  689.       <p>Matches:</p>

  690.       <p>org/apache/jakarta/tools/ant/docs/index.html<br>

  691.       org/apache/jakarta/test.xml</p>

  692.       <p>But not:</p>

  693.       <p>org/apache/xyz.java ('jakarta'/' part is missing)</td>

  694.   </tr>

  695.   <tr>

  696.     <td valign="top">org/apache/**/CVS/*</td>

  697.     <td valign="top">Matches all files in CVS directories, that are located

  698.       anywhere in the directory tree under org/apache.

  699.       <p>Matches:</p>

  700.       <p>org/apache/CVS/Entries<br>

  701.       org/apache/jakarta/tools/ant/CVS/Entries</p>

  702.       <p>But not:</p>

  703.       <p>org/apache/CVS/foo/bar/Entries ('foo/bar/' part does not match)</td>

  704.   </tr>

  705.   <tr>

  706.     <td valign="top">**/test/**</td>

  707.     <td valign="top">Matches all files which have a directory 'test' in their

  708.       path, including 'test' as a filename.</td>

  709.   </tr>

  710. </table>

  711. <p>When these patterns are used in inclusion and exclusion, you have a powerful

  712. way to select just the files you want.</p>

  713. <h3>Examples</h3>

  714. <pre>  

  715. &lt;copy todir=&quot;${dist}&quot; >

  716.   &lt;fileset dir=&quot;${src}&quot; 

  717.            includes=&quot;**/images/*&quot; 

  718.            excludes=&quot;**/*.gif&quot; 

  719.   /&gt;

  720. &lt;/copy&gt;</pre>

  721. <p>This copies all files in directories called &quot;images&quot;, that are

  722. located in the directory tree &quot;${src}&quot; to the destination &quot;${dist}&quot;,

  723. but excludes all &quot;*.gif&quot; files from the copy.</p>

  724. <p> This example can also be expressed using nested elements as

  725. <pre>

  726. &lt;copy todir=&quot;${dist}&quot; >

  727.   &lt;fileset dir=&quot;${src}&quot; /&gt;

  728.     &lt;include name=&quot;**/images/*&quot;/&gt;

  729.     &lt;exclude name=&quot;**/*.gif&quot; /&gt;

  730.   &lt;/fileset&gt;

  731. &lt;/copy&gt;

  732. </pre>

  733. 

  734. <h3>Default Excludes</h3>

  735. <p>There are a set of definitions which are excluded by default from all directory based tasks.

  736. They are:

  737. <pre>        &quot;**/*~&quot;,

  738.         &quot;**/#*#&quot;,

  739.         &quot;**/%*%&quot;,

  740.         &quot;**/CVS&quot;,

  741.         &quot;**/CVS/**&quot;,

  742.         &quot;**/.cvsignore&quot;

  743. </pre>

  744. If you do not want these default excludes applied, you may disable them with the 

  745. <code>defaultexcludes=&quot;no&quot;</code> attribute.

  746. <h3><a name="patternset">PatternSets</a></h3>

  747. <p>Patterns can be grouped to sets and later be referenced by their id

  748. attribute. They are defined via a <code>patternset</code> element -

  749. which can appear nested into a <a href="#fileset">FileSet</a> or a

  750. directory based task that constitutes an implicit FileSet. In addition

  751. <code>patternset</code>s can be defined at the same level as

  752. <code>target</code> - i.e. as children of <code>project</code></p>

  753. <p>Patterns can be specified by nested <code>&lt;include&gt;</code> or

  754. <code>&lt;exclude&gt;</code> elements or the following attributes.</p>

  755. <table border="1" cellpadding="2" cellspacing="0">

  756.   <tr>

  757.     <td valign="top"><b>Attribute</b></td>

  758.     <td valign="top"><b>Description</b></td>

  759.   </tr>

  760.   <tr>

  761.     <td valign="top">includes</td>

  762.     <td valign="top">comma separated list of patterns of files that must be

  763.       included. All files are included when omitted.</td>

  764.   </tr>

  765.   <tr>

  766.     <td valign="top">includesfile</td>

  767.     <td valign="top">the name of a file. Each line of this file is

  768.       taken to be an include pattern</td>

  769.   </tr>

  770.   <tr>

  771.     <td valign="top">excludes</td>

  772.     <td valign="top">comma separated list of patterns of files that must be

  773.       excluded. No files (except default excludes) are excluded when omitted.</td>

  774.   </tr>

  775.   <tr>

  776.     <td valign="top">excludesfile</td>

  777.     <td valign="top">the name of a file. Each line of this file is

  778.       taken to be an exclude pattern</td>

  779.   </tr>

  780. </table>

  781. <h4>Examples</h4>

  782. <blockquote><pre>

  783. &lt;patternset id=&quot;non.test.sources&quot; &gt;

  784.   &lt;include name=&quot;**/*.java&quot; /&gt;

  785.   &lt;exclude name=&quot;**/*Test*&quot; /&gt;

  786. &lt;/patternset&gt;

  787. </pre></blockquote>

  788. <p>Builds a set of patterns, that matches all <code>.java</code> files

  789. that do not contain the text <code>Test</code> in their name. This set

  790. can be <a href="#references">referred</a> to via

  791. <code>&lt;patternset refid=&quot;non.test.sources&quot;

  792. /&gt;</code> by tasks that support this feature or by FileSets.</p>

  793. <p>Note that while the includes and excludes attributes accept

  794. multiple elements separated by commas or spaces, the nested

  795. &lt;include&gt; and &lt;exclude&gt; elements expect their name

  796. attribute to hold a single pattern.</p>

  797. <h3><a name="fileset">FileSets</a></h3>

  798. <p>FileSets are groups of files. These files can be found in a

  799. directory tree starting in a base directory and are matched by

  800. patterns taken from a number of <a

  801. href="#patternset">PatternSets</a>. FileSets can appear inside task

  802. that support this feature or at the same level as <code>target</code>

  803. - i.e. as children of <code>project</code>.</p>

  804. <p>PatternSets can be specified as nested

  805. <code>&lt;patternset&gt;</code> 

  806. elements. In addition FileSet holds an implicit PatternSet and

  807. supports the nested <code>&lt;include&gt;</code> and

  808. <code>&lt;exclude&gt;</code> elements of PatternSet directly as well

  809. as PatternSet's attributes.</p>

  810. <table border="1" cellpadding="2" cellspacing="0">

  811.   <tr>

  812.     <td valign="top"><b>Attribute</b></td>

  813.     <td valign="top"><b>Description</b></td>

  814.     <td align="center" valign="top"><b>Required</b></td>

  815.   </tr>

  816.   <tr>

  817.     <td valign="top">dir</td>

  818.     <td valign="top">The root of the directory tree of this FileSet.</td>

  819.     <td valign="top" align="center">Yes</td>

  820.   </tr>

  821.   <tr>

  822.     <td valign="top">defaultexcludes</td>

  823.     <td valign="top">indicates whether default excludes should be used or not

  824.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  825.     <td valign="top" align="center">No</td>

  826.   </tr>

  827.   <tr>

  828.     <td valign="top">includes</td>

  829.     <td valign="top">comma separated list of patterns of files that must be

  830.       included. All files are included when omitted.</td>

  831.     <td valign="top" align="center">No</td>

  832.   </tr>

  833.   <tr>

  834.     <td valign="top">includesfile</td>

  835.     <td valign="top">the name of a file. Each line of this file is

  836.       taken to be an include pattern</td>

  837.     <td valign="top" align="center">No</td>

  838.   </tr>

  839.   <tr>

  840.     <td valign="top">excludes</td>

  841.     <td valign="top">comma separated list of patterns of files that must be

  842.       excluded. No files (except default excludes) are excluded when omitted.</td>

  843.     <td valign="top" align="center">No</td>

  844.   </tr>

  845.   <tr>

  846.     <td valign="top">excludesfile</td>

  847.     <td valign="top">the name of a file. Each line of this file is

  848.       taken to be an exclude pattern</td>

  849.     <td valign="top" align="center">No</td>

  850.   </tr>

  851. </table>

  852. <h4>Examples</h4>

  853. <blockquote><pre>

  854. &lt;fileset dir=&quot;${server.src}&quot; &gt;

  855.   &lt;patternset id=&quot;non.test.sources&quot; &gt;

  856.     &lt;include name=&quot;**/*.java&quot; /&gt;

  857.     &lt;exclude name=&quot;**/*Test*&quot; /&gt;

  858.   &lt;/patternset&gt;

  859. &lt;/fileset&gt;

  860. </pre></blockquote>

  861. <p>Groups all files in directory <code>${server.src}</code> that are Java

  862. source files and don't have the text <code>Test</code> in their

  863. name.</p>

  864. <blockquote><pre>

  865. &lt;fileset dir=&quot;${client.src}&quot; &gt;

  866.   &lt;patternset refid=&quot;non.test.sources&quot; /&gt;

  867. &lt;/fileset&gt;

  868. </pre></blockquote>

  869. <p>Groups all files in directory <code>${client.src}</code> using the

  870. same patterns as the example before.</p>

  871. <h3><a name="mapper">Mapping file names</a></h3>

  872. <p>Some tasks take source files and create target files. Depending on

  873. the task it may be quite obvious which name a target file will have

  874. (using <a href="#javac">javac</a>, you know there will be

  875. <code>.class</code> files for your <code>.java</code> files) - in

  876. other cases you may want to specify the target files either to help

  877. Ant or to get an extra bit of functionality.</p>

  878. <p>While source files are usually specified as <a

  879. href="#fileset">fileset</a>s, you don't specify target files directly,

  880. but tell Ant how to find the target file(s) for one source file. An

  881. instance of <code>org.apache.tools.ant.util.FileNameMapper</code> is

  882. responsible for this. It constructs target file names based on rules

  883. that can be parameterized with <code>from</code> and <code>to</code>

  884. attributes - the exact meaning of which is implementation

  885. dependent.</p>

  886. <p>These instances are defined in <code>&lt;mapper&gt;</code> elements

  887. with the following attributes:</p>

  888. <table border="1" cellpadding="2" cellspacing="0">

  889.   <tr>

  890.     <td valign="top"><b>Attribute</b></td>

  891.     <td valign="top"><b>Description</b></td>

  892.     <td align="center" valign="top"><b>Required</b></td>

  893.   </tr>

  894.   <tr>

  895.     <td valign="top">type</td>

  896.     <td valign="top">Specify one of the built in implementations</td>

  897.     <td align="center" valign="center" rowspan="2">Exactly one of both</td>

  898.   </tr>

  899.   <tr>

  900.     <td valign="top">classname</td>

  901.     <td valign="top">Specify the implementation by class name</td>

  902.   </tr>

  903.   <tr>

  904.     <td valign="top">classpath</td> 

  905.     <td valign="top">the classpath to use when looking up

  906.       <code>classname</code>.</td>

  907.     <td align="center" valign="top">No</td>

  908.   </tr>

  909.   <tr>

  910.     <td valign="top">classpathref</td>

  911.     <td valign="top">the classpath to use, given as <a

  912.       href="#references">reference</a> to a PATH defined elsewhere.</td>

  913.     <td align="center" valign="top">No</td>

  914.   </tr>

  915.   <tr>

  916.     <td valign="top">from</td> 

  917.     <td valign="top">The &quot;from&quot; attribute for the given

  918.       implementation</td>

  919.     <td align="center" valign="top">Depends on implementation.</td>

  920.   </tr>

  921.   <tr>

  922.     <td valign="top">to</td> 

  923.     <td valign="top">The &quot;to&quot; attribute for the given

  924.       implementation</td>

  925.     <td align="center" valign="top">Depends on implementation.</td>

  926.   </tr>

  927. </table>

  928. <p>The classpath can as well be specified via a nested

  929. <code>&lt;classpath&gt;</code>, that is a <a href="#path">PATH</a>

  930. like structure.</p>

  931. <p>The built in mapper types are:</p>

  932. <h4><a name="identity-mapper">identity</a></h4>

  933. <p>The target file name is identical to the source file name. Both

  934. <code>to</code> and <code>from</code> will be ignored.</p>

  935. <h5>Examples:</h5>

  936. <blockquote><pre>

  937. &lt;mapper type=&quot;identity&quot; /&gt;

  938. </pre></blockquote>

  939. <table border="1" cellpadding="2" cellspacing="0">

  940.   <tr>

  941.     <td valign="top"><b>Source file name</b></td>

  942.     <td valign="top"><b>Target file name</b></td>

  943.   </tr>

  944.   <tr>

  945.     <td valign="top"><code>A.java</code></td>

  946.     <td valign="top"><code>A.java</code></td>

  947.   </tr>

  948.   <tr>

  949.     <td valign="top"><code>foo/bar/B.java</code></td>

  950.     <td valign="top"><code>foo/bar/B.java</code></td>

  951.   </tr>

  952.   <tr>

  953.     <td valign="top"><code>C.properties</code></td>

  954.     <td valign="top"><code>C.properties</code></td>

  955.   </tr>

  956.   <tr>

  957.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  958.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  959.   </tr>

  960. </table>

  961. <h4><a name="flatten-mapper">flatten</a></h4>

  962. <p>The target file name is identical to the source file name with all

  963. leading directory information stripped of. Both <code>to</code> and

  964. <code>from</code> will be ignored.</p>

  965. <h5>Examples:</h5>

  966. <blockquote><pre>

  967. &lt;mapper type=&quot;flatten&quot; /&gt;

  968. </pre></blockquote>

  969. <table border="1" cellpadding="2" cellspacing="0">

  970.   <tr>

  971.     <td valign="top"><b>Source file name</b></td>

  972.     <td valign="top"><b>Target file name</b></td>

  973.   </tr>

  974.   <tr>

  975.     <td valign="top"><code>A.java</code></td>

  976.     <td valign="top"><code>A.java</code></td>

  977.   </tr>

  978.   <tr>

  979.     <td valign="top"><code>foo/bar/B.java</code></td>

  980.     <td valign="top"><code>B.java</code></td>

  981.   </tr>

  982.   <tr>

  983.     <td valign="top"><code>C.properties</code></td>

  984.     <td valign="top"><code>C.properties</code></td>

  985.   </tr>

  986.   <tr>

  987.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  988.     <td valign="top"><code>A.properties</code></td>

  989.   </tr>

  990. </table>

  991. <h4><a name="merge-mapper">merge</a></h4>

  992. <p>The target file name will always be the same - as defined by

  993. <code>to</code>, <code>from</code> will be ignored.</p>

  994. <h5>Examples:</h5>

  995. <blockquote><pre>

  996. &lt;mapper type=&quot;merge&quot; to=&quot;archive.tar&quot; /&gt;

  997. </pre></blockquote>

  998. <table border="1" cellpadding="2" cellspacing="0">

  999.   <tr>

  1000.     <td valign="top"><b>Source file name</b></td>

  1001.     <td valign="top"><b>Target file name</b></td>

  1002.   </tr>

  1003.   <tr>

  1004.     <td valign="top"><code>A.java</code></td>

  1005.     <td valign="top"><code>archive.tar</code></td>

  1006.   </tr>

  1007.   <tr>

  1008.     <td valign="top"><code>foo/bar/B.java</code></td>

  1009.     <td valign="top"><code>archive.tar</code></td>

  1010.   </tr>

  1011.   <tr>

  1012.     <td valign="top"><code>C.properties</code></td>

  1013.     <td valign="top"><code>archive.tar</code></td>

  1014.   </tr>

  1015.   <tr>

  1016.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  1017.     <td valign="top"><code>archive.tar</code></td>

  1018.   </tr>

  1019. </table>

  1020. <h4><a name="glob-mapper">glob</a></h4>

  1021. <p>Both <code>to</code> and <code>from</code> define patterns that may

  1022. contain at most one <code>*</code>. For each source file that matches

  1023. the <code>from</code> pattern a target file name will be constructed

  1024. from the <code>to</code> pattern by substituting the <code>*</code> in

  1025. the <code>to</code> pattern by the text that matches the

  1026. <code>*</code> in the <code>from</code> pattern. Source file names

  1027. that don't match the <code>from</code> pattern will be ignored.</p>

  1028. <h5>Examples:</h5>

  1029. <blockquote><pre>

  1030. &lt;mapper type=&quot;glob&quot; from=&quot;*.java&quot; to=&quot;*.java.bak&quot; /&gt;

  1031. </pre></blockquote>

  1032. <table border="1" cellpadding="2" cellspacing="0">

  1033.   <tr>

  1034.     <td valign="top"><b>Source file name</b></td>

  1035.     <td valign="top"><b>Target file name</b></td>

  1036.   </tr>

  1037.   <tr>

  1038.     <td valign="top"><code>A.java</code></td>

  1039.     <td valign="top"><code>A.java.bak</code></td>

  1040.   </tr>

  1041.   <tr>

  1042.     <td valign="top"><code>foo/bar/B.java</code></td>

  1043.     <td valign="top"><code>foo/bar/B.java.bak</code></td>

  1044.   </tr>

  1045.   <tr>

  1046.     <td valign="top"><code>C.properties</code></td>

  1047.     <td valign="top">ignored</td>

  1048.   </tr>

  1049.   <tr>

  1050.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  1051.     <td valign="top">ignored</td>

  1052.   </tr>

  1053. </table>

  1054. <blockquote><pre>

  1055. &lt;mapper type=&quot;glob&quot; from=&quot;C*ies&quot; to=&quot;Q*y&quot; /&gt;

  1056. </pre></blockquote>

  1057. <table border="1" cellpadding="2" cellspacing="0">

  1058.   <tr>

  1059.     <td valign="top"><b>Source file name</b></td>

  1060.     <td valign="top"><b>Target file name</b></td>

  1061.   </tr>

  1062.   <tr>

  1063.     <td valign="top"><code>A.java</code></td>

  1064.     <td valign="top">ignored</td>

  1065.   </tr>

  1066.   <tr>

  1067.     <td valign="top"><code>foo/bar/B.java</code></td>

  1068.     <td valign="top">ignored</td>

  1069.   </tr>

  1070.   <tr>

  1071.     <td valign="top"><code>C.properties</code></td>

  1072.     <td valign="top"><code>Q.property</code></td>

  1073.   </tr>

  1074.   <tr>

  1075.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  1076.     <td valign="top"><code>Qlasses/dir/dir2/A.property</td>

  1077.   </tr>

  1078. </table>

  1079. <h4><a name="regexp-mapper">regexp</a></h4>

  1080. <p>Both <code>to</code> and <code>from</code> define regular

  1081. expressions. If the source file name matches the <code>from</code>

  1082. pattern, the target file name will constructed from the

  1083. <code>to</code> pattern using \0 to \9 as back references for the full

  1084. match (\0) or the matches of the subexpressions in parens. Source

  1085. files not matching the <code>from</code> pattern will be ignored.</p>

  1086. <p><b>Note that you need to escape a $-sign with another $-sign in

  1087. Ant.</b></p>

  1088. <p>The regexp mapper needs a supporting library and an implementation

  1089. of <code>org.apache.tools.ant.util.regexp.RegexpMatcher</code> that

  1090. hides the specifics of the library. Ant comes with implementations for

  1091. <a href="http://jakarta.apache.org/regexp/">jakarta-regexp</a> and <a

  1092. href="http://jakarta.apache.org/oro/">jakarta-ORO</a> - if you compile

  1093. from sources and plan to use one of them, make sure the libraries are

  1094. in your CLASSPATH.</a> For information about using <a

  1095. href="http://www.cacas.org/~wes/java/">gnu.regexp</a> or <a

  1096. href="http://www.crocodile.org/~sts/Rex/">gnu.rex</a> with Ant, see <a

  1097. href="http://marc.theaimsgroup.com/?l=ant-dev&m=97550753813481&w=2">this</a>

  1098. article.</p>

  1099. <p>Ant will choose the regular expression library based on the

  1100. following algorithm: if the system property

  1101. <code>ant.regexp.matcherimpl</code> has been set, it is taken as the

  1102. name of the class implementing

  1103. <code>org.apache.tools.ant.util.regexp.RegexpMatcher</code> that

  1104. should be used. If it has not been set, first try jakarta-ORO, if that

  1105. cannot be found, try jakarta-regexp.</p>

  1106. <h5>Examples:</h5>

  1107. <blockquote><pre>

  1108. &lt;mapper type=&quot;regexp&quot; from=&quot;^(.*)\.java$$&quot; to=&quot;\1.java.bak&quot; /&gt;

  1109. </pre></blockquote>

  1110. <table border="1" cellpadding="2" cellspacing="0">

  1111.   <tr>

  1112.     <td valign="top"><b>Source file name</b></td>

  1113.     <td valign="top"><b>Target file name</b></td>

  1114.   </tr>

  1115.   <tr>

  1116.     <td valign="top"><code>A.java</code></td>

  1117.     <td valign="top"><code>A.java.bak</code></td>

  1118.   </tr>

  1119.   <tr>

  1120.     <td valign="top"><code>foo/bar/B.java</code></td>

  1121.     <td valign="top"><code>foo/bar/B.java.bak</code></td>

  1122.   </tr>

  1123.   <tr>

  1124.     <td valign="top"><code>C.properties</code></td>

  1125.     <td valign="top">ignored</td>

  1126.   </tr>

  1127.   <tr>

  1128.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  1129.     <td valign="top">ignored</td>

  1130.   </tr>

  1131. </table>

  1132. <blockquote><pre>

  1133. &lt;mapper type=&quot;regexp&quot; from=&quot;^(.*)/([^/]+)/([^/]*)$$&quot; to=&quot;\1/\2/\2-\3&quot; /&gt;

  1134. </pre></blockquote>

  1135. <table border="1" cellpadding="2" cellspacing="0">

  1136.   <tr>

  1137.     <td valign="top"><b>Source file name</b></td>

  1138.     <td valign="top"><b>Target file name</b></td>

  1139.   </tr>

  1140.   <tr>

  1141.     <td valign="top"><code>A.java</code></td>

  1142.     <td valign="top">ignored</td>

  1143.   </tr>

  1144.   <tr>

  1145.     <td valign="top"><code>foo/bar/B.java</code></td>

  1146.     <td valign="top"><code>foo/bar/bar-B.java</code></td>

  1147.   </tr>

  1148.   <tr>

  1149.     <td valign="top"><code>C.properties</code></td>

  1150.     <td valign="top">ignored</td>

  1151.   </tr>

  1152.   <tr>

  1153.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  1154.     <td valign="top"><code>Classes/dir/dir2/dir2-A.properties</code></td>

  1155.   </tr>

  1156. </table>

  1157. <blockquote><pre>

  1158. &lt;mapper type=&quot;regexp&quot; from=&quot;^(.*)\.(.*)$$&quot; to=&quot;\2.\1&quot; /&gt;

  1159. </pre></blockquote>

  1160. <table border="1" cellpadding="2" cellspacing="0">

  1161.   <tr>

  1162.     <td valign="top"><b>Source file name</b></td>

  1163.     <td valign="top"><b>Target file name</b></td>

  1164.   </tr>

  1165.   <tr>

  1166.     <td valign="top"><code>A.java</code></td>

  1167.     <td valign="top"><code>java.A</code></td>

  1168.   </tr>

  1169.   <tr>

  1170.     <td valign="top"><code>foo/bar/B.java</code></td>

  1171.     <td valign="top"><code>java.foo/bar/B</code></td>

  1172.   </tr>

  1173.   <tr>

  1174.     <td valign="top"><code>C.properties</code></td>

  1175.     <td valign="top"><code>properties.C</code></td>

  1176.   </tr>

  1177.   <tr>

  1178.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  1179.     <td valign="top"><code>properties.Classes/dir/dir2/A</code></td>

  1180.   </tr>

  1181. </table>

  1182. 

  1183. <hr>

  1184. <h2><a name="tasks">Built in tasks</a></h2>

  1185. <ul>

  1186.   <li><a href="#ant">Ant</a></li>

  1187.   <li><a href="#antcall">AntCall</a></li>

  1188.   <li><a href="#antstructure">AntStructure</a></li>

  1189.   <li><a href="#available">Available</a></li>

  1190.   <li><a href="#chmod">Chmod</a></li>

  1191.   <li><a href="#copy">Copy</a></li>

  1192.   <li><a href="#copydir">Copydir</a></li>

  1193.   <li><a href="#copyfile">Copyfile</a></li>

  1194.   <li><a href="#cvs">Cvs</a></li>

  1195.   <li><a href="#delete">Delete</a></li>

  1196.   <li><a href="#deltree">Deltree</a></li>

  1197.   <li><a href="#echo">Echo</a></li>

  1198.   <li><a href="#exec">Exec</a></li>

  1199.   <li><a href="#execon">ExecOn</a></li>

  1200.   <li><a href="#fail">Fail</a></li>

  1201.   <li><a href="#filter">Filter</a></li>

  1202.   <li><a href="#fixcrlf">FixCRLF</a></li>

  1203.   <li><a href="#genkey">GenKey</a></li>

  1204.   <li><a href="#get">Get</a></li>

  1205.   <li><a href="#gunzip">GUnzip</a></li>

  1206.   <li><a href="#gzip">GZip</a></li>

  1207.   <li><a href="#jar">Jar</a></li>

  1208.   <li><a href="#java">Java</a></li>

  1209.   <li><a href="#javac">Javac</a></li>

  1210.   <li><a href="#javadoc">Javadoc/Javadoc2</a></li>

  1211.   <li><a href="#mail">Mail</a></li>

  1212.   <li><a href="#mkdir">Mkdir</a></li>

  1213.   <li><a href="#move">Move</a></li>

  1214.   <li><a href="#patch">Patch</a></li>

  1215.   <li><a href="#property">Property</a></li>

  1216.   <li><a href="#rename">Rename</a></li>

  1217.   <li><a href="#replace">Replace</a></li>

  1218.   <li><a href="#rmic">Rmic</a></li>

  1219.   <li><a href="#signjar">SignJar</a></li>

  1220.   <li><a href="sql.html">Sql</a></li>

  1221.   <li><a href="#style">Style</a></li>

  1222.   <li><a href="#tar">Tar</a></li>

  1223.   <li><a href="#taskdef">Taskdef</a></li>

  1224.   <li><a href="#touch">Touch</a></li>

  1225.   <li><a href="#transform">Transform</a></li>

  1226.   <li><a href="#tstamp">Tstamp</a></li>

  1227.   <li><a href="#unzip">Unjar</a></li>

  1228.   <li><a href="#untar">Untar</a></li>

  1229.   <li><a href="#unzip">Unwar</a></li>

  1230.   <li><a href="#unzip">Unzip</a></li>

  1231.   <li><a href="#uptodate">Uptodate</a></li>

  1232.   <li><a href="#war">War</a></li>

  1233.   <li><a href="#zip">Zip</a></li>

  1234. </ul>

  1235. <hr>

  1236. <h2><a name="ant">Ant</a></h2>

  1237. <h3>Description</h3>

  1238. <p>Runs Ant on a supplied buildfile. This can be used to build subprojects.</p>

  1239. <p>When the <i>antfile</i> attribute is omitted, the file &quot;build.xml&quot;

  1240. in the supplied directory (<i>dir</i> attribute) is used.</p>

  1241. <p>If no target attribute is supplied, the default target of the new project is

  1242. used.</p>

  1243. <p>The properties of the current project will be available in the new project.

  1244. These properties will override the properties that are set in the new project.

  1245. (See also the <a href="#property">properties task</a>). You can set properties

  1246. in the new project from the old project by using nested property tags. This

  1247. allows you to parameterize your subprojects.</p>

  1248. <h3>Parameters</h3>

  1249. <table border="1" cellpadding="2" cellspacing="0">

  1250.   <tr>

  1251.     <td valign="top"><b>Attribute</b></td>

  1252.     <td valign="top"><b>Description</b></td>

  1253.     <td align="center" valign="top"><b>Required</b></td>

  1254.   </tr>

  1255.   <tr>

  1256.     <td valign="top">antfile</td>

  1257.     <td valign="top">the buildfile to use. Defaults to &quot;build.xml&quot;.</td>

  1258.     <td valign="top" align="center">No</td>

  1259.   </tr>

  1260.   <tr>

  1261.     <td valign="top">dir</td>

  1262.  	<td valign="top">the directory to use as a basedir for the new Ant project. 

  1263. 					 Defaults to the current directory.</td>

  1264.     <td valign="top" align="center">No</td>

  1265.   </tr>

  1266.   <tr>

  1267.     <td valign="top">target</td>

  1268.     <td valign="top">the target of the new Ant project that should be executed.</td>

  1269.     <td valign="top" align="center">No</td>

  1270.   </tr>

  1271.   <tr>

  1272.     <td valign="top">output</td>

  1273.     <td valign="top">Filename to write the ant output to.

  1274.     </td>

  1275.     <td align="center" valign="top">No</td>

  1276.   </tr>

  1277. </table>

  1278. <h3>Examples</h3>

  1279. <pre>

  1280.   &lt;ant antfile=&quot;subproject/subbuild.xml&quot; dir=&quot;subproject&quot; target=&quot;compile&quot; /&gt;

  1281. 

  1282.   &lt;ant dir=&quot;subproject&quot; /&gt;

  1283. 

  1284.   &lt;ant antfile=&quot;subproject/property_based_subbuild.xml&quot;&gt;

  1285.     &lt;property name=&quot;param1&quot; value=&quot;version 1.x&quot; /&gt;

  1286.     &lt;property file=&quot;config/subproject/default.properties&quot; /&gt;

  1287.   &lt;/ant&gt;

  1288. </pre>

  1289. <hr>

  1290. <h2><a name="antcall">AntCall</a></h2>

  1291. <h3>Description</h3>

  1292. <p>Call another target within the same build-file optionally specifying some

  1293. properties (param's in this context)</p>

  1294. <h3>Parameters</h3>

  1295. <table border="1" cellpadding="2" cellspacing="0">

  1296.   <tr>

  1297.     <td valign="top"><b>Attribute</b></td>

  1298.     <td valign="top"><b>Description</b></td>

  1299.     <td align="center" valign="top"><b>Required</b></td>

  1300.   </tr>

  1301.   <tr>

  1302.     <td valign="top">target</td>

  1303.     <td valign="top">The target to execute.</td>

  1304.     <td valign="top" align="center">Yes</td>

  1305.   </tr>

  1306. </table>

  1307. <h3>Parameters specified as nested elements</h3>

  1308. <h4>param</h4>

  1309. <p>Specifies the properties to set before running the specified target. See <a

  1310. href="#property">property</a> for usage guidelines.</p>

  1311. <h3>Examples</h3>

  1312. <pre>

  1313.   &lt;target name=&quot;default&quot;&gt;

  1314.     &lt;antcall target=&quot;doSomethingElse&quot;&gt;

  1315.       &lt;param name=&quot;param1&quot; value=&quot;value&quot;/&gt;

  1316.     &lt;/antcall&gt;

  1317.   &lt;/target&gt;

  1318. 

  1319.   &lt;target name=&quot;doSomethingElse&quot;&gt;

  1320.     &lt;echo message=&quot;param1=${param1}&quot;/&gt;

  1321.   &lt;/target&gt;

  1322. </pre>

  1323. <p>Will run the target 'doSomethingElse' and echo 'param1=value'.</p>

  1324. <hr>

  1325. <h2><a name="antstructure">AntStructure</a></h2>

  1326. <h3>Description</h3> 

  1327. <p>Generates a DTD for Ant build files which contains information

  1328. about all tasks currently known to Ant.</p> 

  1329. <p>Note that the DTD generated by this task is incomplete, you can

  1330. always add XML entities using <a

  1331. href="#taskdef"><code>&lt;taskdef&gt;</code></a>. See <a

  1332. href="http://www.sdv.fr/pages/casa/html/ant-dtd.en.html">here</a> for

  1333. a way to get around this problem.</p>

  1334. <p>This task doesn't know about required attributes, all will be

  1335. listed as <code>#IMPLIED</code>.</p>

  1336. <h3>Parameters</h3>

  1337. <table border="1" cellpadding="2" cellspacing="0">

  1338.   <tr>

  1339.     <td valign="top"><b>Attribute</b></td>

  1340.     <td valign="top"><b>Description</b></td>

  1341.     <td align="center" valign="top"><b>Required</b></td>

  1342.   </tr>

  1343.   <tr>

  1344.     <td valign="top">output</td>

  1345.     <td valign="top">file to write the DTD to.</td>

  1346.     <td valign="top" align="center">Yes</td>

  1347.   </tr>

  1348. </table>

  1349. <h3>Examples</h3>

  1350. <blockquote><pre>

  1351. &lt;antstructure output=&quot;project.dtd&quot; /&gt;

  1352. </pre></blockquote>

  1353. <hr>

  1354. <h2><a name="available">Available</a></h2>

  1355. <h3>Description</h3>

  1356. <p>Sets a property if a resource is available at runtime. This resource can be a

  1357. file resource, a class in classpath or a JVM system resource.</p>

  1358. <p>If the resource is present, the property value is set to true by

  1359. default, otherwise the property is not set. You can set the value to

  1360. something specific by using the value attribute.</p>

  1361. <p>Normally, this task is used to set properties that are useful to avoid target

  1362. execution depending on system parameters.</p>

  1363. <h3>Parameters</h3>

  1364. <table border="1" cellpadding="2" cellspacing="0">

  1365.   <tr>

  1366.     <td valign="top"><b>Attribute</b></td>

  1367.     <td valign="top"><b>Description</b></td>

  1368.     <td align="center" valign="top"><b>Required</b></td>

  1369.   </tr>

  1370.   <tr>

  1371.     <td valign="top">property</td>

  1372.     <td valign="top">the name of the property to set.</td>

  1373.     <td valign="top" align="center">Yes</td>

  1374.   </tr>

  1375.   <tr>

  1376.     <td valign="top">value</td>

  1377.     <td valign="top">the value to set the property to. Defaults to &quot;true&quot;.</td>

  1378.     <td valign="top" align="center">No</td>

  1379.   </tr>

  1380.   <tr>

  1381.     <td valign="top">classname</td>

  1382.     <td valign="top">the class to look for in classpath.</td>

  1383.     <td valign="middle" align="center" rowspan="3">Yes</td>

  1384.   </tr>

  1385.   <tr>

  1386.     <td valign="top">resource</td>

  1387.     <td valign="top">the resource to look for in the JVM</td>

  1388.   </tr>

  1389.   <tr>

  1390.     <td valign="top">file</td>

  1391.     <td valign="top">the file to look for.</td>

  1392.   </tr>

  1393.   <tr>

  1394.     <td valign="top">classpath</td> <td valign="top">the classpath to

  1395.       use when looking up <code>classname</code>.</td> <td

  1396.     align="center" valign="top">No</td>

  1397.   </tr>

  1398. </table>

  1399. <h3>Parameters specified as nested elements</h3>

  1400. <h4>classpath</h4>

  1401. <p><code>Available</code>'s <em>classpath</em> attribute is a <a

  1402. href="#path">PATH like structure</a> and can also be set via a nested

  1403. <em>classpath</em> element.</p>

  1404. <h3>Examples</h3>

  1405. <pre>  &lt;available classname=&quot;org.whatever.Myclass&quot; property=&quot;Myclass.present&quot; /&gt;</pre>

  1406. <p>sets the property <code><i>Myclass.present</i></code> to the value &quot;true&quot;

  1407. if the <i>org.whatever.Myclass</i> is found in Ant's classpath.</p>

  1408. <hr>

  1409. <h2><a name="chmod">Chmod</a></h2>

  1410. <h3>Description</h3>

  1411. <p>Changes the permissions of a file or all files inside specified directories. Right now it has effect only under Unix.

  1412. The permissions are also UNIX style, like the argument for the chmod command.</p>

  1413. <p>See the section on <a href="#directorybasedtasks">directory based

  1414. tasks</a>, on how the inclusion/exclusion of files works, and how to

  1415. write patterns.</p>

  1416. <p>This task holds an implicit <a href="#fileset">FileSet</a> and

  1417. supports all of FileSet's attributes and nested elements

  1418. directly. More FileSets can be specified using nested

  1419. <code>&lt;fileset&gt;</code> elements.</p>

  1420. <h3>Parameters</h3>

  1421. <table border="1" cellpadding="2" cellspacing="0">

  1422.   <tr>

  1423.     <td valign="top"><b>Attribute</b></td>

  1424.     <td valign="top"><b>Description</b></td>

  1425.     <td align="center" valign="top"><b>Required</b></td>

  1426.   </tr>

  1427.   <tr>

  1428.     <td valign="top">file</td>

  1429.     <td valign="top">the file or single directory of which the permissions 

  1430.       must be changed.</td>

  1431.     <td valign="top" valign="middle" rowspan="2">exactly one of the two or nested <code>&lt;fileset&gt;</code> elements.</td>

  1432.   </tr>

  1433.   <tr>

  1434.     <td valign="top">dir</td>

  1435.     <td valign="top">the directory which holds the files whose permissions 

  1436.       must be changed.</td>

  1437.   </tr>

  1438.   <tr>

  1439.     <td valign="top">perm</td>

  1440.     <td valign="top">the new permissions.</td>

  1441.     <td valign="top" align="center">Yes</td>

  1442.   </tr>

  1443.   <tr>

  1444.     <td valign="top">includes</td>

  1445.     <td valign="top">comma separated list of patterns of files that must be

  1446.       included. All files are included when omitted.</td>

  1447.     <td valign="top" align="center">No</td>

  1448.   </tr>

  1449.   <tr>

  1450.     <td valign="top">includesfile</td>

  1451.     <td valign="top">the name of a file. Each line of this file is

  1452.       taken to be an include pattern</td>

  1453.     <td valign="top" align="center">No</td>

  1454.   </tr>

  1455.   <tr>

  1456.     <td valign="top">excludes</td>

  1457.     <td valign="top">comma separated list of patterns of files that must be

  1458.       excluded. No files (except default excludes) are excluded when omitted.</td>

  1459.     <td valign="top" align="center">No</td>

  1460.   </tr>

  1461.   <tr>

  1462.     <td valign="top">excludesfile</td>

  1463.     <td valign="top">the name of a file. Each line of this file is

  1464.       taken to be an exclude pattern</td>

  1465.     <td valign="top" align="center">No</td>

  1466.   </tr>

  1467.   <tr>

  1468.     <td valign="top">defaultexcludes</td>

  1469.     <td valign="top">indicates whether default excludes should be used or not

  1470.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  1471.     <td valign="top" align="center">No</td>

  1472.   </tr>

  1473.   <tr>

  1474.     <td valign="top">parallel</td>

  1475.     <td valign="top">process all specified files using a single

  1476.       <code>chmod</code> command. Defaults to true.</td>

  1477.     <td valign="top" align="center">No</td>

  1478.   </tr>

  1479.   <tr>

  1480.     <td valign="top">type</td>

  1481.     <td valign="top">One of <em>file</em>, <em>dir</em> or

  1482.       <em>both</em>. If set to <em>file</em>, only the permissions of

  1483.       plain files are going to be changed. If set to <em>dir</em>, only

  1484.       the directories are considered.</td>

  1485.     <td align="center" valign="top">No, default is <em>file</em></td>

  1486.   </tr>

  1487. </table>

  1488. <h3>Examples</h3>

  1489. <blockquote>

  1490.   <p><code>&lt;chmod file=&quot;${dist}/start.sh&quot; perm=&quot;ugo+rx&quot;

  1491.   /&gt;</code></p>

  1492. </blockquote>

  1493. <p>makes the &quot;start.sh&quot; file readable and executable for anyone on a

  1494. UNIX system.</p>

  1495. <blockquote>

  1496. <pre>

  1497.     &lt;chmod dir=&quot;${dist}/bin&quot; perm=&quot;ugo+rx&quot; includes=&quot;**/*.sh&quot; /&gt;

  1498. </pre>

  1499. </blockquote>

  1500. <p>makes all &quot;.sh&quot; files below <code>${dist}/bin</code>

  1501. readable and executable for anyone on a UNIX system.</p>

  1502. <blockquote>

  1503. <pre>

  1504. &lt;chmod perm=&quot;g+w&quot; /&gt;

  1505.   &lt;fileset dir=&quot;shared/sources1&quot; &gt;

  1506.     &lt;exclude name=&quot;**/trial/**&quot; /&gt;

  1507.   &lt;/fileset&gt;

  1508.   &lt;fileset refid=&quot;other.shared.sources&quot; /&gt;

  1509. &lt;/chmod&gt;

  1510. </pre>

  1511. </blockquote>

  1512. <p>makes all files below <code>shared/sources1</code> (except those

  1513. below any directory named trial) writable for members of the same

  1514. group on a UNIX system. In addition all files belonging to a FileSet

  1515. with <code>id</code> <code>other.shared.sources</code> get the same

  1516. permissions.</p>

  1517. <hr>

  1518. <h2><a name="copy">Copy</a></h2>

  1519. <h3>Description</h3>

  1520. <p>Copies a file or Fileset to a new file or directory.  Files are

  1521. only copied if the source file is newer than the destination file,

  1522. or when the destination file does not exist.  However, you can explicitly 

  1523. overwrite files with the <var>overwrite</var> attribute.</p>

  1524. <p><a href="#fileset">FileSet</a>s are used to select files to copy.  

  1525. To use a fileset, the <var>todir</var> attribute must be set.</p>

  1526. <h3>Parameters</h3>

  1527. <table border="1" cellpadding="2" cellspacing="0">

  1528.   <tr>

  1529.     <td valign="top"><b>Attribute</b></td>

  1530.     <td valign="top"><b>Description</b></td>

  1531.     <td align="center" valign="top"><b>Required</b></td>

  1532.   </tr>

  1533.   <tr>

  1534.     <td valign="top">file</td>

  1535.     <td valign="top">The file to copy.</td>

  1536.     <td valign="top" align="center">One of either <var>file</var> or 

  1537.     at least one nested fileset element.</td>

  1538.   </tr>

  1539.   <tr>

  1540.     <td valign="top">preservelastmodified</td>

  1541.     <td valign="top">Give the copied files the same last modified

  1542.       time as the original files. Defaults to &quot;no&quot;.</td>

  1543.     <td valign="top" align="center">No</td>

  1544.   </tr>

  1545.   <tr>

  1546.     <td valign="top">tofile</td>

  1547.     <td valign="top">The file to copy to.</td>

  1548.     <td valign="top" align="center" rowspan="2">With the <var>file</var> attribute, 

  1549.     either <var>tofile</var> or <var>todir</var> can be used.  With nested filesets, 

  1550.     only <var>todir</var> is allowed.</td>

  1551.   </tr>

  1552.   <tr>

  1553.     <td valign="top">todir</td>

  1554.     <td valign="top">The directory to copy to.</td>

  1555.   </tr>

  1556.   <tr>

  1557.     <td valign="top">overwrite</td>

  1558.     <td valign="top">Overwrite existing files even if the destination

  1559.       files are newer. Defaults to &quot;no&quot;.</td>

  1560.     <td valign="top" align="center">No</td>

  1561.   </tr>

  1562.   <tr>

  1563.     <td valign="top">filtering</td>

  1564.     <td valign="top">Indicates whether token filtering should take place during

  1565.       the copy. Defaults to &quot;no&quot;.</td>

  1566.     <td valign="top" align="center">No</td>

  1567.   </tr>

  1568.   <tr>

  1569.     <td valign="top">flatten</td>

  1570.     <td valign="top">Ignore directory structure of source directory,

  1571.       copy all files into a single directory, specified by the <var>todir</var>

  1572.       attribute. Defaults to &quot;no&quot;. Note that you can achieve the 

  1573.       same effect by using a <a href="#flatten-mapper">flatten mapper</a></td>

  1574.     <td valign="top" align="center">No</td>

  1575.   </tr>

  1576.   <tr>

  1577.     <td valign="top">includeEmptyDirs</td>

  1578. 	 <td valign="top">Copy empty directories included with the nested FileSet(s).

  1579. 	   Defaults to &quot;yes&quot;.</td>

  1580. 	 <td valign="top" align="center">No</td>

  1581.   </tr>

  1582. </table>

  1583. <h3>Parameters specified as nested elements</h3>

  1584. <h4>mapper</h4>

  1585. <p>You can define file name transformations by using a nested <a

  1586. href="#mapper">mapper</a> element. The default mapper used by

  1587. <code>&lt;copy&gt;</code> is the <a

  1588. href="#identity-mapper">identity</a>.</p>

  1589. <h3>Examples</h3>

  1590. <p><b>Copy a single file</b></p>

  1591. <pre>

  1592.   &lt;copy file=&quot;myfile.txt&quot; tofile=&quot;mycopy.txt&quot; /&gt;

  1593. </pre>

  1594. <p><b>Copy a file to a directory</b></p>

  1595. <pre>

  1596.   &lt;copy file=&quot;myfile.txt&quot; todir=&quot;../some/dir/tree&quot; /&gt;

  1597. </pre>

  1598. <p><b>Copy a directory to another directory</b></p>

  1599. <pre>

  1600.   &lt;copy todir=&quot;../new/dir&quot;&gt;

  1601.     &lt;fileset dir=&quot;src_dir&quot;/&gt;

  1602.   &lt;/copy&gt;

  1603. </pre>

  1604. <p><b>Copy a set of files to a directory</b></p>

  1605. <pre>

  1606.   &lt;copy todir=&quot;../dest/dir&quot; &gt;

  1607.     &lt;fileset dir=&quot;src_dir&quot &gt;

  1608.       &lt;exclude name=&quot;**/*.java&quot; /&gt;

  1609.     &lt;/fileset&gt;

  1610.   &lt;/copy&gt;

  1611. 

  1612.   &lt;copy todir=&quot;../dest/dir&quot; &gt;

  1613.     &lt;fileset dir=&quot;src_dir&quot excludes=&quot;**/*.java&quot; /&gt;

  1614.   &lt;/copy&gt;

  1615. </pre>

  1616. <p><b>Copy a set of files to a directory appending

  1617. &quot;<code>.bak</code>&quot; to the file name on the fly</b></p>

  1618. <pre>

  1619.   &lt;copy todir=&quot;../backup/dir&quot; &gt;

  1620.     &lt;fileset dir=&quot;src_dir&quot /&gt;

  1621.     &lt;mapper type=&quot;glob&quot; from=&quot;*&quot; to=&quot;*.bak&quot; /&gt;

  1622.   &lt;/copy&gt;

  1623. </pre>

  1624. <hr>

  1625. <h2><a name="copydir">Copydir</a></h2>

  1626. <h3><i>Deprecated</i></h3>

  1627. <p><i>This task has been deprecated.  Use the Copy task instead.</i></p>

  1628. <h3>Description</h3>

  1629. <p>Copies a directory tree from the source to the destination.</p>

  1630. <p>It is possible to refine the set of files that are being copied. This can be

  1631. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>

  1632. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to

  1633. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify

  1634. the files you want to have excluded. This is also done with patterns. And

  1635. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  1636. want to use default exclusions or not. See the section on <a

  1637. href="#directorybasedtasks">directory based tasks</a>, on how the

  1638. inclusion/exclusion of files works, and how to write patterns.</p>

  1639. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  1640. supports all attributes of <code>&lt;fileset&gt;</code>

  1641. (<code>dir</code> becomes <code>src</code>) as well as the nested

  1642. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  1643. <code>&lt;patternset&gt;</code> elements.</p>

  1644. <h3>Parameters</h3>

  1645. <table border="1" cellpadding="2" cellspacing="0">

  1646.   <tr>

  1647.     <td valign="top"><b>Attribute</b></td>

  1648.     <td valign="top"><b>Description</b></td>

  1649.     <td align="center" valign="top"><b>Required</b></td>

  1650.   </tr>

  1651.   <tr>

  1652.     <td valign="top">src</td>

  1653.     <td valign="top">the directory to copy.</td>

  1654.     <td valign="top" align="center">Yes</td>

  1655.   </tr>

  1656.   <tr>

  1657.     <td valign="top">dest</td>

  1658.     <td valign="top">the directory to copy to.</td>

  1659.     <td valign="top" align="center">Yes</td>

  1660.   </tr>

  1661.   <tr>

  1662.     <td valign="top">includes</td>

  1663.     <td valign="top">comma separated list of patterns of files that must be

  1664.       included. All files are included when omitted.</td>

  1665.     <td valign="top" align="center">No</td>

  1666.   </tr>

  1667.   <tr>

  1668.     <td valign="top">includesfile</td>

  1669.     <td valign="top">the name of a file. Each line of this file is

  1670.       taken to be an include pattern</td>

  1671.     <td valign="top" align="center">No</td>

  1672.   </tr>

  1673.   <tr>

  1674.     <td valign="top">excludes</td>

  1675.     <td valign="top">comma separated list of patterns of files that must be

  1676.       excluded. No files (except default excludes) are excluded when omitted.</td>

  1677.     <td valign="top" align="center">No</td>

  1678.   </tr>

  1679.   <tr>

  1680.     <td valign="top">excludesfile</td>

  1681.     <td valign="top">the name of a file. Each line of this file is

  1682.       taken to be an exclude pattern</td>

  1683.     <td valign="top" align="center">No</td>

  1684.   </tr>

  1685.   <tr>

  1686.     <td valign="top">defaultexcludes</td>

  1687.     <td valign="top">indicates whether default excludes should be used or not

  1688.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  1689.     <td valign="top" align="center">No</td>

  1690.   </tr>

  1691.   <tr>

  1692.     <td valign="top">filtering</td>

  1693.     <td valign="top">indicates whether token filtering should take place during

  1694.       the copy</td>

  1695.     <td valign="top" align="center">No</td>

  1696.   </tr>

  1697.   <tr>

  1698.     <td valign="top">flatten</td>

  1699.     <td valign="top">ignore directory structure of source directory,

  1700.       copy all files into a single directory - specified by the dest

  1701.       attribute (default is false).</td>

  1702.     <td valign="top" align="center">No</td>

  1703.   </tr>

  1704.   <tr>

  1705.     <td valign="top">forceoverwrite</td>

  1706.     <td valign="top">overwrite existing files even if the destination

  1707.       files are newer (default is false).</td>

  1708.     <td valign="top" align="center">No</td>

  1709.   </tr>

  1710. </table>

  1711. <h3>Examples</h3>

  1712. <pre>  &lt;copydir src=&quot;${src}/resources&quot;

  1713.            dest=&quot;${dist}&quot;

  1714.   /&gt;</pre>

  1715. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>.</p>

  1716. <pre>  &lt;copydir src=&quot;${src}/resources&quot;

  1717.            dest=&quot;${dist}&quot;

  1718.            includes=&quot;**/*.java&quot;

  1719.            excludes=&quot;**/Test.java&quot;

  1720.   /&gt;</pre>

  1721. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>

  1722. recursively. All java files are copied, except for files with the name <code>Test.java</code>.</p>

  1723. <pre>  &lt;copydir src=&quot;${src}/resources&quot;

  1724.            dest=&quot;${dist}&quot;

  1725.            includes=&quot;**/*.java&quot;

  1726.            excludes=&quot;mypackage/test/**&quot; /&gt;</pre>

  1727. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>

  1728. recursively. All java files are copied, except for the files under the <code>mypackage/test</code>

  1729. directory.</p>

  1730. <hr>

  1731. <h2><a name="copyfile">Copyfile</a></h2>

  1732. <h3><i>Deprecated</i></h3>

  1733. <p><i>This task has been deprecated.  Use the Copy task instead.</i></p>

  1734. <h3>Description</h3>

  1735. <p>Copies a file from the source to the destination. The file is only copied if

  1736. the source file is newer than the destination file, or when the destination file

  1737. does not exist.</p>

  1738. <h3>Parameters</h3>

  1739. <table border="1" cellpadding="2" cellspacing="0">

  1740.   <tr>

  1741.     <td valign="top"><b>Attribute</b></td>

  1742.     <td valign="top"><b>Description</b></td>

  1743.     <td align="center" valign="top"><b>Required</b></td>

  1744.   </tr>

  1745.   <tr>

  1746.     <td valign="top">src</td>

  1747.     <td valign="top">the filename of the file to copy.</td>

  1748.     <td valign="top" align="center">Yes</td>

  1749.   </tr>

  1750.   <tr>

  1751.     <td valign="top">dest</td>

  1752.     <td valign="top">the filename of the file where to copy to.</td>

  1753.     <td valign="top" align="center">Yes</td>

  1754.   </tr>

  1755.   <tr>

  1756.     <td valign="top">filtering</td>

  1757.     <td valign="top">indicates whether token filtering should take place during

  1758.       the copy</td>

  1759.     <td valign="top" align="center">No</td>

  1760.   </tr>

  1761.   <tr>

  1762.     <td valign="top">forceoverwrite</td>

  1763.     <td valign="top">overwrite existing files even if the destination

  1764.       files are newer (default is false).</td>

  1765.     <td valign="top" align="center">No</td>

  1766.   </tr>

  1767. </table>

  1768. <h3>Examples</h3>

  1769. <blockquote>

  1770.   <p><code>&lt;copyfile src=&quot;test.java&quot; dest=&quot;subdir/test.java&quot;

  1771.   /&gt;</code></p>

  1772.   <p><code>&lt;copyfile src=&quot;${src}/index.html&quot; dest=&quot;${dist}/help/index.html&quot;

  1773.   /&gt;</code></p>

  1774. </blockquote>

  1775. <hr>

  1776. <h2><a name="cvs">Cvs</a></h2>

  1777. <h3>Description</h3>

  1778. <p>Handles packages/modules retrieved from a 

  1779. <a href="http://www.cvshome.org/">CVS</a> repository.</p>

  1780. <p>When doing automated builds, the <a href="#get">get task</a> should be

  1781. preferred over the <i>checkout</i> command, because of speed.</p>

  1782. <h3>Parameters</h3>

  1783. <table border="1" cellpadding="2" cellspacing="0">

  1784.   <tr>

  1785.     <td valign="top"><b>Attribute</b></td>

  1786.     <td valign="top"><b>Description</b></td>

  1787.     <td align="center" valign="top"><b>Required</b></td>

  1788.   </tr>

  1789.   <tr>

  1790.     <td valign="top">command</td>

  1791.     <td valign="top">the CVS command to execute.</td>

  1792.     <td align="center" valign="top">No, default &quot;checkout&quot;</td>

  1793.   </tr>

  1794.   <tr>

  1795.     <td valign="top">cvsRoot</td>

  1796.     <td valign="top">the CVSROOT variable.</td>

  1797.     <td align="center" valign="top">No</td>

  1798.   </tr>

  1799.   <tr>

  1800.     <td valign="top">dest</td>

  1801.     <td valign="top">the directory where the checked out files should be placed.</td>

  1802.     <td align="center" valign="top">No, default is project's basedir.</td>

  1803.   </tr>

  1804.   <tr>

  1805.     <td valign="top">package</td>

  1806.     <td valign="top">the package/module to check out.</td>

  1807.     <td align="center" valign="top">No</td>

  1808.   </tr>

  1809.   <tr>

  1810.     <td valign="top">tag</td>

  1811.     <td valign="top">the tag of the package/module to check out.</td>

  1812.     <td align="center" valign="top">No</td>

  1813.   </tr>

  1814.   <tr>

  1815.     <td valign="top">date</td>

  1816.     <td valign="top">Use the most recent revision no later than the given date</td>

  1817.     <td align="center" valign="top">No</td>

  1818.   </tr>

  1819.   <tr>

  1820.     <td valign="top">quiet</td>

  1821.     <td valign="top">suppress informational messages.</td>

  1822.     <td align="center" valign="top">No, default &quot;false&quot;</td>

  1823.   </tr>

  1824.   <tr>

  1825.     <td valign="top">noexec</td>

  1826.     <td valign="top">report only, don't change any files.</td>

  1827.     <td align="center" valign="top">No, default &quot;false&quot;</td>

  1828.   </tr>

  1829.   <tr>

  1830.     <td valign="top">output</td>

  1831.     <td valign="top">the file to direct standard output from the command.</td>

  1832.     <td align="center" valign="top">No, default output to ANT Log as MSG_INFO.</td>

  1833.   </tr>

  1834.   <tr>

  1835.     <td valign="top">error</td>

  1836.     <td valign="top">the file to direct standard error from the command.</td>

  1837.     <td align="center" valign="top">No, default error to ANT Log as MSG_WARN.</td>

  1838.   </tr>

  1839. </table>

  1840. <h3>Examples</h3>

  1841. <pre>  &lt;cvs cvsRoot=&quot;:pserver:anoncvs@jakarta.apache.org:/home/cvspublic&quot;

  1842.        package=&quot;jakarta-tools&quot;

  1843.        dest=&quot;${ws.dir}&quot;

  1844.   /&gt;</pre>

  1845. <p>checks out the package/module &quot;jakarta-tools&quot; from the CVS

  1846. repository pointed to by the cvsRoot attribute, and stores the files in &quot;${ws.dir}&quot;.</p>

  1847. <pre>  &lt;cvs dest=&quot;${ws.dir}&quot; command=&quot;update&quot; /&gt;</pre>

  1848. <p>updates the package/module that has previously been checked out into

  1849. &quot;${ws.dir}&quot;.</p>

  1850. <pre>  &lt;cvs command=&quot;-q diff -u -N&quot; output="patch.txt"/&gt;</pre>

  1851. <p>silently (-q) creates a file called patch.txt which contains a unified (-u) diff which includes new files added via &quot;cvs add&quot; (-N) and can be used as input to patch.</p>

  1852. <pre>  &lt;cvs command=&quot;update -A -d&quot;/&gt;</pre>

  1853. <p>Updates from the head of repository ignoring sticky bits (-A) and creating any new directories as necessary (-d).</p>

  1854. <p>Note: the text of the command is passed to cvs &quot;as-is&quot; so any cvs options should appear before the command, and any command options should appear after the command as in the diff example above. See <a href="http://www.cvshome.org/docs/manual/index.html">the cvs manual</a> for details, specifically the <a href="http://www.cvshome.org/docs/manual/cvs_16.html">Guide to CVS commands</a></p>

  1855. <hr>

  1856. <h2><a name="delete">Delete</a></h2>

  1857. <h3>Description</h3>

  1858. <p>Deletes either a single file, all files in a specified directory and its 

  1859. sub-directories, or a set of files specified by one or more <a href="#fileset">FileSet</a>s.

  1860. When specifying a set of files, empty directories are <em>not</em> removed.</p>

  1861. <h3>Parameters</h3>

  1862. <table border="1" cellpadding="2" cellspacing="0">

  1863.   <tr>

  1864.     <td valign="top"><b>Attribute</b></td>

  1865.     <td valign="top"><b>Description</b></td>

  1866.     <td align="center" valign="top"><b>Required</b></td>

  1867.   </tr>

  1868.   <tr>

  1869.     <td valign="top">file</td>

  1870.     <td valign="top">The file to delete.</td>

  1871.     <td align="center" valign="middle" rowspan="2">at least one of the two</td>

  1872.   </tr>

  1873.   <tr>

  1874.     <td valign="top">dir</td>

  1875.     <td valign="top">The directory to delete files from.</td>

  1876.   </tr>

  1877.   <tr>

  1878.     <td valign="top">verbose</td>

  1879.     <td valign="top">Show name of each deleted file (&quot;true&quot;/&quot;false&quot;).

  1880. 	 Default is &quot;false&quot; when omitted.</td>

  1881.     <td align="center" valign="top">No</td>

  1882.   </tr>

  1883.   <tr>

  1884.     <td valign="top">quiet</td>

  1885.     <td valign="top">If the file does not exist, do not display a diagnostic 

  1886.      message or modify the exit status to reflect an error.

  1887.      This means that if a file or directory cannot be deleted,

  1888.      then no error is reported. This setting emulates the 

  1889.      -f option to the Unix &quot;rm&quot; command.

  1890.     (&quot;true&quot;/&quot;false&quot;).

  1891. 	 Default is &quot;false&quot; meaning things are &quot;noisy&quot;.</td>

  1892.     <td align="center" valign="top">No</td>

  1893.   </tr>

  1894.   <tr>

  1895.     <td valign="top">includes</td>

  1896.     <td valign="top"><i>Deprecated.</i>  Comma separated list of patterns of files that must be

  1897.       deleted. All files are in the current directory 

  1898.       and any sub-directories are deleted when omitted.</td>

  1899.     <td valign="top" align="center">No</td>

  1900.   </tr>

  1901.   <tr>

  1902.     <td valign="top">includesfile</td>

  1903.     <td valign="top"><i>Deprecated.</i>  The name of a file. Each line of this file is

  1904.       taken to be an include pattern</td>

  1905.     <td valign="top" align="center">No</td>

  1906.   </tr>

  1907.   <tr>

  1908.     <td valign="top">excludes</td>

  1909.     <td valign="top"><i>Deprecated.</i>  Comma separated list of patterns of files that must be

  1910.       excluded from the deletion list. No files (except default excludes) are excluded when omitted.</td>

  1911.     <td valign="top" align="center">No</td>

  1912.   </tr>

  1913.   <tr>

  1914.     <td valign="top">excludesfile</td>

  1915.     <td valign="top"><i>Deprecated.</i>  The name of a file. Each line of this file is

  1916.       taken to be an exclude pattern</td>

  1917.     <td valign="top" align="center">No</td>

  1918.   </tr>

  1919.   <tr>

  1920.     <td valign="top">defaultexcludes</td>

  1921.     <td valign="top"><i>Deprecated.</i>  Indicates whether default excludes should be used or not

  1922.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  1923.     <td valign="top" align="center">No</td>

  1924.   </tr>

  1925. </table>

  1926. <h3>Examples</h3>

  1927. <pre>  &lt;delete file=&quot;/lib/ant.jar&quot; /&gt;</pre>

  1928. <p>deletes the file <code>/lib/ant.jar</code>.</p>

  1929. <pre>  &lt;delete dir=&quot;lib&quot; /&gt;</pre>

  1930. <p>deletes all files in the <code>/lib</code> directory.</p>

  1931. <pre>  &lt;delete&gt;

  1932.     &lt;fileset dir=&quot;.&quot; includes=&quot;**/*.bak&quot; /&gt;

  1933.   &lt;/delete&gt;

  1934. </pre>

  1935. <p>deletes all files with the extension &quot;<code>.bak</code>&quot from the current directory 

  1936. and any sub-directories.</p>

  1937. <hr>

  1938. <h2><a name="deltree">Deltree</a></h2>

  1939. <h3><i>Deprecated</i></h3>

  1940. <p><i>This task has been deprecated.  Use the Delete task instead.</i></p>

  1941. <h3>Description</h3>

  1942. <p>Deletes a directory with all its files and subdirectories.</p>

  1943. <h3>Parameters</h3>

  1944. <table border="1" cellpadding="2" cellspacing="0">

  1945.   <tr>

  1946.     <td valign="top"><b>Attribute</b></td>

  1947.     <td valign="top"><b>Description</b></td>

  1948.     <td align="center" valign="top"><b>Required</b></td>

  1949.   </tr>

  1950.   <tr>

  1951.     <td valign="top">dir</td>

  1952.     <td valign="top">the directory to delete.</td>

  1953.     <td valign="top" align="center">Yes</td>

  1954.   </tr>

  1955. </table>

  1956. <h3>Examples</h3>

  1957. <pre>  &lt;deltree dir=&quot;dist&quot; /&gt;</pre>

  1958. <p>deletes the directory <code>dist</code>, including its files and

  1959. subdirectories.</p>

  1960. <pre>  &lt;deltree dir=&quot;${dist}&quot; /&gt;</pre>

  1961. <p>deletes the directory <code>${dist}</code>, including its files and

  1962. subdirectories.</p>

  1963. <hr>

  1964. <h2><a name="echo">Echo</a></h2>

  1965. <h3>Description</h3>

  1966. <p>Echoes a message to System.out or a file.</p>

  1967. <h3>Parameters</h3>

  1968. <table border="1" cellpadding="2" cellspacing="0">

  1969.   <tr>

  1970.     <td valign="top"><b>Attribute</b></td>

  1971.     <td valign="top"><b>Description</b></td>

  1972.     <td align="center" valign="top"><b>Required</b></td>

  1973.   </tr>

  1974.   <tr>

  1975.     <td valign="top">message</td>

  1976.     <td valign="top">the message to echo.</td>

  1977.     <td valign="top" align="center">Yes, unless data is included in a

  1978.       character section within this element.</td>

  1979.   </tr>

  1980.   <tr>

  1981.     <td valign="top">file</td>

  1982.     <td valign="top">the file to write the message to.</td>

  1983.     <td valign="top" align="center">No</td>

  1984.   </tr>

  1985.   <tr>

  1986.     <td valign="top">append</td>

  1987.     <td valign="top">Append to an existing file?</td>

  1988.     <td valign="top" align="center">No - default is false.</td>

  1989.   </tr>

  1990. </table>

  1991. <h3>Examples</h3>

  1992. <pre>  &lt;echo message=&quot;Hello world&quot; /&gt;</pre>

  1993. <pre>  

  1994. &lt;echo&gt;

  1995. This is a longer message stretching over

  1996. two lines.

  1997. &lt;/echo&gt;

  1998. </pre>

  1999. <hr>

  2000. <h2><a name="exec">Exec</a></h2>

  2001. <h3>Description</h3>

  2002. <p>Executes a system command. When the <i>os</i> attribute is specified, then

  2003. the command is only executed when Ant is run on one of the specified operating

  2004. systems.</p>

  2005. <h3>Parameters</h3>

  2006. <table border="1" cellpadding="2" cellspacing="0">

  2007.   <tr>

  2008.     <td valign="top"><b>Attribute</b></td>

  2009.     <td valign="top"><b>Description</b></td>

  2010.     <td align="center" valign="top"><b>Required</b></td>

  2011.   </tr>

  2012.   <tr>

  2013.     <td valign="top">command</td>

  2014.     <td valign="top">the command to execute with all command line

  2015.       arguments. <b>deprecated, use executable and nested

  2016.       <code>&lt;arg&gt;</code> elements instead</b>.</td>

  2017.     <td align="center" rowspan="2">Exactly one of the two.</td>

  2018.   </tr>

  2019.   <tr>

  2020.     <td valign="top">executable</td>

  2021.     <td valign="top">the command to execute without any command line

  2022.       arguments.</td>

  2023.   </tr>

  2024.   <tr>

  2025.     <td valign="top">dir</td>

  2026.     <td valign="top">the directory in which the command should be executed.</td>

  2027.     <td align="center" valign="top">No</td>

  2028.   </tr>

  2029.   <tr>

  2030.     <td valign="top">os</td>

  2031.     <td valign="top">list of Operating Systems on which the command may be

  2032.       executed.</td>

  2033.     <td align="center" valign="top">No</td>

  2034.   </tr>

  2035.   <tr>

  2036.     <td valign="top">output</td>

  2037.     <td valign="top">the file to which the output of the command should be

  2038.       redirected.</td>

  2039.     <td align="center" valign="top">No</td>

  2040.   </tr>

  2041.   <tr>

  2042.     <td valign="top">timeout</td>

  2043.     <td valign="top">Stop the command if it doesn't finish within the

  2044.       specified time (given in milliseconds).</td>

  2045.     <td align="center" valign="top">No</td>

  2046.   </tr>

  2047.   <tr>

  2048.     <td valign="top">failonerror</td>

  2049.     <td valign="top">Stop the buildprocess if the command exits with a

  2050.       returncode other than 0.</td>

  2051.     <td align="center" valign="top">No</td>

  2052.   </tr>

  2053.   <tr>

  2054.     <td valign="top">newenvironment</td>

  2055.     <td valign="top">Do not propagate old environment when new environment

  2056.       variables are specified.</td>

  2057.     <td align="center" valign="top">No, default is <em>false</em></td>

  2058.   </tr>

  2059. </table>

  2060. <h3>Examples</h3>

  2061. <blockquote>

  2062.   <p><code>&lt;exec dir=&quot;${src}&quot; executable=&quot;dir&quot; os=&quot;windows&quot;

  2063.   output=&quot;dir.txt&quot; /&gt;</code></p>

  2064. </blockquote>

  2065. <h3>Parameters specified as nested elements</h3>

  2066. <h4>arg</h4>

  2067. <p>Command line arguments should be specified as nested

  2068. <code>&lt;arg&gt;</code> elements. See <a

  2069. href="index.html#arg">Command line arguments</a>.</p>

  2070. <h4><a name="env">env</a></h4>

  2071. <p>It is possible to specify environment variables to pass to the

  2072. system command via nested <code>&lt;env&gt;</code> elements.</p>

  2073. <p>Please note that the environment of the current Ant process is

  2074. <b>not</b> passed to the system command if you specify variables using

  2075. <code>&lt;env&gt;</code>.</p>

  2076. <table border="1" cellpadding="2" cellspacing="0">

  2077.   <tr>

  2078.     <td valign="top"><b>Attribute</b></td>

  2079.     <td valign="top"><b>Description</b></td>

  2080.     <td align="center" valign="top"><b>Required</b></td>

  2081.   </tr>

  2082.   <tr>

  2083.     <td valign="top">key</td>

  2084.     <td valign="top">The name of the environment variable.</td>

  2085.     <td align="center" valign="top">Yes</td>

  2086.   </tr>

  2087.   <tr>

  2088.     <td valign="top">value</td>

  2089.     <td valign="top">The literal value for the environment variable.</td>

  2090.     <td align="center" rowspan="3">Exactly one of these.</td>

  2091.   </tr>

  2092.   <tr>

  2093.     <td valign="top">path</td>

  2094.     <td valign="top">The value for a PATH like environment

  2095.       variable. You can use ; or : as path separators and Ant will

  2096.       convert it to the platform's local conventions.</td>

  2097.   </tr>

  2098.   <tr>

  2099.     <td valign="top">file</td>

  2100.     <td valign="top">The value for the environment variable. Will be

  2101.       replaced by the absolute filename of the file by Ant.</td>

  2102.   </tr>

  2103. </table>

  2104. <h5>Examples</h5>

  2105. <blockquote><pre>

  2106. &lt;exec executable=&quot;emacs&quot; &gt;

  2107.   &lt;env key=&quot;DISPLAY&quot; value=&quot;:1.0&quot; /&gt;

  2108. &lt;/exec&gt;

  2109. </pre></blockquote>

  2110. <p>starts <code>emacs</code> on display 1 of the X Window System.</p>

  2111. <blockquote><pre>

  2112. &lt;exec ... &gt;

  2113.   &lt;env key=&quot;PATH&quot; path=&quot;${java.library.path}:${basedir}/bin&quot; /&gt;

  2114. &lt;/exec&gt;

  2115. </pre></blockquote>

  2116. <p>adds <code>${basedir}/bin</code> to the <code>PATH</code> of the

  2117. system command.</p>

  2118. <p><b>Note:</b> Although it may work for you to specify arguments using 

  2119. a simple arg-element and seperate them by spaces it may fail if you switch to

  2120. a newer version of the JDK. JDK &lt; 1.2 will pass these as separate arguments

  2121. to the program you are calling, JDK &gt;= 1.2 will pass them as a single 

  2122. argument and cause most calls to fail.</p>

  2123. <p><b>Note2:</b> If you are using Ant on Windows and a new DOS-Window pops up

  2124. for every command which is excuted this may be a problem of the JDK you are using.

  2125. This problem may occur with all JDK's &lt; 1.2.</p>

  2126. <hr>

  2127. <h2><a name="execon">ExecOn</a></h2>

  2128. <h3>Description</h3>

  2129. <p>Executes a system command. When the <i>os</i> attribute is specified, then

  2130. the command is only executed when Ant is run on one of the specified operating

  2131. systems.</p>

  2132. <p>The files and/or directories of a number of <a

  2133. href="#fileset">FileSet</a>s are passed as arguments to the system

  2134. command. At least one nested <code>&lt;fileset&gt;</code> is required.</p>

  2135. <h3>Parameters</h3>

  2136. <table border="1" cellpadding="2" cellspacing="0">

  2137.   <tr>

  2138.     <td valign="top"><b>Attribute</b></td>

  2139.     <td valign="top"><b>Description</b></td>

  2140.     <td align="center" valign="top"><b>Required</b></td>

  2141.   </tr>

  2142.   <tr>

  2143.     <td valign="top">executable</td>

  2144.     <td valign="top">the command to execute without any command line

  2145.       arguments.</td>

  2146.     <td align="center" valign="top">Yes</td>

  2147.   </tr>

  2148.   <tr>

  2149.     <td valign="top">dir</td>

  2150.     <td valign="top">the directory in which the command should be executed.</td>

  2151.     <td align="center" valign="top">No</td>

  2152.   </tr>

  2153.   <tr>

  2154.     <td valign="top">os</td>

  2155.     <td valign="top">list of Operating Systems on which the command may be

  2156.       executed.</td>

  2157.     <td align="center" valign="top">No</td>

  2158.   </tr>

  2159.   <tr>

  2160.     <td valign="top">output</td>

  2161.     <td valign="top">the file to which the output of the command should be

  2162.       redirected.</td>

  2163.     <td align="center" valign="top">No</td>

  2164.   </tr>

  2165.   <tr>

  2166.     <td valign="top">timeout</td>

  2167.     <td valign="top">Stop the command if it doesn't finish within the

  2168.       specified time (given in milliseconds).</td>

  2169.     <td align="center" valign="top">No</td>

  2170.   </tr>

  2171.   <tr>

  2172.     <td valign="top">failonerror</td>

  2173.     <td valign="top">Stop the buildprocess if the command exits with a

  2174.       returncode other than 0.</td>

  2175.     <td align="center" valign="top">No</td>

  2176.   </tr>

  2177.   <tr>

  2178.     <td valign="top">newenvironment</td>

  2179.     <td valign="top">Do not propagate old environment when new environment

  2180.       variables are specified.</td>

  2181.     <td align="center" valign="top">No, default is <em>false</em></td>

  2182.   </tr>

  2183.   <tr>

  2184.     <td valign="top">parallel</td>

  2185.     <td valign="top">Run the command only once, appending all files as

  2186.       arguments. Defaults to true. If false, command will be executed

  2187.       once for every file.</td>

  2188.     <td align="center" valign="top">No</td>

  2189.   </tr>

  2190.   <tr>

  2191.     <td valign="top">type</td>

  2192.     <td valign="top">One of <em>file</em>, <em>dir</em> or

  2193.       <em>both</em>. If set to <em>file</em>, only the names of plain

  2194.       files will be sent to the command. If set to <em>dir</em>, only

  2195.       the names of directories are considered.</td>

  2196.     <td align="center" valign="top">No, default is <em>file</em></td>

  2197.   </tr>

  2198. </table>

  2199. <h3>Parameters specified as nested elements</h3>

  2200. <h4>fileset</h4>

  2201. <p>You can use any number of nested <code>&lt;fileset&gt;</code>

  2202. elements to define the files for this task and refer to

  2203. <code>&lt;fileset&gt;</code>s defined elsewhere.</p>

  2204. <h4>arg</h4>

  2205. <p>Command line arguments should be specified as nested

  2206. <code>&lt;arg&gt;</code> elements. See <a

  2207. href="index.html#arg">Command line arguments</a>.</p>

  2208. <h4>srcfile</h4>

  2209. <p>By default the file names of the source files will be added to the

  2210. end of the command line. If you need to place it somewhere different,

  2211. use a nested <code>&lt;srcfile&gt;</code> element between your

  2212. <code>&lt;arg&gt;</code> elements to mark the insertion point.</code>

  2213. <h4>env</h4>

  2214. <p>It is possible to specify environment variables to pass to the

  2215. system command via nested <code>&lt;env&gt;</code> elements. See the

  2216. description in the section about <a href="#env">exec</a></p>

  2217. <p>Please note that the environment of the current Ant process is

  2218. <b>not</b> passed to the system command if you specify variables using

  2219. <code>&lt;env&gt;</code>.</p>

  2220. <h3>Examples</h3>

  2221. <blockquote><pre>

  2222. &lt;execon executable=&quot;ls&quot; &gt;

  2223.   &lt;arg value=&quot;-l&quot; /&gt;

  2224.   &lt;fileset dir=&quot;/tmp&quot;&gt;

  2225.     &lt;patternset&gt;

  2226.       &lt;exclude name=&quot;**/*.txt&quot; /&gt;

  2227.     &lt;/patternset&gt;

  2228.   &lt;/fileset&gt;

  2229.   &lt;fileset refid=&quot;other.files&quot; /&gt;

  2230. &lt;/execon&gt;

  2231. </pre></blockquote>

  2232. <p>invokes <code>ls -l</code>, adding the absolute filenames of all

  2233. files below <code>/tmp</code> not ending in <code>.txt</code> and all

  2234. files of the FileSet with <code>id</code> <code>other.files</code> to

  2235. the command line.</p>

  2236. <blockquote><pre>

  2237. &lt;execon executable=&quot;somecommand&quot; parallel=&quot;false&quot; &gt;

  2238.   &lt;arg value=&quot;arg1&quot; /&gt;

  2239.   &lt;srfile/&gt;

  2240.   &lt;arg value=&quot;arg2&quot; /&gt;

  2241.   &lt;fileset dir=&quot;/tmp&quot; /&gt;

  2242. &lt;/execon&gt;

  2243. </pre></blockquote>

  2244. <p>invokes <code>somecommand arg1 SOURCEFILENAME arg2</code> for each

  2245. file in <code>/tmp</code> replacing SOURCEFILENAME with the absolute

  2246. filename of each file in turn. If <code>parallel</code> had been set

  2247. to true, SOURCEFILENAME would be replaced with the absolute filenames

  2248. of all files separated by spaces.</p>

  2249. <hr>

  2250. <h2><a name="fail">Fail</a></h2>

  2251. <h3>Description</h3>

  2252. <p>Exits the current build (just throwing a BuildException), optionally printing additional information.</p>

  2253. <h3>Parameters</h3>

  2254. <table border="1" cellpadding="2" cellspacing="0">

  2255.   <tr>

  2256.     <td valign="top"><b>Attribute</b></td>

  2257.     <td valign="top"><b>Description</b></td>

  2258.     <td align="center" valign="top"><b>Required</b></td>

  2259.   </tr>

  2260.   <tr>

  2261.     <td valign="top">message</td>

  2262.     <td valign="top">A message giving further information on why the build exited</td>

  2263.     <td align="center" valign="top">No</td>

  2264.   </tr>

  2265. </table>

  2266. <h3>Examples</h3>

  2267. <pre>  &lt;fail/&gt;</pre>

  2268. <p>will exit the current build with no further information given.

  2269. <pre>

  2270. BUILD FAILED

  2271. 

  2272. build.xml:4: No message

  2273. </pre>

  2274. 

  2275. <pre>  &lt;fail message=&quot;Something wrong here.&quot;/&gt;</pre>

  2276. <p>will exit the current build and print something like the following to whereever

  2277. your output goes:

  2278. <pre>

  2279. BUILD FAILED

  2280. 

  2281. build.xml:4: Something wrong here.

  2282. </pre>

  2283. 

  2284. <hr>

  2285. <h2><a name="filter">Filter</a></h2>

  2286. <h3>Description</h3>

  2287. <p>Sets a token filter for this project or read multiple token filter from

  2288. an input file and sets these as filters.

  2289. Token filters are used by all tasks that perform file copying operations

  2290. through the Project commodity methods.</p>

  2291. <p>Note 1: the token string must not contain the separators chars (@).<br>

  2292. Note 2: Either token and value attributes must be provided, or only the

  2293. filterfile attribute.</p>

  2294. 

  2295. <h3>Parameters</h3>

  2296. <table border="1" cellpadding="2" cellspacing="0">

  2297.   <tr>

  2298.     <td valign="top"><b>Attribute</b></td>

  2299.     <td valign="top"><b>Description</b></td>

  2300.     <td align="center" valign="top"><b>Required</b></td>

  2301.   </tr>

  2302.   <tr>

  2303.     <td valign="top">token</td>

  2304.     <td valign="top">the token string without @</td>

  2305.     <td align="center" valign="top">Yes*</td>

  2306.   </tr>

  2307.   <tr>

  2308.     <td valign="top">value</td>

  2309.     <td valign="top">the string that should be put to replace the token when the 

  2310.       file is copied</td>

  2311.     <td align="center" valign="top">Yes*</td>

  2312.   </tr>

  2313.   <tr>

  2314.     <td valign="top">filtersfile</td>

  2315.     <td valign="top">The file from which the filters must be read. This file must be a formatted as a property file. </td>

  2316.     <td align="center" valign="top">Yes*</td>

  2317.   </tr>

  2318. </table>

  2319. <p>* see notes 1 and 2 above parameters table.</p>

  2320. <h3>Examples</h3>

  2321. <pre>  &lt;filter token=&quot;year&quot; value=&quot;2000&quot; /&gt;

  2322.   &lt;copy todir=&quot;${dest.dir}&quot;&gt;

  2323.     &lt;fileset dir=&quot;${src.dir}&quot; /&gt;

  2324.   &lt;/copy&gt;</pre> 

  2325. <p>will copy recursively all the files from the <i>src.dir</i> directory into

  2326. the <i>dest.dir</i> directory replacing all the occurencies of the string <i>@year@</i>

  2327. with <i>2000.</i></p>

  2328. <pre>  &lt;filter filterfile=&quot;deploy_env.properties&quot; /&gt;</pre>

  2329. will read all property entries from the <i>deploy_env.properties</i> file

  2330. and set these as filters.

  2331. 

  2332. <hr>

  2333. <h2><a name="fixcrlf">FixCRLF</a></h2>

  2334. <h3>Description</h3>

  2335. <p>Adjusts a text file to local.</p>

  2336. <p>It is possible to refine the set of files that are being adjusted. This can be

  2337. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>

  2338. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to

  2339. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify

  2340. the files you want to have excluded. This is also done with patterns. And

  2341. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  2342. want to use default exclusions or not. See the section on <a

  2343. href="#directorybasedtasks">directory based tasks</a>, on how the

  2344. inclusion/exclusion of files works, and how to write patterns.</p>

  2345. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  2346. supports all attributes of <code>&lt;fileset&gt;</code>

  2347. (<code>dir</code> becomes <code>srcdir</code>) as well as the nested

  2348. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  2349. <code>&lt;patternset&gt;</code> elements.</p>

  2350. <h3>Parameters</h3>

  2351. <table border="1" cellpadding="2" cellspacing="0">

  2352.   <tr>

  2353.     <td valign="top"><b>Attribute</b></td>

  2354.     <td valign="top"><b>Description</b></td>

  2355.     <td align="center" valign="top"><b>Required</b></td>

  2356.   </tr>

  2357.   <tr>

  2358.     <td valign="top">srcDir</td>

  2359.     <td valign="top">Where to find the files to be fixed up.</td>

  2360.     <td valign="top" align="center">Yes</td>

  2361.   </tr>

  2362.   <tr>

  2363.     <td valign="top">destDir</td>

  2364.     <td valign="top">Where to place the corrected files.  Defaults to

  2365.       srcDir (replacing the original file)</td>

  2366.     <td valign="top" align="center">No</td>

  2367.   </tr>

  2368.   <tr>

  2369.     <td valign="top">includes</td>

  2370.     <td valign="top">comma separated list of patterns of files that must be

  2371.       included. All files are included when omitted.</td>

  2372.     <td valign="top" align="center">No</td>

  2373.   </tr>

  2374.   <tr>

  2375.     <td valign="top">includesfile</td>

  2376.     <td valign="top">the name of a file. Each line of this file is

  2377.       taken to be an include pattern</td>

  2378.     <td valign="top" align="center">No</td>

  2379.   </tr>

  2380.   <tr>

  2381.     <td valign="top">excludes</td>

  2382.     <td valign="top">comma separated list of patterns of files that must be

  2383.       excluded. No files (except default excludes) are excluded when omitted.</td>

  2384.     <td valign="top" align="center">No</td>

  2385.   </tr>

  2386.   <tr>

  2387.     <td valign="top">excludesfile</td>

  2388.     <td valign="top">the name of a file. Each line of this file is

  2389.       taken to be an exclude pattern</td>

  2390.     <td valign="top" align="center">No</td>

  2391.   </tr>

  2392.   <tr>

  2393.     <td valign="top">defaultexcludes</td>

  2394.     <td valign="top">indicates whether default excludes should be used or not

  2395.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  2396.     <td valign="top" align="center">No</td>

  2397.   </tr>

  2398.   <tr>

  2399.     <td valign="top">cr</td>

  2400.     <td valign="top">Specifies how carriage return (CR) characters are to

  2401.       be handled.  Valid values for this property are:

  2402.       <ul>

  2403.       <li>add: ensure that there is a CR before every LF

  2404.       <li>asis: leave CR characters alone

  2405.       <li>remove: remove all CR characters

  2406.       </ul>

  2407.       Default is based on the platform on which you are running this task.

  2408.       For Unix platforms, the default is remove.  For DOS based systems

  2409.       (including Windows), the default is add.

  2410.       <p>

  2411.       Note: Unless this property is specified as &quot;asis&quot;, extra CR characters

  2412.       which do not precede a LF will be removed.

  2413.       </td>

  2414.     <td valign="top" align="center">No</td>

  2415.   </tr>

  2416.   <tr>

  2417.     <td valign="top">tab</td>

  2418.     <td valign="top">Specifies how tab characters are to be handled.  Valid

  2419.       values for this property are:

  2420.       <ul>

  2421.       <li>add: convert sequences of spaces which span a tab stop to tabs

  2422.       <li>asis: leave tab and space characters alone

  2423.       <li>remove: convert tabs to spaces

  2424.       </ul>

  2425.       Default for this parameter is &quot;asis&quot;.

  2426.       <p>

  2427.       Note: Unless this property is specified as &quot;asis&quot;, extra spaces and

  2428.       tabs after the last non-whitespace character on the line will be removed.

  2429.       </td>

  2430.     <td valign="top" align="center">No</td>

  2431.   </tr>

  2432.   <tr>

  2433.     <td valign="top">tablength</td>

  2434.     <td valign="top">The number of characters a TAB stop corresponds to. 

  2435.       Must be a positive power of 2, default for this parameter is 8.</td>

  2436.     <td valign="top" align="center">No</td>

  2437.   </tr>

  2438.   <tr>

  2439.     <td valign="top">eof</td>

  2440.     <td valign="top">Specifies how DOS end of file (control-Z) characters are

  2441.       to be handled.  Valid values for this property are:

  2442.       <ul>

  2443.       <li>add: ensure that there is an EOF character at the end of the file

  2444.       <li>asis: leave EOF characters alone

  2445.       <li>remove: remove any EOF character found at the end

  2446.       </ul>

  2447.       Default is based on the platform on which you are running this task.

  2448.       For Unix platforms, the default is remove.  For DOS based systems

  2449.       (including Windows), the default is asis.

  2450.       </td>

  2451.     <td valign="top" align="center">No</td>

  2452.   </tr>

  2453. </table>

  2454. <h3>Examples</h3>

  2455. <pre>  &lt;fixcrlf srcdir=&quot;${src}&quot;

  2456.        cr=&quot;remove&quot; eof=&quot;remove&quot;

  2457.        includes=&quot;**/*.sh&quot;

  2458.   /&gt;</pre>

  2459. <p>Removes carriage return and eof characters from the shell scripts.  Tabs and

  2460. spaces are left as is.

  2461. <pre>  &lt;fixcrlf srcdir=&quot;${src}&quot;

  2462.        cr=&quot;add&quot;

  2463.        includes=&quot;**/*.bat&quot;

  2464.   /&gt;</pre>

  2465. <p>Ensures that there are carriage return characters prior to evey line feed.

  2466. Tabs and spaces are left as is.

  2467. EOF characters are left alone if run on

  2468. DOS systems, and are removed if run on Unix systems.</p>

  2469. <pre>  &lt;fixcrlf srcdir=&quot;${src}&quot;

  2470.        tabs=&quot;add&quot;

  2471.        includes=&quot;**/Makefile&quot;

  2472.   /&gt;</pre>

  2473. <p>Adds or removes CR characters to match local OS conventions, and

  2474. converts spaces to tabs when appropriate.  EOF characters are left alone if

  2475. run on DOS systems, and are removed if run on Unix systems.

  2476. Many versions of make require tabs prior to commands.</p>

  2477. <pre>  &lt;fixcrlf srcdir=&quot;${src}&quot;

  2478.        tabs=&quot;remove&quot;

  2479.        includes=&quot;**/README*&quot;

  2480.   /&gt;</pre>

  2481. <p>Adds or removes CR characters to match local OS conventions, and

  2482. converts all tabs to spaces.  EOF characters are left alone if run on

  2483. DOS systems, and are removed if run on Unix systems.

  2484. You never know what editor a user will use to browse README's.</p>

  2485. <hr>

  2486. <h2><a name="genkey">GenKey</a></h2>

  2487. <h3>Description</h3>

  2488. <p>Generates a key in keystore.</p>

  2489. 

  2490. <h3>Parameters</h3>

  2491. <table border="1" cellpadding="2" cellspacing="0">

  2492.   <tr>

  2493.     <td valign="top"><b>Attribute</b></td>

  2494.     <td valign="top"><b>Description</b></td>

  2495.     <td align="center" valign="top"><b>Required</b></td>

  2496.   </tr>

  2497.   <tr>

  2498.     <td valign="top">alias</td>

  2499.     <td valign="top">the alias to add under</td>

  2500.     <td valign="top" align="center">Yes.</td>

  2501.   </tr>

  2502.   <tr>

  2503.     <td valign="top">storepass</td>

  2504.     <td valign="top">password for keystore integrity.</td>

  2505.     <td valign="top" align="center">Yes.</td>

  2506.   </tr>

  2507.   <tr>

  2508.     <td valign="top">keystore</td>

  2509.     <td valign="top">keystore location</td>

  2510.     <td valign="top" align="center">No</td>

  2511.   </tr>

  2512.   <tr>

  2513.     <td valign="top">storetype</td>

  2514.     <td valign="top">keystore type</td>

  2515.     <td valign="top" align="center">No</td>

  2516.   </tr>

  2517.   <tr>

  2518.     <td valign="top">keypass</td>

  2519.     <td valign="top">password for private key (if different)</td>

  2520.     <td valign="top" align="center">No</td>

  2521.   </tr>

  2522.   <tr>

  2523.     <td valign="top">sigalg</td>

  2524.     <td valign="top">the algorithm to use in signing</td>

  2525.     <td valign="top" align="center">No</td>

  2526.   </tr>

  2527.   <tr>

  2528.     <td valign="top">keyalg</td>

  2529.     <td valign="top">the method to use when generating name-value pair</td>

  2530.     <td valign="top" align="center">No</td>

  2531.   </tr>

  2532.   <tr>

  2533.     <td valign="top">verbose</td>

  2534.     <td valign="top">(true | false) verbose output when signing</td>

  2535.     <td valign="top" align="center">No</td>

  2536.   </tr>

  2537.   <tr>

  2538.     <td valign="top">dname</td>

  2539.     <td valign="top">The distinguished name for entity</td>

  2540.     <td valign="top" align="center">Yes if dname element unspecified</td>

  2541.   </tr>

  2542.   <tr>

  2543.     <td valign="top">validity</td>

  2544.     <td valign="top">(integer) indicates how many days certificate is valid</td>

  2545.     <td valign="top" align="center">No</td>

  2546.   </tr>

  2547.   <tr>

  2548.     <td valign="top">keysize</td>

  2549.     <td valign="top">(integer) indicates the size of key generated</td>

  2550.     <td valign="top" align="center">No</td>

  2551.   </tr>

  2552. </table>

  2553. 

  2554. <p>Alternatively you can specify the distinguished name by creating a sub-element named dname and populating it with param elements that have a name and a value. When using the subelement it is automatically encoded properly and , are replace

  2555. <p>The following two examples are identical: </p>

  2556. 

  2557. <h3>Examples</h3>

  2558. <blockquote>

  2559.   <p><code>&lt;genkey alias=&quot;apache-group&quot; storepass=&quot;secret&quot; 

  2560.   dname=&quot;CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US&quot; /&gt;</code></p>

  2561. </blockquote>

  2562. 

  2563. <blockquote>

  2564.   <pre><code>&lt;genkey alias=&quot;apache-group&quot; storepass=&quot;secret&quot; &gt;

  2565.   &lt;dname&gt;

  2566.     &lt;param name=&quot;CN&quot; value=&quot;Ant Group&quot;/&gt;

  2567.     &lt;param name=&quot;OU&quot; value=&quot;Jakarta Division&quot;/&gt;

  2568.     &lt;param name=&quot;O&quot;  value=&quot;Apache.Org&quot;/&gt;

  2569.     &lt;param name=&quot;C&quot;  value=&quot;US&quot;/&gt;

  2570.   &lt;/dname&gt;

  2571. &lt;/genkey&gt;</code></pre>

  2572. </blockquote>

  2573. <hr>

  2574. <h2><a name="get">Get</a></h2>

  2575. <h3>Description</h3>

  2576. <p>Gets a file from a URL. When the verbose option is &quot;on&quot;, this task

  2577. displays a '.' for every 100 Kb retrieved.</p>

  2578. <p>This task should be preferred above the <a href="#cvs">CVS task</a> when

  2579. doing automated builds. CVS is significantly slower than loading a compressed

  2580. archive with http/ftp.</p>

  2581. 

  2582. The <i>usetimestamps</i> option enables you to control downloads so that the remote file is

  2583. only fetched if newer than the local copy. If there is no local copy, the download always takes 

  2584. place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp,

  2585. if  the JVM is Java1.2 or later. 

  2586. NB: This timestamp facility only works on downloads using the HTTP protocol. 

  2587. <h3>Parameters</h3>

  2588. <table border="1" cellpadding="2" cellspacing="0">

  2589.   <tr>

  2590.     <td valign="top"><b>Attribute</b></td>

  2591.     <td valign="top"><b>Description</b></td>

  2592.     <td align="center" valign="top"><b>Required</b></td>

  2593.   </tr>

  2594.   <tr>

  2595.     <td valign="top">src</td>

  2596.     <td valign="top">the URL from which to retrieve a file.</td>

  2597.     <td align="center" valign="top">Yes</td>

  2598.   </tr>

  2599.   <tr>

  2600.     <td valign="top">dest</td>

  2601.     <td valign="top">the file where to store the retrieved file.</td>

  2602.     <td align="center" valign="top">Yes</td>

  2603.   </tr>

  2604.   <tr>

  2605.     <td valign="top">verbose</td>

  2606.     <td valign="top">show verbose progress information (&quot;on&quot;/&quot;off&quot;).</td>

  2607.     <td align="center" valign="top">No</td>

  2608.   </tr>

  2609.   <tr>

  2610.     <td valign="top">ignoreerrors</td>

  2611.     <td valign="top">Log errors but don't treat as fatal.</td>

  2612.     <td align="center" valign="top">No</td>

  2613.   </tr>

  2614.   <tr>

  2615.     <td valign="top">usetimestamps</td>

  2616.     <td valign="top">conditionally download a file based on the timestamp of the local copy.

  2617. 	HTTP only</td>

  2618.     <td align="center" valign="top">No</td>

  2619.   </tr>

  2620. </table>

  2621. <h3>Examples</h3>

  2622. <pre>  &lt;get src=&quot;http://jakarta.apache.org/&quot; dest=&quot;help/index.html&quot; /&gt;</pre>

  2623. <p>Gets the index page of http://jakarta.apache.org/, and stores it in the file <code>help/index.html</code>.</p>

  2624. 

  2625. <pre>  &lt;get src=&quot;http://jakarta.apache.org/builds/tomcat/nightly/ant.zip&quot; 

  2626. 	dest=&quot;optional.jar&quot; 

  2627. 	verbose=&quot;true&quot;

  2628. 	usetimestamps=&quot;true&quot;/&gt;</pre>

  2629. <p>

  2630. Gets the nightly ant build from the tomcat distribution, if the local copy

  2631. is missing or out of date. Uses the verbose option 

  2632. for progress information.

  2633. </p>

  2634. 

  2635. <hr>

  2636. <h2><a name="gunzip">GUnzip</a></h2>

  2637. <h3>Description</h3>

  2638. <p>Expands a GZip file.</p>

  2639. 

  2640. <p>If <i>dest</i> is a directory the name of the destination file is

  2641. the same as <i>src</i> (with the &quot;.gz&quot; extension removed if

  2642. present). If <i>dest</i> is omitted, the parent dir of <i>src</i> is

  2643. taken. The file is only expanded if the source file is newer than the

  2644. destination file, or when the destination file does not exist.</p>

  2645. 

  2646. <h3>Parameters</h3>

  2647. <table border="1" cellpadding="2" cellspacing="0">

  2648.   <tr>

  2649.     <td valign="top"><b>Attribute</b></td>

  2650.     <td valign="top"><b>Description</b></td>

  2651.     <td align="center" valign="top"><b>Required</b></td>

  2652.   </tr>

  2653.   <tr>

  2654.     <td valign="top">src</td>

  2655.     <td valign="top">the file to expand.</td>

  2656.     <td align="center" valign="top">Yes</td>

  2657.   </tr>

  2658.   <tr>

  2659.     <td valign="top">dest</td>

  2660.     <td valign="top">the destination file or directory.</td>

  2661.     <td align="center" valign="top">No</td>

  2662.   </tr>

  2663. </table>

  2664. <h3>Examples</h3>

  2665. <blockquote>

  2666.   <p><code>&lt;gunzip src=&quot;test.tar.gz&quot;/&gt;</code></p>

  2667. </blockquote>

  2668. <p>expands <i>test.tar.gz</i> to <i>test.tar</i></p>

  2669. <blockquote>

  2670.   <p><code>&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;test2.tar&quot;/&gt;</code></p>

  2671. </blockquote>

  2672. <p>expands <i>test.tar.gz</i> to <i>test2.tar</i></p>

  2673. <blockquote>

  2674.   <p><code>&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;subdir&quot;/&gt;</code></p>

  2675. </blockquote>

  2676. <p>expands <i>test.tar.gz</i> to <i>subdir/test.tar</i> (assuming

  2677. subdir is a directory).</p>

  2678. 

  2679. <hr>

  2680. <h2><a name="gzip">GZip</a></h2>

  2681. <h3>Description</h3>

  2682. <p>GZips a file.</p>

  2683. <h3>Parameters</h3>

  2684. <table border="1" cellpadding="2" cellspacing="0">

  2685.   <tr>

  2686.     <td valign="top"><b>Attribute</b></td>

  2687.     <td valign="top"><b>Description</b></td>

  2688.     <td align="center" valign="top"><b>Required</b></td>

  2689.   </tr>

  2690.   <tr>

  2691.     <td valign="top">src</td>

  2692.     <td valign="top">the file to gzip.</td>

  2693.     <td align="center" valign="top">Yes</td>

  2694.   </tr>

  2695.   <tr>

  2696.     <td valign="top">zipfile</td>

  2697.     <td valign="top">the destination file.</td>

  2698.     <td align="center" valign="top">Yes</td>

  2699.   </tr>

  2700. </table>

  2701. <h3>Examples</h3>

  2702. <blockquote>

  2703.   <p><code>&lt;gzip src=&quot;test.tar&quot; zipfile=&quot;test.tar.gz&quot;

  2704.   /&gt;</code></p>

  2705. </blockquote>

  2706. <hr>

  2707. <h2><a name="jar">Jar</a></h2>

  2708. <h3>Description</h3>

  2709. <p>Jars a set of files.</p>

  2710. <p>The <i>basedir</i> attribute is the reference directory from where to jar.</p>

  2711. <p>Note that file permissions will not be stored in the resulting jarfile.</p>

  2712. <p>It is possible to refine the set of files that are being jarred. This can be

  2713. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>

  2714. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to

  2715. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify

  2716. the files you want to have excluded. This is also done with patterns. And

  2717. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  2718. want to use default exclusions or not. See the section on <a

  2719. href="#directorybasedtasks">directory based tasks</a>, on how the

  2720. inclusion/exclusion of files works, and how to write patterns.</p>

  2721. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  2722. supports all attributes of <code>&lt;fileset&gt;</code>

  2723. (<code>dir</code> becomes <code>basedir</code>) as well as the nested

  2724. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  2725. <code>&lt;patternset&gt;</code> elements.</p>

  2726. <p>You can also use nested file sets for more flexibility, and specify

  2727. multiple ones to merge together different trees of files into one JAR.

  2728. See the <a href="#zip">Zip</a> task for more details and examples.</p>

  2729. <p>If the manifest is omitted, a simple one will be supplied by Ant.

  2730. You should not include <samp>META-INF/MANIFEST.MF</samp> in your set of files.

  2731. <p>The <code>whenempty</code> parameter controls what happens when no files match.

  2732. If <code>create</code> (the default), the JAR is created anyway with only a manifest.

  2733. If <code>skip</code>, the JAR is not created and a warning is issued.

  2734. If <code>fail</code>, the JAR is not created and the build is halted with an error.

  2735. <p>(The Jar task is a shortcut for specifying the manifest file of a JAR file. 

  2736. The same thing can be accomplished by using the <i>fullpath</i>

  2737. attribute of a prefixedfileset in a Zip task. The one difference is that if the

  2738. <i>manifest</i> attribute is not specified, the Jar task will 

  2739. include an empty one for you.)</p>

  2740. </p>

  2741. <h3>Parameters</h3>

  2742. <table border="1" cellpadding="2" cellspacing="0">

  2743.   <tr>

  2744.     <td valign="top"><b>Attribute</b></td>

  2745.     <td valign="top"><b>Description</b></td>

  2746.     <td align="center" valign="top"><b>Required</b></td>

  2747.   </tr>

  2748.   <tr>

  2749.     <td valign="top">jarfile</td>

  2750.     <td valign="top">the jar-file to create.</td>

  2751.     <td valign="top" align="center">Yes</td>

  2752.   </tr>

  2753.   <tr>

  2754.     <td valign="top">basedir</td>

  2755.     <td valign="top">the directory from which to jar the files.</td>

  2756.     <td valign="top" align="center">No</td>

  2757.   </tr>

  2758.   <tr>

  2759.     <td valign="top">compress</td>

  2760.     <td valign="top">Not only store data but also compress them, defaults to true</td>

  2761.     <td align="center" valign="top">No</td>

  2762.   </tr>

  2763.   <tr>

  2764.     <td valign="top">includes</td>

  2765.     <td valign="top">comma separated list of patterns of files that must be

  2766.       included. All files are included when omitted.</td>

  2767.     <td valign="top" align="center">No</td>

  2768.   </tr>

  2769.   <tr>

  2770.     <td valign="top">includesfile</td>

  2771.     <td valign="top">the name of a file. Each line of this file is

  2772.       taken to be an include pattern</td>

  2773.     <td valign="top" align="center">No</td>

  2774.   </tr>

  2775.   <tr>

  2776.     <td valign="top">excludes</td>

  2777.     <td valign="top">comma separated list of patterns of files that must be

  2778.       excluded. No files (except default excludes) are excluded when omitted.</td>

  2779.     <td valign="top" align="center">No</td>

  2780.   </tr>

  2781.   <tr>

  2782.     <td valign="top">excludesfile</td>

  2783.     <td valign="top">the name of a file. Each line of this file is

  2784.       taken to be an exclude pattern</td>

  2785.     <td valign="top" align="center">No</td>

  2786.   </tr>

  2787.   <tr>

  2788.     <td valign="top">defaultexcludes</td>

  2789.     <td valign="top">indicates whether default excludes should be used or not

  2790.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  2791.     <td valign="top" align="center">No</td>

  2792.   </tr>

  2793.   <tr>

  2794.     <td valign="top">manifest</td>

  2795.     <td valign="top">the manifest file to use.</td>

  2796.     <td valign="top" align="center">No</td>

  2797.   </tr>

  2798.   <tr>

  2799.     <td valign="top">whenempty</td>

  2800.     <td valign="top">Behavior to use if no files match.</td>

  2801.     <td valign="top" align="center">No</td>

  2802.   </tr>

  2803. </table>

  2804. <h3>Examples</h3>

  2805. <pre>  &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot; basedir=&quot;${build}/classes&quot; /&gt;</pre>

  2806. <p>jars all files in the <code>${build}/classes</code> directory into a file

  2807. called <code>app.jar</code> in the <code>${dist}/lib</code> directory.</p>

  2808. <pre>  &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot;

  2809.        basedir=&quot;${build}/classes&quot;

  2810.        excludes=&quot;**/Test.class&quot;

  2811.   /&gt;</pre>

  2812. <p>jars all files in the <code>${build}/classes</code> directory into a file

  2813. called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Files

  2814. with the name <code>Test.class</code> are excluded.</p>

  2815. <pre>  &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot;

  2816.        basedir=&quot;${build}/classes&quot;

  2817.        includes=&quot;mypackage/test/**&quot;

  2818.        excludes=&quot;**/Test.class&quot;

  2819.   /&gt;</pre>

  2820. <p>jars all files in the <code>${build}/classes</code> directory into a file

  2821. called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Only

  2822. files under the directory <code>mypackage/test</code> are used, and files with

  2823. the name <code>Test.class</code> are excluded.</p>

  2824. <pre>  &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot;&gt;

  2825.     &lt;fileset dir=&quot;${build}/classes&quot;

  2826.              excludes=&quot;**/Test.class&quot;

  2827.     /&gt;

  2828.     &lt;fileset dir=&quot;${src}/resources&quot;/&gt;

  2829.   &lt;/jar&gt;</pre>

  2830. <p>jars all files in the <code>${build}/classes</code> directory and also

  2831. in the <code>${src}/resources</code> directory together into a file

  2832. called <code>app.jar</code> in the <code>${dist}/lib</code> directory.

  2833. Files with the name <code>Test.class</code> are excluded.

  2834. If there are files such as <code>${build}/classes/mypackage/MyClass.class</code>

  2835. and <code>${src}/resources/mypackage/image.gif</code>, they will appear

  2836. in the same directory in the JAR (and thus be considered in the same package

  2837. by Java).</p>

  2838. 

  2839. <hr>

  2840. <h2><a name="java">Java</a></h2>

  2841. <h3>Description</h3>

  2842. <p>Executes a Java class within the running (Ant) VM or forks another VM if

  2843. specified.</p>

  2844. <p>Be careful that the executed class doesn't call System.exit(), because it

  2845. will terminate the VM and thus Ant. In case this happens, it's highly suggested

  2846. that you set the fork attribute so that System.exit() stops the other VM and not

  2847. the one that is currently running Ant.</p>

  2848. <h3>Parameters</h3>

  2849. <table border="1" cellpadding="2" cellspacing="0">

  2850.   <tr>

  2851.     <td valign="top"><b>Attribute</b></td>

  2852.     <td valign="top"><b>Description</b></td>

  2853.     <td align="center" valign="top"><b>Required</b></td>

  2854.   </tr>

  2855.   <tr>

  2856.     <td valign="top">classname</td>

  2857.     <td valign="top">the Java class to execute.</td>

  2858.     <td align="center" valign="top">Yes</td>

  2859.   </tr>

  2860.   <tr>

  2861.     <td valign="top">args</td>

  2862.     <td valign="top">the arguments for the class that is

  2863.       executed. <b>deprecated, use nested <code>&lt;arg&gt;</code>

  2864.       elements instead.</b></td>

  2865.     <td align="center" valign="top">No</td>

  2866.   </tr>

  2867.   <tr>

  2868.     <td valign="top">classpath</td>

  2869.     <td valign="top">the classpath to use.</td>

  2870.     <td align="center" valign="top">No</td>

  2871.   </tr>

  2872.   <tr>

  2873.     <td valign="top">classpathref</td>

  2874.     <td valign="top">the classpath to use, given as <a

  2875.       href="#references">reference</a> to a PATH defined elsewhere.</td>

  2876.     <td align="center" valign="top">No</td>

  2877.   </tr>

  2878.   <tr>

  2879.     <td valign="top">fork</td>

  2880.     <td valign="top">if enabled triggers the class execution in another VM

  2881.       (disabled by default)</td>

  2882.     <td align="center" valign="top">No</td>

  2883.   </tr>

  2884.   <tr>

  2885.     <td valign="top">jvm</td>

  2886.     <td valign="top">the command used to invoke the Java Virtual Machine,

  2887.       default is 'java'.  The command is resolved by java.lang.Runtime.exec().

  2888.       Ignored if fork is disabled.

  2889.     </td>

  2890.     <td align="center" valign="top">No</td>

  2891.   </tr>

  2892.   <tr>

  2893.     <td valign="top">jvmargs</td>

  2894.     <td valign="top">the arguments to pass to the forked VM (ignored

  2895.       if fork is disabled). <b>deprecated, use nested

  2896.       <code>&lt;jvmarg&gt;</code> elements instead.</b></td>

  2897.     <td align="center" valign="top">No</td>

  2898.   </tr>

  2899.   <tr>

  2900.     <td valign="top">maxmemory</td>

  2901.     <td valign="top">Max amount of memory to allocate to the forked VM

  2902.       (ignored if fork is disabled)</td>

  2903.     <td align="center" valign="top">No</td>

  2904.   </tr>

  2905.   <tr>

  2906.     <td valign="top">failonerror</td>

  2907.     <td valign="top">Stop the buildprocess if the command exits with a

  2908.       returncode other than 0. Only available if fork is true.</td>

  2909.     <td align="center" valign="top">No</td>

  2910.   </tr>

  2911.   <tr>

  2912.     <td valign="top">dir</td>

  2913.     <td valign="top">The directory to invoke the VM in.  (ignored if

  2914.       fork is disabled)</td>

  2915.     <td align="center" valign="top">No</td>

  2916.   </tr>

  2917.   <tr>

  2918.     <td valign="top">output</td>

  2919.     <td valign="top">Name of a file to write the output to.</td>

  2920.     <td align="center" valign="top">No</td>

  2921.   </tr>

  2922. </table>

  2923. <h3>Parameters specified as nested elements</h3>

  2924. <h4>arg and jvmarg</h4>

  2925. <p>Use nested <code>&lt;arg&gt;</code> and <code>&lt;jvmarg&gt;</code>

  2926. elements to specify arguments for the or the forked VM. See <a

  2927. href="index.html#arg">Command line arguments</a>.</p>

  2928. <h4>sysproperty</h4>

  2929. <p>Use nested <code>&lt;sysproperty&gt;</code>

  2930. elements to specify system properties required by the class. 

  2931. These properties will be made available to the VM during the execution

  2932. of the class (either ANT's VM or the forked VM). The attributes

  2933. for this element are the same as for <a href="index.html#env">environment

  2934. variables</a>.</p>

  2935. <h4>classpath</h4>

  2936. <p><code>Java</code>'s <em>classpath</em> attribute is a <a

  2937. href="#path">PATH like structure</a> and can also be set via a nested

  2938. <em>classpath</em> element.</p>

  2939. <h5>Example</h5>

  2940. <pre>  

  2941.        &lt;java classname=&quot;test.Main&quot; &gt;

  2942.          &lt;arg value=&quot;-h&quot; /&gt; 

  2943.          &lt;classpath&gt;

  2944.            &lt;pathelement location=&quot;\test.jar&quot; /&gt;

  2945.            &lt;pathelement path=&quot;${java.class.path}&quot; /&gt;

  2946.          &lt;/classpath&gt;

  2947.        &lt;/java&gt;

  2948. </pre>

  2949. <h3>Examples</h3>

  2950. <pre>  &lt;java classname=&quot;test.Main&quot; /&gt;</pre>

  2951. <pre>  &lt;java classname=&quot;test.Main&quot;

  2952.         fork=&quot;yes&quot; &gt;

  2953.     &lt;sysproperty key=&quot;DEBUG&quot; value=&quot;true&quot; /&gt; 

  2954.     &lt;arg value=&quot;-h&quot; /&gt; 

  2955.     &lt;jvmarg value=&quot;-Xrunhprof:cpu=samples,file=log.txt,depth=3&quot; /&gt; 

  2956.   &lt;/java&gt;

  2957. </pre>

  2958. 

  2959. <hr>

  2960. <h2><a name="javac">Javac</a></h2>

  2961. <h3>Description</h3>

  2962. <p>Compiles a source tree within the running (Ant) VM.</p>

  2963. <p>The source and destination directory will be recursively scanned for Java

  2964. source files to compile. Only Java files that have no corresponding class file

  2965. or where the class file is older than the java file will be compiled.</p>

  2966. <p>The directory structure of the source tree should follow the package

  2967. hierarchy.</p>

  2968. <p>It is possible to refine the set of files that are being compiled/copied.

  2969. This can be done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>

  2970. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to

  2971. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify

  2972. the files you want to have excluded. This is also done with patterns. And

  2973. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  2974. want to use default exclusions or not. See the section on <a

  2975. href="#directorybasedtasks">directory based tasks</a>, on how the

  2976. inclusion/exclusion of files works, and how to write patterns.</p>

  2977. <p>It is possible to use different compilers. This can be selected with the

  2978. &quot;build.compiler&quot; property. There are four choices:</p>

  2979. <ul>

  2980.   <li>classic (the standard compiler of JDK 1.1/1.2)</li>

  2981.   <li>modern (the new compiler of JDK 1.3)</li>

  2982.   <li>jikes (the <a

  2983.     href="http://oss.software.ibm.com/developerworks/opensource/jikes/project">Jikes</a>

  2984.     compiler)</li>

  2985.   <li>jvc (the Command-Line Compiler from Microsoft's SDK for Java /

  2986.     Visual J++)</li>

  2987. </ul>

  2988. <p>For JDK 1.1/1.2 is classic the default. For JDK 1.3 is modern the default.</p>

  2989. <h3>Parameters</h3>

  2990. <table border="1" cellpadding="2" cellspacing="0">

  2991.   <tr>

  2992.     <td valign="top"><b>Attribute</b></td>

  2993.     <td valign="top"><b>Description</b></td>

  2994.     <td align="center" valign="top"><b>Required</b></td>

  2995.   </tr>

  2996.   <tr>

  2997.     <td valign="top">srcdir</td>

  2998.     <td valign="top">location of the java files.</td>

  2999.     <td align="center" valign="top">Yes, unless nested <code>&lt;src&gt;</code> elements are present.</td>

  3000.   </tr>

  3001.   <tr>

  3002.     <td valign="top">destdir</td>

  3003.     <td valign="top">location where to store the class files.</td>

  3004.     <td align="center" valign="top">No</td>

  3005.   </tr>

  3006.   <tr>

  3007.     <td valign="top">includes</td>

  3008.     <td valign="top">comma separated list of patterns of files that must be

  3009.       included. All files are included when omitted.</td>

  3010.     <td valign="top" align="center">No</td>

  3011.   </tr>

  3012.   <tr>

  3013.     <td valign="top">includesfile</td>

  3014.     <td valign="top">the name of a file. Each line of this file is

  3015.       taken to be an include pattern</td>

  3016.     <td valign="top" align="center">No</td>

  3017.   </tr>

  3018.   <tr>

  3019.     <td valign="top">excludes</td>

  3020.     <td valign="top">comma separated list of patterns of files that must be

  3021.       excluded. No files (except default excludes) are excluded when omitted.</td>

  3022.     <td valign="top" align="center">No</td>

  3023.   </tr>

  3024.   <tr>

  3025.     <td valign="top">excludesfile</td>

  3026.     <td valign="top">the name of a file. Each line of this file is

  3027.       taken to be an exclude pattern</td>

  3028.     <td valign="top" align="center">No</td>

  3029.   </tr>

  3030.   <tr>

  3031.     <td valign="top">defaultexcludes</td>

  3032.     <td valign="top">indicates whether default excludes should be used or not

  3033.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  3034.     <td valign="top" align="center">No</td>

  3035.   </tr>

  3036.   <tr>

  3037.     <td valign="top">classpath</td>

  3038.     <td valign="top">the classpath to use.</td>

  3039.     <td align="center" valign="top">No</td>

  3040.   </tr>

  3041.   <tr>

  3042.     <td valign="top">bootclasspath</td>

  3043.     <td valign="top">location of bootstrap class files.</td>

  3044.     <td align="center" valign="top">No</td>

  3045.   </tr>

  3046.   <tr>

  3047.     <td valign="top">classpathref</td>

  3048.     <td valign="top">the classpath to use, given as <a

  3049.       href="#references">reference</a> to a PATH defined elsewhere.</td>

  3050.     <td align="center" valign="top">No</td>

  3051.   </tr>

  3052.   <tr>

  3053.     <td valign="top">bootclasspathref</td>

  3054.     <td valign="top">location of bootstrap class files, given as by <a

  3055.       href="#references">reference</a> to a PATH defined elsewhere.</td>

  3056.     <td align="center" valign="top">No</td>

  3057.   </tr>

  3058.   <tr>

  3059.     <td valign="top">extdirs</td>

  3060.     <td valign="top">location of installed extensions.</td>

  3061.     <td align="center" valign="top">No</td>

  3062.   </tr>

  3063.   <tr>

  3064.     <td valign="top">encoding</td>

  3065.     <td valign="top">encoding of source files.</td>

  3066.     <td align="center" valign="top">No</td>

  3067.   </tr>

  3068.   <tr>

  3069.     <td valign="top">debug</td>

  3070.     <td valign="top">indicates whether there should be compiled with debug

  3071.       information (&quot;off&quot;).</td>

  3072.     <td align="center" valign="top">No</td>

  3073.   </tr>

  3074.   <tr>

  3075.     <td valign="top">optimize</td>

  3076.     <td valign="top">indicates whether there should be compiled with

  3077.       optimization (&quot;off&quot;).</td>

  3078.     <td align="center" valign="top">No</td>

  3079.   </tr>

  3080.   <tr>

  3081.     <td valign="top">deprecation</td>

  3082.     <td valign="top">indicates whether there should be compiled with deprecation

  3083.       information (&quot;off&quot;).</td>

  3084.     <td align="center" valign="top">No</td>

  3085.   </tr>

  3086.   <tr>

  3087.     <td valign="top">target</td>

  3088.     <td valign="top">Generate class files for specific VM version, e.g.

  3089. 	 &quot;1.1&quot; or &quot;1.2&quot;.</td>

  3090.     <td align="center" valign="top">No</td>

  3091.   </tr>

  3092.   <tr>

  3093.     <td valign="top">verbose</td>

  3094.     <td valign="top">asks the compiler for verbose output.</td>

  3095.     <td align="center" valign="top">No</td>

  3096.   </tr>

  3097.   <tr>

  3098.     <td valign="top">depend</td> <td valign="top">enables dependency

  3099.       tracking for compilers that support this (jikes and classic)</td>

  3100.     <td align="center" valign="top">No</td>

  3101.   </tr>

  3102. </table>

  3103. 

  3104. <h3>Parameters specified as nested elements</h3>

  3105. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  3106. supports all attributes of <code>&lt;fileset&gt;</code>

  3107. (<code>dir</code> becomes <code>srcdir</code>) as well as the nested

  3108. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  3109. <code>&lt;patternset&gt;</code> elements.</p>

  3110. <h4>src, classpath, bootclasspath and extdirs</h4>

  3111. <p><code>Javac</code>'s <em>srcdir</em>, <em>classpath</em>,

  3112. <em>bootclasspath</em> and <em>extdirs</em> attributes are <a

  3113. href="#path">PATH like structure</a> and can also be set via nested

  3114. <em>src</em>, <em>classpath</em>, <em>bootclasspath</em> and

  3115. <em>extdirs</em> elements respectively.</p>

  3116. 

  3117. <h3>Examples</h3>

  3118. <pre>  &lt;javac srcdir=&quot;${src}&quot;

  3119.          destdir=&quot;${build}&quot;

  3120.          classpath=&quot;xyz.jar&quot;

  3121.          debug=&quot;on&quot;

  3122.   /&gt;</pre>

  3123. <p>compiles all .java files under the directory <code>${src}</code>, and stores

  3124. the .class files in the directory <code>${build}</code>. 

  3125. The classpath used contains <code>xyz.jar</code>, and debug information is on.</p>

  3126. <pre>  &lt;javac srcdir=&quot;${src}&quot;

  3127.          destdir=&quot;${build}&quot;

  3128.          includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;

  3129.          excludes=&quot;mypackage/p1/testpackage/**&quot;

  3130.          classpath=&quot;xyz.jar&quot;

  3131.          debug=&quot;on&quot;

  3132.   /&gt;</pre>

  3133. <p>compiles .java files under the directory <code>${src}</code>, and stores the

  3134. .class files in the directory <code>${build}</code>. 

  3135. The classpath used contains <code>xyz.jar</code>, and debug information is on.

  3136. Only files under <code>mypackage/p1</code> and <code>mypackage/p2</code> are

  3137. used. Files in the <code>mypackage/p1/testpackage</code> directory are excluded

  3138. form compilation and copy.</p>

  3139. 

  3140. <pre>  &lt;javac srcdir=&quot;${src}:${src2}&quot;

  3141.          destdir=&quot;${build}&quot;

  3142.          includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;

  3143.          excludes=&quot;mypackage/p1/testpackage/**&quot;

  3144.          classpath=&quot;xyz.jar&quot;

  3145.          debug=&quot;on&quot;

  3146.   /&gt;</pre>

  3147. 

  3148. <p>is the same as the previous example with the addition of a second source path, defined by

  3149. the propery <code>src2</code>. This can also be represented using nested elements as follows

  3150. 

  3151. <pre>  &lt;javac destdir=&quot;${build}&quot;

  3152.          classpath=&quot;xyz.jar&quot;

  3153.          debug=&quot;on&quot;&gt;

  3154.     &lt;src path=&quot;${src}&quot; /&gt;

  3155.     &lt;src path=&quot;${src2}&quot; /&gt;

  3156.     &lt;include name=&quot;mypackage/p1/**&quot; /&gt;

  3157.     &lt;include name=&quot;mypackage/p2/**&quot; /&gt;

  3158.     &lt;exclude name=&quot;mypackage/p1/testpackage/**&quot; /&gt;

  3159.   &lt;/javac&gt;</pre>

  3160. 

  3161. <p><b>Note:</b> If you are using Ant on Windows and a new DOS-Window pops up

  3162. for every use of an external compiler this may be a problem of the JDK you are using.

  3163. This problem may occur with all JDK's &lt; 1.2.</p>

  3164. 

  3165. <hr>

  3166. <h2><a name="javadoc">Javadoc/Javadoc2</a></h2>

  3167. <h3>Description</h3>

  3168. <p>Generates code documentation using the javadoc tool.</p>

  3169. <p>The source directory will be recursively scanned for Java source files to process

  3170. but only those matching the inclusion rules will be passed to the javadoc tool. This

  3171. allows wildcards to be used to choose between package names, reducing verbosity

  3172. and management costs over time. This task, however, has no notion of

  3173. &quot;changed&quot; files, unlike the <a href="#javac">javac</a> task. This means

  3174. all packages will be processed each time this task is run. In general, however,

  3175. this task is used much less frequently.</p>

  3176. <p>This task works seamlessly between different javadoc versions (1.1 and 1.2),

  3177. with the obvious restriction that the 1.2 attributes will be ignored if run in a

  3178. 1.1 VM.</p>

  3179. <p>NOTE: since javadoc calls System.exit(), javadoc cannot be run inside the

  3180. same VM as ant without breaking functionality. For this reason, this task 

  3181. always forks the VM. This overhead is not significant since javadoc is normally a heavy

  3182. application and will be called infrequently.</p>

  3183. <p>NOTE: the packagelist attribute allows you to specify the list of packages to 

  3184. document outside of the Ant file. It's a much better practice to include everything 

  3185. inside the build.xml file. This option was added in order to make it easier to 

  3186. migrate from regular makefiles, where you would use this option of javadoc. 

  3187. The packages listed in packagelist are not checked, so the task performs even 

  3188. if some packages are missing or broken. Use this option if you wish to convert from 

  3189. an existing makefile. Once things are running you should then switch to the regular 

  3190. notation. 

  3191. 

  3192. <p>DEPRECATION: the javadoc2 task simply points to the javadoc task and it's

  3193. there for back compatibility reasons. Since this task will be removed in future

  3194. versions, you are strongly encouraged to use <a href="#javadoc">javadoc</a>

  3195. instead.</p>

  3196. <h3>Parameters</h3>

  3197. <table border="1" cellpadding="2" cellspacing="0">

  3198.   <tr>

  3199.     <td valign="top"><b>Attribute</b></td>

  3200.     <td valign="top"><b>Description</b></td>

  3201.     <td align="center" valign="top"><b>Availability</b></td>

  3202.     <td align="center" valign="top"><b>Required</b></td>

  3203.   </tr>

  3204.   <tr>

  3205.     <td valign="top">sourcepath</td>

  3206.     <td valign="top">Specify where to find source files</td>

  3207.     <td align="center" valign="top">all</td>

  3208.     <td align="center" rowspan="2">At least one of the two or nested

  3209.       <code>&lt;sourcepath&gt;</code></td>

  3210.   </tr>

  3211.   <tr>

  3212.     <td valign="top">sourcepathref</td>

  3213.     <td valign="top">Specify where to find source files by <a

  3214.       href="#references">reference</a> to a PATH defined elsewhere.</td>

  3215.     <td align="center" valign="top">all</td>

  3216.   </tr>

  3217.   <tr>

  3218.     <td valign="top">destdir</td>

  3219.     <td valign="top">Destination directory for output files</td>

  3220.     <td align="center" valign="top">all</td>

  3221.     <td align="center" valign="top">Yes</td>

  3222.   </tr>

  3223.   <tr>

  3224.     <td valign="top">maxmemory</td>

  3225.     <td valign="top">Max amount of memory to allocate to the javadoc VM</td>

  3226.     <td align="center" valign="top">all</td>

  3227.     <td align="center" valign="top">No</td>

  3228.   </tr>

  3229.   <tr>

  3230.     <td valign="top">sourcefiles</td>

  3231.     <td valign="top">Space separated list of source files</td>

  3232.     <td align="center" valign="top">all</td>

  3233.     <td align="center" valign="middle" rowspan="2">at least one of the two</td>

  3234.   </tr>

  3235.   <tr>

  3236.     <td valign="top">packagenames</td>

  3237.     <td valign="top">Comma separated list of package files (with terminating

  3238.       wildcard)</td>

  3239.     <td align="center" valign="top">all</td>

  3240.   </tr>

  3241.   <tr>

  3242.     <td valign="top">packageList</td>

  3243.     <td valign="top">The name of a file containing the packages to process</td>

  3244.     <td align="center" valign="top">all</td>

  3245.     <td align="center" valign="top">No</td>

  3246.   </tr>

  3247.   <tr>

  3248.     <td valign="top">classpath</td>

  3249.     <td valign="top">Specify where to find user class files</td>

  3250.     <td align="center" valign="top">all</td>

  3251.     <td align="center" valign="top">No</td>

  3252.   </tr>

  3253.   <tr>

  3254.     <td valign="top">Bootclasspath</td>

  3255.     <td valign="top">Override location of class files loaded by the bootstrap

  3256.       class loader</td>

  3257.     <td align="center" valign="top">1.2</td>

  3258.     <td align="center" valign="top">No</td>

  3259.   </tr>

  3260.   <tr>

  3261.     <td valign="top">classpathref</td>

  3262.     <td valign="top">Specify where to find user class files by <a

  3263.       href="#references">reference</a> to a PATH defined elsewhere.</td>

  3264.     <td align="center" valign="top">all</td>

  3265.     <td align="center" valign="top">No</td>

  3266.   </tr>

  3267.   <tr>

  3268.     <td valign="top">bootclasspathref</td>

  3269.     <td valign="top">Override location of class files loaded by the

  3270.       bootstrap class loader by <a href="#references">reference</a> to a

  3271.       PATH defined elsewhere.</td>

  3272.     <td align="center" valign="top">1.2</td>

  3273.     <td align="center" valign="top">No</td>

  3274.   </tr>

  3275.   <tr>

  3276.     <td valign="top">Extdirs</td>

  3277.     <td valign="top">Override location of installed extensions</td>

  3278.     <td align="center" valign="top">1.2</td>

  3279.     <td align="center" valign="top">No</td>

  3280.   </tr>

  3281.   <tr>

  3282.     <td valign="top">Overview</td>

  3283.     <td valign="top">Read overview documentation from HTML file</td>

  3284.     <td align="center" valign="top">1.2</td>

  3285.     <td align="center" valign="top">No</td>

  3286.   </tr>

  3287.   <tr>

  3288.     <td valign="top">Public</td>

  3289.     <td valign="top">Show only public classes and members</td>

  3290.     <td align="center" valign="top">all</td>

  3291.     <td align="center" valign="top">No</td>

  3292.   </tr>

  3293.   <tr>

  3294.     <td valign="top">Protected</td>

  3295.     <td valign="top">Show protected/public classes and members (default)</td>

  3296.     <td align="center" valign="top">all</td>

  3297.     <td align="center" valign="top">No</td>

  3298.   </tr>

  3299.   <tr>

  3300.     <td valign="top">Package</td>

  3301.     <td valign="top">Show package/protected/public classes and members</td>

  3302.     <td align="center" valign="top">all</td>

  3303.     <td align="center" valign="top">No</td>

  3304.   </tr>

  3305.   <tr>

  3306.     <td valign="top">Private</td>

  3307.     <td valign="top">Show all classes and members</td>

  3308.     <td align="center" valign="top">all</td>

  3309.     <td align="center" valign="top">No</td>

  3310.   </tr>

  3311.   <tr>

  3312.     <td valign="top">Old</td>

  3313.     <td valign="top">Generate output using JDK 1.1 emulating doclet</td>

  3314.     <td align="center" valign="top">1.2</td>

  3315.     <td align="center" valign="top">No</td>

  3316.   </tr>

  3317.   <tr>

  3318.     <td valign="top">Verbose</td>

  3319.     <td valign="top">Output messages about what Javadoc is doing</td>

  3320.     <td align="center" valign="top">1.2</td>

  3321.     <td align="center" valign="top">No</td>

  3322.   </tr>

  3323.   <tr>

  3324.     <td valign="top">Locale</td>

  3325.     <td valign="top">Locale to be used, e.g. en_US or en_US_WIN</td>

  3326.     <td align="center" valign="top">1.2</td>

  3327.     <td align="center" valign="top">No</td>

  3328.   </tr>

  3329.   <tr>

  3330.     <td valign="top">Encoding</td>

  3331.     <td valign="top">Source file encoding name</td>

  3332.     <td align="center" valign="top">all</td>

  3333.     <td align="center" valign="top">No</td>

  3334.   </tr>

  3335.   <tr>

  3336.     <td valign="top">Version</td>

  3337.     <td valign="top">Include @version paragraphs</td>

  3338.     <td align="center" valign="top">all</td>

  3339.     <td align="center" valign="top">No</td>

  3340.   </tr>

  3341.   <tr>

  3342.     <td valign="top">Use</td>

  3343.     <td valign="top">Create class and package usage pages</td>

  3344.     <td align="center" valign="top">1.2</td>

  3345.     <td align="center" valign="top">No</td>

  3346.   </tr>

  3347.   <tr>

  3348.     <td valign="top">Author</td>

  3349.     <td valign="top">Include @author paragraphs</td>

  3350.     <td align="center" valign="top">all</td>

  3351.     <td align="center" valign="top">No</td>

  3352.   </tr>

  3353.   <tr>

  3354.     <td valign="top">Splitindex</td>

  3355.     <td valign="top">Split index into one file per letter</td>

  3356.     <td align="center" valign="top">1.2</td>

  3357.     <td align="center" valign="top">No</td>

  3358.   </tr>

  3359.   <tr>

  3360.     <td valign="top">Windowtitle</td>

  3361.     <td valign="top">Browser window title for the documentation (text)</td>

  3362.     <td align="center" valign="top">1.2</td>

  3363.     <td align="center" valign="top">No</td>

  3364.   </tr>

  3365.   <tr>

  3366.     <td valign="top">Doctitle</td>

  3367.     <td valign="top">Include title for the package index(first) page (html-code)</td>

  3368.     <td align="center" valign="top">1.2</td>

  3369.     <td align="center" valign="top">No</td>

  3370.   </tr>

  3371.   <tr>

  3372.     <td valign="top">Header</td>

  3373.     <td valign="top">Include header text for each page (html-code)</td>

  3374.     <td align="center" valign="top">1.2</td>

  3375.     <td align="center" valign="top">No</td>

  3376.   </tr>

  3377.   <tr>

  3378.     <td valign="top">Footer</td>

  3379.     <td valign="top">Include footer text for each page (html-code)</td>

  3380.     <td align="center" valign="top">1.2</td>

  3381.     <td align="center" valign="top">No</td>

  3382.   </tr>

  3383.   <tr>

  3384.     <td valign="top">bottom</td>

  3385.     <td valign="top">Include bottom text for each page (html-code)</td>

  3386.     <td align="center" valign="top">1.2</td>

  3387.     <td align="center" valign="top">No</td>

  3388.   </tr>

  3389.   <tr>

  3390.     <td valign="top">link</td>

  3391.     <td valign="top">Create links to javadoc output at the given URL</td>

  3392.     <td align="center" valign="top">1.2</td>

  3393.     <td align="center" valign="top">No</td>

  3394.   </tr>

  3395.   <tr>

  3396.     <td valign="top">linkoffline</td>

  3397.     <td valign="top">Link to docs at &lt;url&gt; using package list at

  3398.       &lt;url2&gt;</td>

  3399.     <td align="center" valign="top">1.2</td>

  3400.     <td align="center" valign="top">No</td>

  3401.   </tr>

  3402.   <tr>

  3403.     <td valign="top">group</td>

  3404.     <td valign="top">Group specified packages together in overview page</td>

  3405.     <td align="center" valign="top">1.2</td>

  3406.     <td align="center" valign="top">No</td>

  3407.   </tr>

  3408.   <tr>

  3409.     <td valign="top">nodeprecated</td>

  3410.     <td valign="top">Do not include @deprecated information</td>

  3411.     <td align="center" valign="top">all</td>

  3412.     <td align="center" valign="top">No</td>

  3413.   </tr>

  3414.   <tr>

  3415.     <td valign="top">nodeprecatedlist</td>

  3416.     <td valign="top">Do not generate deprecated list</td>

  3417.     <td align="center" valign="top">1.2</td>

  3418.     <td align="center" valign="top">No</td>

  3419.   </tr>

  3420.   <tr>

  3421.     <td valign="top">notree</td>

  3422.     <td valign="top">Do not generate class hierarchy</td>

  3423.     <td align="center" valign="top">all</td>

  3424.     <td align="center" valign="top">No</td>

  3425.   </tr>

  3426.   <tr>

  3427.     <td valign="top">noindex</td>

  3428.     <td valign="top">Do not generate index</td>

  3429.     <td align="center" valign="top">all</td>

  3430.     <td align="center" valign="top">No</td>

  3431.   </tr>

  3432.   <tr>

  3433.     <td valign="top">nohelp</td>

  3434.     <td valign="top">Do not generate help link</td>

  3435.     <td align="center" valign="top">1.2</td>

  3436.     <td align="center" valign="top">No</td>

  3437.   </tr>

  3438.   <tr>

  3439.     <td valign="top">nonavbar</td>

  3440.     <td valign="top">Do not generate navigation bar</td>

  3441.     <td align="center" valign="top">1.2</td>

  3442.     <td align="center" valign="top">No</td>

  3443.   </tr>

  3444.   <tr>

  3445.     <td valign="top">serialwarn</td>

  3446.     <td valign="top">FUTURE: Generate warning about @serial tag</td>

  3447.     <td align="center" valign="top">1.2</td>

  3448.     <td align="center" valign="top">No</td>

  3449.   </tr>

  3450.   <tr>

  3451.     <td valign="top">helpfile</td>

  3452.     <td valign="top">FUTURE: Specifies the HTML help file to use</td>

  3453.     <td align="center" valign="top">1.2</td>

  3454.     <td align="center" valign="top">No</td>

  3455.   </tr>

  3456.   <tr>

  3457.     <td valign="top">stylesheetfile</td>

  3458.     <td valign="top">Specifies the CSS stylesheet to use</td>

  3459.     <td align="center" valign="top">1.2</td>

  3460.     <td align="center" valign="top">No</td>

  3461.   </tr>

  3462.   <tr>

  3463.     <td valign="top">charset</td>

  3464.     <td valign="top">FUTURE: Charset for cross-platform viewing of generated

  3465.       documentation</td>

  3466.     <td align="center" valign="top">1.2</td>

  3467.     <td align="center" valign="top">No</td>

  3468.   </tr>

  3469.   <tr>

  3470.     <td valign="top">docencoding</td>

  3471.     <td valign="top">Output file encoding name</td>

  3472.     <td align="center" valign="top">1.1</td>

  3473.     <td align="center" valign="top">No</td>

  3474.   </tr>

  3475.   <tr>

  3476.     <td valign="top">doclet</td>

  3477.     <td valign="top">Specifies the class file that starts the doclet used in generating the documentation.</td>

  3478.     <td align="center" valign="top">1.2</td>

  3479.     <td align="center" valign="top">No</td>

  3480.   </tr>

  3481.   <tr>

  3482.     <td valign="top">docletpath</td>

  3483.     <td valign="top">Specifies the path to the doclet class file that is specified with the -doclet option.</td>

  3484.     <td align="center" valign="top">1.2</td>

  3485.     <td align="center" valign="top">No</td>

  3486.   </tr>

  3487.   <tr>

  3488.     <td valign="top">docletpathref</td>

  3489.     <td valign="top">Specifies the path to the doclet class file that

  3490.       is specified with the -doclet option by <a

  3491.       href="#references">reference</a> to a PATH defined elsewhere.</td>

  3492.     <td align="center" valign="top">1.2</td>

  3493.     <td align="center" valign="top">No</td>

  3494.   </tr>

  3495.   <tr>

  3496.     <td valign="top">additionalparam</td>

  3497.     <td valign="top">Lets you add additional parameters to the javadoc command line. Useful for doclets</td>

  3498.     <td align="center" valign="top">1.2</td>

  3499.     <td align="center" valign="top">No</td>

  3500.   </tr>

  3501.   <tr>

  3502.     <td valign="top">failonerror</td>

  3503.     <td valign="top">Stop the buildprocess if the command exits with a

  3504.       returncode other than 0.</td>

  3505.     <td align="center" valign="top">all</td>

  3506.     <td align="center" valign="top">No</td>

  3507.   </tr>

  3508. </table>

  3509. 

  3510. <h3>Parameters specified as nested elements</h3>

  3511. <h4>link</h4>

  3512. <p>Create link to javadoc output at the given URL. This performs the

  3513. same role as the link and linkoffline attributes. You can use either

  3514. syntax (or both at once), but with the nested elements you can easily

  3515. specify multiple occurrences of the arguments.</p>

  3516. <h4>Parameters</h4>

  3517. 

  3518. <table width="60%" border="1" cellpadding="2" cellspacing="0">

  3519.   <tr>

  3520.     <td valign="top"><b>Attribute</b></td>

  3521.     <td valign="top"><b>Description</b></td>

  3522.     <td align="center" valign="top"><b>Required</b></td>

  3523.   </tr>

  3524.   <tr>

  3525.     <td valign="top">href</td>

  3526.     <td valign="top">The URL for the external documentation you wish to link to</td>

  3527.     <td align="center" valign="top">Yes</td>

  3528.   </tr>

  3529.   <tr>

  3530.     <td valign="top">offline</td>

  3531.     <td valign="top">True if this link is not available online at the time of 

  3532.                      generating the documentation</td>

  3533.     <td align="center" valign="top">No</td>

  3534.   </tr>

  3535.   <tr>

  3536.     <td valign="top">packagelistLoc</td>

  3537.     <td valign="top">The location to the directory containing the package-list file for

  3538.                      the external documentation</td>

  3539.     <td align="center" valign="top">Only if the offline attribute is true</td>

  3540.   </tr>

  3541. </table>

  3542.   

  3543. <h4>groups</h4> 

  3544. <p>Separates packages on the overview page into whatever groups you

  3545. specify, one group per table. This performs the same role as the group

  3546. attribute. You can use either syntax (or both at once), but with the

  3547. nested elements you can easily specify multiple occurrences of the

  3548. arguments.</p>

  3549. 

  3550. <table width="60%" border="1" cellpadding="2" cellspacing="0">

  3551.   <tr>

  3552.     <td valign="top"><b>Attribute</b></td>

  3553.     <td valign="top"><b>Description</b></td>

  3554.     <td align="center" valign="top"><b>Required</b></td>

  3555.   </tr>

  3556.   <tr>

  3557.     <td valign="top">title</td>

  3558.     <td valign="top">Title of the group</td>

  3559.     <td align="center" valign="top">Yes</td>

  3560.   </tr>

  3561.   <tr>

  3562.     <td valign="top">packages</td>

  3563.     <td valign="top">List of packages to include in that group</td>

  3564.     <td align="center" valign="top">Yes</td>

  3565.   </tr>

  3566. </table>

  3567. 

  3568. <h4>doclet</h4>

  3569. <p>The doclet nested element is used to specify the doclet that javadoc will 

  3570. use to process the input source files. A number of the standard javadoc arguments

  3571. are actually arguments of the standard doclet. If these are specified in the javadoc

  3572. task's attributes, they will be passed to the doclet specified in the 

  3573. <code>&lt;doclet&gt;</code> nested element. Such attributes should only be specified, 

  3574. therefore, if they can be interpreted by the doclet in use.

  3575. 

  3576. <p>If the doclet requires additional parameters, these can be specified with

  3577. <code>&lt;param&gt;</code> elements within the <code>&lt;doclet&gt;</code> 

  3578. element. These paramaters are restricted to simple strings. An example usage

  3579. of the doclet element is shown below:

  3580. 

  3581. <pre>  &lt;javadoc ...&gt;

  3582.      &lt;doclet name="theDoclet"

  3583.              path="path/to/theDoclet"&gt;

  3584.         &lt;param name="-foo" value="foovalue"/&gt;

  3585.         &lt;param name="-bar" value="barvalue"/&gt;

  3586.      &lt;/doclet&gt;

  3587.   &lt;/javadoc&gt;

  3588. </pre>

  3589. 

  3590. <h4>sourcepath, classpath and bootclasspath</h4>

  3591. <p><code>Javadoc</code>'s <em>sourcepath</em>, <em>classpath</em> and

  3592. <em>bootclasspath</em> attributes are <a href="#path">PATH like

  3593. structure</a> and can also be set via nested <em>sourcepath</em>,

  3594. <em>classpath</em> and <em>bootclasspath</em> elements

  3595. respectively.</p>

  3596. 

  3597. <h3>Example</h3>

  3598. <pre>  &lt;javadoc packagenames=&quot;com.dummy.test.*&quot;

  3599.            sourcepath=&quot;src&quot;

  3600.            destdir=&quot;docs/api&quot;

  3601.            author=&quot;true&quot;

  3602.            version=&quot;true&quot;

  3603.            use=&quot;true&quot;

  3604.            windowtitle=&quot;Test API&quot;

  3605.            doctitle=&quot;&lt;h1&gt;Test&lt;/h1&gt;&quot;

  3606.            bottom=&quot;&lt;i&gt;Copyright &amp;#169; 2000 Dummy Corp. All Rights Reserved.&lt;/i&gt;&quot;&gt;

  3607.     &lt;group title=&quot;Group 1 Packages&quot; packages=&quot;com.dummy.test.a*&quot;/&gt;

  3608.     &lt;group title=&quot;Group 2 Packages&quot; packages=&quot;com.dummy.test.b*&quot;/&gt;

  3609.     &lt;link offline=&quot;true&quot; href=&quot;http://java.sun.com/products/jdk/1.2/docs/api/&quot; packagelistLoc=&quot;C:\tmp&quot;/&gt;

  3610.     &lt;link href=&quot;http://developer.java.sun.com/developer/products/xml/docs/api/&quot;/&gt;

  3611.   &lt/javadoc&gt;</pre>

  3612.   

  3613. <hr>

  3614. <h2><a name="mail">Mail</a></h2>

  3615. <h3>Description</h3>

  3616. <p>A task to send SMTP email.</p>

  3617. <h3>Parameters</h3>

  3618. <table border="1" cellpadding="2" cellspacing="0">

  3619.   <tr>

  3620.     <td valign="top"><b>Attribute</b></td>

  3621.     <td valign="top"><b>Description</b></td>

  3622.     <td align="center" valign="top"><b>Required</b></td>

  3623.   </tr>

  3624.   <tr>

  3625.     <td valign="top">from</td>

  3626.     <td valign="top">Email address of sender.</td>

  3627.     <td align="center" valign="top">Yes</td>

  3628.   </tr>

  3629.   <tr>

  3630.     <td valign="top">tolist</td>

  3631.     <td valign="top">Comma-separated list of recipients.</td>

  3632.     <td align="center" valign="top">Yes</td>

  3633.   </tr>

  3634.   <tr>

  3635.     <td valign="top">message</td>

  3636.     <td valign="top">Message to send in the body of the email.</td>

  3637.     <td align="center" valign="middle" rowspan="2">Yes</td>

  3638.   </tr>

  3639.   <tr>

  3640.     <td valign="top">files</td>

  3641.     <td valign="top">Filename(s) of text to send in the body of the email. 

  3642. 	Multiple files are comma-separated.</td>

  3643.   </tr>

  3644.   <tr>

  3645.     <td valign="top">mailhost</td>

  3646.     <td valign="top">Host name of the mail server.</td>

  3647.     <td align="center" valign="top">No, default to &quot;localhost&quot;</td>

  3648.   </tr>

  3649.   <tr>

  3650.     <td valign="top">subject</td>

  3651.     <td valign="top">Email subject line.</td>

  3652.     <td align="center" valign="top">No</td>

  3653.   </tr>

  3654. </table>

  3655. <h3>Examples</h3>

  3656. <pre>

  3657.   &lt;mail from=&quot;me&quot; tolist=&quot;you&quot; subject=&quot;Results of nightly build&quot;

  3658.         files=&quot;build.log&quot;/&gt;</pre>

  3659. <p>Sends an eMail from <i>me</i> to <i>you</i> with a subject of 

  3660. <i>Results of nightly build</i> and includes the contents of <i>build.log</i>

  3661. in the body of the message.</p>

  3662. <hr>

  3663. 

  3664. <h2><a name="mkdir">Mkdir</a></h2>

  3665. <h3>Description</h3>

  3666. <p>Creates a directory. Also non-existent parent directories are created, when

  3667. necessary.</p>

  3668. <h3>Parameters</h3>

  3669. <table border="1" cellpadding="2" cellspacing="0">

  3670.   <tr>

  3671.     <td valign="top"><b>Attribute</b></td>

  3672.     <td valign="top"><b>Description</b></td>

  3673.     <td align="center" valign="top"><b>Required</b></td>

  3674.   </tr>

  3675.   <tr>

  3676.     <td valign="top">dir</td>

  3677.     <td valign="top">the directory to create.</td>

  3678.     <td align="center" valign="top">Yes</td>

  3679.   </tr>

  3680. </table>

  3681. <h3>Examples</h3>

  3682. <pre>&lt;mkdir dir=&quot;${dist}&quot; /&gt;</pre>

  3683. <p>creates a directory <code>${dist}</code>.</p>

  3684. <pre>&lt;mkdir dir=&quot;${dist}/lib&quot; /&gt;</pre>

  3685. <p>creates a directory <code>${dist}/lib</code>.</p>

  3686. <hr>

  3687. <h2><a name="move">Move</a></h2>

  3688. <h3>Description</h3>

  3689. <p>Moves a file to a new file or directory, or sets of files to

  3690. a new directory.  By default, the

  3691. destination file is overwritten if it already exists.  When <var>overwrite</var> is

  3692. turned off, then files are only moved if the source file is newer than

  3693. the destination file, or when the destination file does not exist.</p>

  3694. <p><a href="#fileset">FileSet</a>s are used to select sets of files

  3695. to move to the <var>todir</var> directory.</p>

  3696. <h3>Parameters</h3>

  3697. <table border="1" cellpadding="2" cellspacing="0">

  3698.   <tr>

  3699.     <td valign="top"><b>Attribute</b></td>

  3700.     <td valign="top"><b>Description</b></td>

  3701.     <td align="center" valign="top"><b>Required</b></td>

  3702.   </tr>

  3703.   <tr>

  3704.     <td valign="top">file</td>

  3705.     <td valign="top">the file to move</td>

  3706.     <td valign="top" align="center">One of <var>file</var> or 

  3707.      at least one nested fileset element</td>

  3708.   </tr>

  3709.   <tr>

  3710.     <td valign="top">tofile</td>

  3711.     <td valign="top">the file to move to</td>

  3712.     <td valign="top" align="center" rowspan="2">With the <var>file</var> attribute, 

  3713.     either <var>tofile</var> or <var>todir</var> can be used.  With a nested fileset, 

  3714. 	 only <var>todir</var> is allowed.</td>

  3715.   </tr>

  3716.   <tr>

  3717.     <td valign="top">todir</td>

  3718.     <td valign="top">the directory to move to</td>

  3719.   </tr>

  3720.   <tr>

  3721.     <td valign="top">overwrite</td>

  3722.     <td valign="top">overwrite existing files even if the destination

  3723.       files are newer (default is &quot;true&quot;)</td>

  3724.     <td valign="top" align="center">No</td>

  3725.   </tr>

  3726.   <tr>

  3727.     <td valign="top">filtering</td>

  3728.     <td valign="top">indicates whether token filtering should take place during

  3729.       the move.  See the <a href="#filter">filter</a> task for a description of

  3730.       how filters work.</td>

  3731.     <td valign="top" align="center">No</td>

  3732.   </tr>

  3733.   <tr>

  3734.     <td valign="top">flatten</td>

  3735.     <td valign="top">ignore directory structure of source directory,

  3736.       copy all files into a single directory, specified by the <var>todir</var>

  3737.       attribute (default is &quot;false&quot;).Note that you can achieve the 

  3738.       same effect by using a <a href="#flatten-mapper">flatten mapper</a></td>

  3739.     <td valign="top" align="center">No</td>

  3740.   </tr>

  3741.   <tr>

  3742.     <td valign="top">includeEmptyDirs</td>

  3743. 	 <td valign="top">Copy empty directories included with the nested FileSet(s).

  3744. 	   Defaults to &quot;yes&quot;.</td>

  3745. 	 <td valign="top" align="center">No</td>

  3746.   </tr>

  3747. </table>

  3748. <h3>Parameters specified as nested elements</h3>

  3749. <h4>mapper</h4>

  3750. <p>You can define file name transformations by using a nested <a

  3751. href="#mapper">mapper</a> element. The default mapper used by

  3752. <code>&lt;copy&gt;</code> is the <a

  3753. href="#identity-mapper">identity</a>.</p>

  3754. <h3>Examples</h3>

  3755. <p><b>Move a single file (rename a file)</b></p>

  3756. <pre>

  3757.   &lt;move file=&quot;file.orig&quot; tofile=&quot;file.moved&quot; /&gt;

  3758. </pre>

  3759. <p><b>Move a single file to a directory</b></p>

  3760. <pre>

  3761.   &lt;move file=&quot;file.orig&quot; todir=&quot;dir/to/move/to&quot; /&gt;

  3762. </pre>

  3763. <p><b>Move a directory to a new directory</b></p>

  3764. <pre>

  3765.   &lt;move todir=&quot;new/dir/to/move/to&quot;&gt;

  3766.     &lt;fileset dir=&quot;src/dir&quot;/&gt;

  3767.   &lt;/move&gt;

  3768. </pre>

  3769. <p><b>Move a set of files to a new directory</b></p>

  3770. <pre>

  3771.   &lt;move todir=&quot;some/new/dir&quot; &gt;

  3772.     &lt;fileset dir=&quot;my/src/dir&quot; &gt;

  3773.       &lt;include name=&quot;**/*.jar&quot; /&gt;

  3774.       &lt;exclude name=&quot;**/ant.jar&quot; /&gt;

  3775.     &lt;/fileset&gt;

  3776.   &lt;/move&gt;

  3777. </pre>

  3778. <p><b>Append <code>&quot;.bak&quot;</code> to the names of all files

  3779. in a directory.</b></p>

  3780. <pre>

  3781.   &lt;move todir=&quot;my/src/dir&quot; &gt;

  3782.     &lt;fileset dir=&quot;my/src/dir&quot; &gt;

  3783.       &lt;exclude name=&quot;**/*.bak&quot; /&gt;

  3784.     &lt;/fileset&gt;

  3785.     &lt;mapper type=&quot;glob&quot; from=&quot;*&quot; to=&quot;*.bak&quot; /&gt;

  3786.   &lt;/move&gt;

  3787. </pre>

  3788. <hr>

  3789. <h2><a name="patch">Patch</a></h2>

  3790. <h3>Description</h3>

  3791. <p>Applies a diff file to originals.</p>

  3792. <h3>Parameters</h3>

  3793. <table border="1" cellpadding="2" cellspacing="0">

  3794.   <tr>

  3795.     <td valign="top"><b>Attribute</b></td>

  3796.     <td valign="top"><b>Description</b></td>

  3797.     <td align="center" valign="top"><b>Required</b></td>

  3798.   </tr>

  3799.   <tr>

  3800.     <td valign="top">patchfile</td> 

  3801.     <td valign="top">the file that includes the diff output</td>

  3802.     <td align="center" valign="top">Yes</td>

  3803.   </tr>

  3804.   <tr>

  3805.     <td valign="top">originalfile</td> 

  3806.     <td valign="top">the file to patch</td>

  3807.     <td align="center" valign="top">No, tries to guess it from the diff 

  3808.       file</td>

  3809.   </tr>

  3810.   <tr>

  3811.     <td valign="top">backups</td> 

  3812.     <td valign="top">Keep backups of the unpatched files</td>

  3813.     <td align="center" valign="top">No</td>

  3814.   </tr>

  3815.   <tr>

  3816.     <td valign="top">quiet</td> 

  3817.     <td valign="top">Work silently unless an error occurs</td>

  3818.     <td align="center" valign="top">No</td>

  3819.   </tr>

  3820.   <tr>

  3821.     <td valign="top">reverse</td> 

  3822.     <td valign="top">Assume patch was created with old and new files 

  3823.       swapped.</td>

  3824.     <td align="center" valign="top">No</td>

  3825.   </tr>

  3826.   <tr>

  3827.     <td valign="top">ignorewhitespace</td> 

  3828.     <td valign="top">Ignore whitespace differences.</td>

  3829.     <td align="center" valign="top">No</td>

  3830.   </tr>

  3831.   <tr>

  3832.     <td valign="top">strip</td> 

  3833.     <td valign="top">Strip the smallest prefix containing <i>num</i> leading 

  3834.       slashes from filenames.</td>

  3835.     <td align="center" valign="top">No</td>

  3836.   </tr>

  3837. </table>

  3838. <h3>Examples</h3>

  3839. <pre>  &lt;patch patchfile=&quot;module.1.0-1.1.patch&quot; /&gt;</pre>

  3840. <p>applies the diff included in <i>module.1.0-1.1.patch</i> to the

  3841. files in base directory guessing the filename(s) from the diff output.

  3842. <pre>  &lt;patch patchfile=&quot;module.1.0-1.1.patch&quot; strip=&quot;1&quot; /&gt;</pre>

  3843. <p>like above but one leading directory part will be removed. i.e. if

  3844. the diff output looked like

  3845. <pre>

  3846. --- a/mod1.0/A	Mon Jun  5 17:28:41 2000

  3847. +++ a/mod1.1/A	Mon Jun  5 17:28:49 2000

  3848. </pre> 

  3849. the leading <i>a/</i> will be stripped.

  3850. <hr>

  3851. <h2><a name="property">Property</a></h2>

  3852. <h3>Description</h3>

  3853. <p>Sets a property (by name and value), or set of properties (from file or

  3854. resource) in the project.</p>

  3855. <p>When a property was set by the user, or was a property in a parent project

  3856. (that started this project with the <a href="#ant">ant task</a>), then this

  3857. property cannot be set, and will be ignored. This means that properties set

  3858. outside the current project always override the properties of the current

  3859. project.</p>

  3860. <p>There are five ways to set properties:</p>

  3861. <ul>

  3862.   <li>By supplying both the <i>name</i> and <i>value</i> attribute.</li>

  3863.   <li>By supplying both the <i>name</i> and <i>refid</i> attribute.</li>

  3864.   <li>By setting the <i>file</i> attribute with the filename of the property

  3865.     file to load. This property file has the format as defined by the file used

  3866.     in the class java.util.Properties.</li>

  3867.   <li>By setting the <i>resource</i> attribute with the resource name of the

  3868.     property file to load. This property file has the format as defined by the

  3869.     file used in the class java.util.Properties.</li>

  3870.   <li>By setting the <i>environment</i> attribute with a prefix to use.

  3871.     Properties will be defined for every environment variable by

  3872.     prefixing the suplied name and a period to the name of the variable.</li>

  3873. </ul>

  3874. <p>Although combinations of the three ways are possible, only one should be used

  3875. at a time. Problems might occur with the order in which properties are set, for

  3876. instance.</p>

  3877. <p>The value part of the properties being set, might contain references to other

  3878. properties. These references are resolved at the time these properties are set.

  3879. This also holds for properties loaded from a property file.</p>

  3880. <h3>Parameters</h3>

  3881. <table border="1" cellpadding="2" cellspacing="0">

  3882.   <tr>

  3883.     <td valign="top"><b>Attribute</b></td>

  3884.     <td valign="top"><b>Description</b></td>

  3885.     <td align="center" valign="top"><b>Required</b></td>

  3886.   </tr>

  3887.   <tr>

  3888.     <td valign="top">name</td>

  3889.     <td valign="top">the name of the property to set.</td>

  3890.     <td valign="top" align="center">Yes</td>

  3891.   </tr>

  3892.   <tr>

  3893.     <td valign="top">value</td>

  3894.     <td valign="top">the value of the property.</td>

  3895.     <td valign="middle" align="center" rowspan="5">Yes</td>

  3896.   </tr>

  3897.   <tr>

  3898.     <td valign="top">refid</td>

  3899.     <td valign="top"><a href="#references">Reference</a> to an object

  3900.       defined elsewhere. Only yields reasonable results for references

  3901.       to <a href="#path">PATH like structures</a> or properties.</td>

  3902.   </tr>

  3903.   <tr>

  3904.     <td valign="top">resource</td>

  3905.     <td valign="top">the resource name of the property file.</td>

  3906.   </tr>

  3907.   <tr>

  3908.     <td valign="top">file</td>

  3909.     <td valign="top">the filename of the property file .</td>

  3910.   </tr>

  3911.   <tr>

  3912.     <td valign="top">location</td>

  3913.     <td valign="top">Sets the property to the absolute filename of the

  3914.       given file. If the value of this attribute is an absolute path, it

  3915.       is left unchanged (with / and \ characters converted to the

  3916.       current platforms conventions). Otherwise it is taken as a path

  3917.       relative to the project's basedir and expanded.</td>

  3918.   </tr>

  3919. </table>

  3920. <h3>Examples</h3>

  3921. <pre>  &lt;property name=&quot;foo.dist&quot; value=&quot;dist&quot; /&gt;</pre>

  3922. <p>sets the property <code>foo.dist</code> to the value &quot;dist&quot;.</p>

  3923. <pre>  &lt;property file=&quot;foo.properties&quot; /&gt;</pre>

  3924. <p>reads a set of properties from a file called &quot;foo.properties&quot;.</p>

  3925. <pre>  &lt;property resource=&quot;foo.properties&quot; /&gt;</pre>

  3926. <p>reads a set of properties from a resource called &quot;foo.properties&quot;.</p>

  3927. <p>Note that you can reference a global properties file for all of your Ant

  3928. builds using the following:

  3929. <pre>  &lt;property file=&quot;${user.home}/.ant-global.properties&quot; /&gt;</pre>

  3930. <p>since the &quot;user.home&quot; property is defined by the Java virtual machine

  3931. to be your home directory.  This technique is more appropriate for Unix than 

  3932. Windows since the notion of a home directory doesn't exist on Windows.  On the

  3933. JVM that I tested, the home directory on Windows is &quot;C:\&quot;.  Different JVM

  3934. implementations may use other values for the home directory on Windows.</p>

  3935. <hr>

  3936. <h2><a name="rename">Rename</a></h2>

  3937. <h3><i>Deprecated</i></h3>

  3938. <p><i>This task has been deprecated.  Use the Move task instead.</i></p>

  3939. <h3>Description</h3>

  3940. <p>Renames a given file.</p>

  3941. <h3>Parameters</h3>

  3942. <table border="1" cellpadding="2" cellspacing="0">

  3943.   <tr>

  3944.     <td valign="top"><b>Attribute</b></td>

  3945.     <td valign="top"><b>Description</b></td>

  3946.     <td align="center" valign="top"><b>Required</b></td>

  3947.   </tr>

  3948.   <tr>

  3949.     <td valign="top">src</td>

  3950.     <td valign="top">file to rename.</td>

  3951.     <td valign="top" align="center">Yes</td>

  3952.   </tr>

  3953.   <tr>

  3954.     <td valign="top">dest</td>

  3955.     <td valign="top">new name of the file.</td>

  3956.     <td valign="top" align="center">Yes</td>

  3957.   </tr>

  3958.   <tr>

  3959.     <td valign="top">replace</td>

  3960.     <td valign="top">Enable replacing of existing file (default: on).</td>

  3961.     <td valign="top" align="center">No</td>

  3962.   </tr>

  3963. </table>

  3964. <h3>Examples</h3>

  3965. <pre>  &lt;rename src=&quot;foo.jar&quot; dest=&quot;${name}-${version}.jar&quot; /&gt;</pre> 

  3966. <p>Renames the file <code>foo.jar</code> to <code>${name}-${version}.jar</code> (assuming <code>name</code>

  3967.  and <code>version</code> being predefined properties). If a file named <code>${name}-${version}.jar</code>

  3968.  already exists, it will be removed prior to renaming <code>foo.jar</code>.</p>

  3969. <hr>

  3970. <h2><a name="replace">Replace</a></h2>

  3971. <h3>Description</h3>

  3972. <p>Replace is a directory based task for replacing the occurrence of a given string with another string 

  3973. in selected file.</p>

  3974. <p>If you want to replace a text that crosses line boundaries, you

  3975. must use a nested <code>&lt;replacetoken&gt;</code> element.</p>

  3976. <h3>Parameters</h3>

  3977. <table border="1" cellpadding="2" cellspacing="0">

  3978.   <tr>

  3979.     <td valign="top"><b>Attribute</b></td>

  3980.     <td valign="top"><b>Description</b></td>

  3981.     <td align="center" valign="top"><b>Required</b></td>

  3982.   </tr>

  3983.   <tr>

  3984.     <td valign="top">file</td>

  3985.     <td valign="top">file for which the token should be replaced.</td>

  3986.     <td align="center" rowspan="2">Exactly one of the two.</td>

  3987.   </tr>

  3988.   <tr>

  3989.     <td valign="top">dir</td>

  3990.     <td valign="top">The base directory to use when replacing a token in 

  3991.       multiple files.</td>

  3992.   </tr>

  3993.   <tr>

  3994.     <td valign="top">token</td>

  3995.     <td valign="top">the token which must be replaced.</td>

  3996.     <td valign="top" align="center">Yes, unless a nested <code>replacetoken</code>

  3997.       element is used.</td>

  3998.   </tr>

  3999.   <tr>

  4000.     <td valign="top">value</td>

  4001.     <td valign="top">the new value for the token. When omitted, an empty string

  4002.       (&quot;&quot;) is used.</td>

  4003.     <td valign="top" align="center">No</td>

  4004.   </tr>

  4005.   <tr>

  4006.     <td valign="top">includes</td>

  4007.     <td valign="top">comma separated list of patterns of files that must be

  4008.       included. All files are included when omitted.</td>

  4009.     <td valign="top" align="center">No</td>

  4010.   </tr>

  4011.   <tr>

  4012.     <td valign="top">includesfile</td>

  4013.     <td valign="top">the name of a file. Each line of this file is

  4014.       taken to be an include pattern</td>

  4015.     <td valign="top" align="center">No</td>

  4016.   </tr>

  4017.   <tr>

  4018.     <td valign="top">excludes</td>

  4019.     <td valign="top">comma separated list of patterns of files that must be

  4020.       excluded. No files (except default excludes) are excluded when omitted.</td>

  4021.     <td valign="top" align="center">No</td>

  4022.   </tr>

  4023.   <tr>

  4024.     <td valign="top">excludesfile</td>

  4025.     <td valign="top">the name of a file. Each line of this file is

  4026.       taken to be an exclude pattern</td>

  4027.     <td valign="top" align="center">No</td>

  4028.   </tr>

  4029.   <tr>

  4030.     <td valign="top">defaultexcludes</td>

  4031.     <td valign="top">indicates whether default excludes should be used or not

  4032.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  4033.     <td valign="top" align="center">No</td>

  4034.   </tr>

  4035. </table>

  4036. <h3>Examples</h3>

  4037. <pre>  &lt;replace file=&quot;${src}/index.html&quot; token=&quot;@@@&quot; value=&quot;wombat&quot; /&gt;</pre>

  4038. <p>replaces occurrences of the string &quot;@@@&quot; with the string

  4039. &quot;wombat&quot;, in the file <code>${src}/index.html</code>.</p>

  4040. <h3>Parameters specified as nested elements</h3>

  4041. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  4042. supports all attributes of <code>&lt;fileset&gt;</code> as well as the

  4043. nested <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  4044. <code>&lt;patternset&gt;</code> elements.</p>

  4045. <p>If either the text you want to replace or the replacement text

  4046. cross line boundaries, you can use nested elements to specify

  4047. them.</p>

  4048. <h3>Examples</h3>

  4049. <blockquote><pre>  

  4050. &lt;replace dir=&quot;${src}&quot; value=&quot;wombat&quot;&gt;

  4051.   &lt;include name=&quot;**/*.html&quot; /&gt;

  4052.   &lt;replacetoken&gt;&lt;![CDATA[multi line

  4053. token]]>&lt;/replacetoken&gt;

  4054. &lt;/replace&gt;

  4055. </pre></blockquote>

  4056. <p>replaces occurrences of the string &quot;multi

  4057. line<em>\n</em>token&quot; with the string &quot;wombat&quot;, in all

  4058. HTML files in the directory <code>${src}</code>.Where <em>\n</em> is

  4059. the platform specific line separator.</p>

  4060. <blockquote><pre>  

  4061. &lt;replace file=&quot;${src}/index.html&quot;&gt;

  4062.   &lt;replacetoken&gt;&lt;![CDATA[two line

  4063. token]]>&lt;/replacetoken&gt;

  4064.   &lt;replacevalue&gt;&lt;![CDATA[two line

  4065. token]]>&lt;/replacevalue&gt;

  4066. &lt;/replace&gt;

  4067. </pre></blockquote>

  4068. <hr>

  4069. <h2><a name="rmic">Rmic</a></h2>

  4070. <h3>Description</h3>

  4071. <p>Runs the rmic compiler for a certain class.</p>

  4072. <p>Rmic can be run on a single class (as specified with the classname

  4073. attribute) or a number of classes at once (all classes below base that

  4074. are neither _Stub nor _Skel classes).</p>

  4075. <p>It is possible to refine the set of files that are being rmiced. This can be

  4076. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>

  4077. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to

  4078. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify

  4079. the files you want to have excluded. This is also done with patterns. And

  4080. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  4081. want to use default exclusions or not. See the section on <a

  4082. href="#directorybasedtasks">directory based tasks</a>, on how the

  4083. inclusion/exclusion of files works, and how to write patterns.</p>

  4084. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  4085. supports all attributes of <code>&lt;fileset&gt;</code>

  4086. (<code>dir</code> becomes <code>base</code>) as well as the nested

  4087. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  4088. <code>&lt;patternset&gt;</code> elements.</p>

  4089. <h3>Parameters</h3>

  4090. <table border="1" cellpadding="2" cellspacing="0">

  4091.   <tr>

  4092.     <td valign="top"><b>Attribute</b></td>

  4093.     <td valign="top"><b>Description</b></td>

  4094.     <td align="center" valign="top"><b>Required</b></td>

  4095.   </tr>

  4096.   <tr>

  4097.     <td valign="top">base</td>

  4098.     <td valign="top">the location to store the compiled files.</td>

  4099.     <td valign="top" align="center">Yes</td>

  4100.   </tr>

  4101.   <tr>

  4102.     <td valign="top">classname</td>

  4103.     <td valign="top">the class for which to run <code>rmic</code>.</td>

  4104.     <td valign="top" align="center">No</td>

  4105.   </tr>

  4106.   <tr>

  4107.     <td valign="top">filtering</td>

  4108.     <td valign="top">indicates whether token filtering should take place</td>

  4109.     <td valign="top" align="center">No</td>

  4110.   </tr>

  4111.   <tr>

  4112.     <td valign="top">sourcebase</td>

  4113.     <td valign="top">Pass the &quot;-keepgenerated&quot; flag to rmic and

  4114.  move the generated source file to the base directory.</td>

  4115.     <td align="center" valign="top">No</td>

  4116.   </tr>

  4117.   <tr>

  4118.     <td valign="top">stubversion</td>

  4119.     <td valign="top">Specify the JDK version for the generated stub code.

  4120.  Specify &quot;1.1&quot; to pass the &quot;-v1.1&quot; option to rmic.</td>

  4121.     <td align="center" valign="top">No</td>

  4122.   </tr>

  4123.   <tr>

  4124.     <td valign="top">classpath</td>

  4125.     <td valign="top">The classpath to use during compilation</td>

  4126.     <td align="center" valign="top">No</td>

  4127.   </tr>

  4128.   <tr>

  4129.     <td valign="top">classpathref</td>

  4130.     <td valign="top">The classpath to use during compilation, given as <a

  4131.       href="#references">reference</a> to a PATH defined elsewhere</td>

  4132.     <td align="center" valign="top">No</td>

  4133.   </tr>

  4134.   <tr>

  4135.     <td valign="top">includes</td>

  4136.     <td valign="top">comma separated list of patterns of files that must be

  4137.       included. All files are included when omitted.</td>

  4138.     <td valign="top" align="center">No</td>

  4139.   </tr>

  4140.   <tr>

  4141.     <td valign="top">includesfile</td>

  4142.     <td valign="top">the name of a file. Each line of this file is

  4143.       taken to be an include pattern</td>

  4144.     <td valign="top" align="center">No</td>

  4145.   </tr>

  4146.   <tr>

  4147.     <td valign="top">excludes</td>

  4148.     <td valign="top">comma separated list of patterns of files that must be

  4149.       excluded. No files (except default excludes) are excluded when omitted.</td>

  4150.     <td valign="top" align="center">No</td>

  4151.   </tr>

  4152.   <tr>

  4153.     <td valign="top">excludesfile</td>

  4154.     <td valign="top">the name of a file. Each line of this file is

  4155.       taken to be an exclude pattern</td>

  4156.     <td valign="top" align="center">No</td>

  4157.   </tr>

  4158.   <tr>

  4159.     <td valign="top">defaultexcludes</td>

  4160.     <td valign="top">indicates whether default excludes should be used or not

  4161.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  4162.     <td valign="top" align="center">No</td>

  4163.   </tr>

  4164.   <tr>

  4165.     <td valign="top">verify</td>

  4166.     <td valign="top">check that classes implement Remote before handing them 

  4167.         to rmic (default is false)</td>

  4168.     <td align="center" valign="top">No</td>

  4169.   </tr>

  4170.   <tr>

  4171.     <td valign="top">iiop</td>

  4172.     <td valign="top">indates that portable (RMI/IIOP) stubs should be generated</td>

  4173.     <td align="center" valign="top">No</td>

  4174.   </tr>

  4175.   <tr>

  4176.     <td valign="top">iiopopts</td>

  4177.     <td valign="top">additional arguments for IIOP class generation</td>

  4178.     <td align="center" valign="top">No</td>

  4179.   </tr>

  4180.   <tr>

  4181.     <td valign="top">idl</td>

  4182.     <td valign="top">indates that IDL output files should be generated</td>

  4183.     <td align="center" valign="top">No</td>

  4184.   </tr>

  4185.   <tr>

  4186.     <td valign="top">idlopts</td>

  4187.     <td valign="top">additional arguments for IDL file generation</td>

  4188.     <td align="center" valign="top">No</td>

  4189.   </tr>

  4190. </table>

  4191. <h3>Parameters specified as nested elements</h3>

  4192. <h4>classpath</h4>

  4193. <p><code>Rmic</code>'s <em>classpath</em> attribute is a <a

  4194. href="#path">PATH like structure</a> and can also be set via a nested

  4195. <em>classpath</em> elements.</p>

  4196. <h3>Examples</h3>

  4197. <pre>  &lt;rmic classname=&quot;com.xyz.FooBar&quot; base=&quot;${build}/classes&quot; /&gt;</pre>

  4198. <p>runs the rmic compiler for the class <code>com.xyz.FooBar</code>. The

  4199. compiled files will be stored in the directory <code>${build}/classes</code>.</p>

  4200. <pre>  &lt;rmic base=&quot;${build}/classes&quot; includes=&quot;**/Remote*.class&quot; /&gt;</pre>

  4201. <p>runs the rmic compiler for all classes with <code>.class</code>

  4202. files below <code>${build}/classes</code> whose classname starts with

  4203. <i>Remote</i>. The compiled files will be stored in the directory

  4204. <code>${build}/classes</code>.</p>

  4205. 

  4206. <hr>

  4207. <h2><a name="signjar">SignJar</a></h2>

  4208. <h3>Description</h3>

  4209. <p>Signs a jar or zip file with the javasign command line tool.</p>

  4210. 

  4211. <h3>Parameters</h3>

  4212. <table border="1" cellpadding="2" cellspacing="0">

  4213.   <tr>

  4214.     <td valign="top"><b>Attribute</b></td>

  4215.     <td valign="top"><b>Description</b></td>

  4216.     <td align="center" valign="top"><b>Required</b></td>

  4217.   </tr>

  4218.   <tr>

  4219.     <td valign="top">jar</td>

  4220.     <td valign="top">the jar file to sign</td>

  4221.     <td valign="top" align="center">Yes.</td>

  4222.   </tr>

  4223.   <tr>

  4224.     <td valign="top">alias</td>

  4225.     <td valign="top">the alias to sign under</td>

  4226.     <td valign="top" align="center">Yes.</td>

  4227.   </tr>

  4228.   <tr>

  4229.     <td valign="top">storepass</td>

  4230.     <td valign="top">password for keystore integrity.</td>

  4231.     <td valign="top" align="center">Yes.</td>

  4232.   </tr>

  4233.   <tr>

  4234.     <td valign="top">keystore</td>

  4235.     <td valign="top">keystore location</td>

  4236.     <td valign="top" align="center">No</td>

  4237.   </tr>

  4238.   <tr>

  4239.     <td valign="top">storetype</td>

  4240.     <td valign="top">keystore type</td>

  4241.     <td valign="top" align="center">No</td>

  4242.   </tr>

  4243.   <tr>

  4244.     <td valign="top">keypass</td>

  4245.     <td valign="top">password for private key (if different)</td>

  4246.     <td valign="top" align="center">No</td>

  4247.   </tr>

  4248.   <tr>

  4249.     <td valign="top">sigfile</td>

  4250.     <td valign="top">name of .SF/.DSA file</td>

  4251.     <td valign="top" align="center">No</td>

  4252.   </tr>

  4253.   <tr>

  4254.     <td valign="top">signedjar</td>

  4255.     <td valign="top">name of signed JAR file</td>

  4256.     <td valign="top" align="center">No</td>

  4257.   </tr>

  4258.   <tr>

  4259.     <td valign="top">verbose</td>

  4260.     <td valign="top">(true | false) verbose output when signing</td>

  4261.     <td valign="top" align="center">No</td>

  4262.   </tr>

  4263.   <tr>

  4264.     <td valign="top">internalsf</td>

  4265.     <td valign="top">(true | false) include the .SF file inside the signature

  4266. block</td>

  4267.     <td valign="top" align="center">No</td>

  4268.   </tr>

  4269.   <tr>

  4270.     <td valign="top">sectionsonly</td>

  4271.     <td valign="top">(true | false) don't compute hash of entire manifest</td>

  4272.     <td valign="top" align="center">No</td>

  4273.   </tr>

  4274. </table>

  4275. <h3>Examples</h3>

  4276. <blockquote>

  4277.   <p><code>&lt;signjar jar=&quot;${dist}/lib/ant.jar&quot;

  4278. alias=&quot;apache-group&quot; storepass=&quot;secret&quot; /&gt;</code></p>

  4279. </blockquote>

  4280. <p>signs the ant.jar with alias &quot;apache-group&quot; accessing the

  4281. keystore and private key via &quot;secret&quot; password.</p>

  4282. <hr>

  4283. <h2><a name="style">Style</a></h2>

  4284. <h3>Description</h3>

  4285. <p>Process a set of documents via XSLT.</p>

  4286. <p>This is useful for building views of XML based documentation,

  4287. or in generating code.</p>

  4288. <p>It is possible to refine the set of files that are being copied. This can be

  4289. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>

  4290. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to

  4291. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify

  4292. the files you want to have excluded. This is also done with patterns. And

  4293. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  4294. want to use default exclusions or not. See the section on <a

  4295. href="#directorybasedtasks">directory based tasks</a>, on how the

  4296. inclusion/exclusion of files works, and how to write patterns.</p>

  4297. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  4298. supports all attributes of <code>&lt;fileset&gt;</code>

  4299. (<code>dir</code> becomes <code>basedir</code>) as well as the nested

  4300. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  4301. <code>&lt;patternset&gt;</code> elements.</p>

  4302. <h3>Parameters</h3>

  4303. <table border="1" cellpadding="2" cellspacing="0">

  4304.   <tr>

  4305.     <td valign="top"><b>Attribute</b></td>

  4306.     <td valign="top"><b>Description</b></td>

  4307.     <td align="center" valign="top"><b>Required</b></td>

  4308.   </tr>

  4309.   <tr>

  4310.     <td valign="top">basedir</td>

  4311.     <td valign="top">where to find the source xml file.</td>

  4312.     <td align="center" valign="top">Yes</td>

  4313.   </tr>

  4314.   <tr>

  4315.     <td valign="top">destdir</td>

  4316.     <td valign="top">directory where to store the results.</td>

  4317.     <td align="center" valign="top">Yes</td>

  4318.   </tr>

  4319.   <tr>

  4320.     <td valign="top">extension</td>

  4321.     <td valign="top">desired file extension to be used for the targets.

  4322.         If not specified, the default is &quot;html&quot;.</td>

  4323.     <td align="center" valign="top">No</td>

  4324.   </tr>

  4325.   <tr>

  4326.     <td valign="top">style</td>

  4327.     <td valign="top">name of the stylesheet to use.</td>

  4328.     <td align="center" valign="top">Yes</td>

  4329.   </tr>

  4330.   <tr>

  4331.     <td valign="top">processor</td>

  4332.     <td valign="top">name of the XSLT processor to use.  Permissible

  4333. values are &quot;xslp&quot; for the XSL:P processor, &quot;xalan&quot; 

  4334. for the Apache XML Xalan processor, or the name of an arbitrary XSLTLiaison class.

  4335. Defaults to xslp or xalan (in that order), if one is found in your

  4336. class path</td>

  4337.     <td align="center" valign="top">No</td>

  4338.   </tr>

  4339.   <tr>

  4340.     <td valign="top">includes</td>

  4341.     <td valign="top">comma separated list of patterns of files that must be

  4342.       included. All files are included when omitted.</td>

  4343.     <td valign="top" align="center">No</td>

  4344.   </tr>

  4345.   <tr>

  4346.     <td valign="top">includesfile</td>

  4347.     <td valign="top">the name of a file. Each line of this file is

  4348.       taken to be an include pattern</td>

  4349.     <td valign="top" align="center">No</td>

  4350.   </tr>

  4351.   <tr>

  4352.     <td valign="top">excludes</td>

  4353.     <td valign="top">comma separated list of patterns of files that must be

  4354.       excluded. No files (except default excludes) are excluded when omitted.</td>

  4355.     <td valign="top" align="center">No</td>

  4356.   </tr>

  4357.   <tr>

  4358.     <td valign="top">excludesfile</td>

  4359.     <td valign="top">the name of a file. Each line of this file is

  4360.       taken to be an exclude pattern</td>

  4361.     <td valign="top" align="center">No</td>

  4362.   </tr>

  4363.   <tr>

  4364.     <td valign="top">defaultexcludes</td>

  4365.     <td valign="top">indicates whether default excludes should be used or not

  4366.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  4367.     <td valign="top" align="center">No</td>

  4368.   </tr>

  4369. </table>

  4370. <h3>Examples</h3>

  4371. <blockquote>

  4372.   <p><pre>

  4373. &lt;style basedir=&quot;doc&quot; destdir=&quot;build/doc&quot;

  4374.        extension=&quot;html&quot; style=&quot;style/apache.xml&quot;/&gt;

  4375. </pre>

  4376. </blockquote>

  4377. <hr>

  4378. <h2><a name="tar">Tar</a></h2>

  4379. <h3>Description</h3>

  4380. <p>Creates a tar archive.</p>

  4381. <p>The <i>basedir</i> attribute is the reference directory from where to tar.</p>

  4382. <p>It is possible to refine the set of files that are being tarred. This can be

  4383. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>

  4384. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to

  4385. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify

  4386. the files you want to have excluded. This is also done with patterns. And

  4387. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  4388. want to use default exclusions or not. See the section on <a

  4389. href="#directorybasedtasks">directory based tasks</a>, on how the

  4390. inclusion/exclusion of files works, and how to write patterns.</p>

  4391. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  4392. supports all attributes of <code>&lt;fileset&gt;</code>

  4393. (<code>dir</code> becomes <code>basedir</code>) as well as the nested

  4394. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  4395. <code>&lt;patternset&gt;</code> elements.</p>

  4396. <p>Note that this task does not perform compression. You might want to use the <a href="#gzip">GZip</a>

  4397. task to come up with a .tar.gz package.</p>

  4398. <h3>Parameters</h3>

  4399. <table border="1" cellpadding="2" cellspacing="0">

  4400.   <tr>

  4401.     <td valign="top"><b>Attribute</b></td>

  4402.     <td valign="top"><b>Description</b></td>

  4403.     <td valign="top" align="center"><b>Required</b></td>

  4404.   </tr>

  4405.   <tr>

  4406.     <td valign="top">tarfile</td>

  4407.     <td valign="top">the tar-file to create.</td>

  4408.     <td align="center" valign="top">Yes</td>

  4409.   </tr>

  4410.   <tr>

  4411.     <td valign="top">basedir</td>

  4412.     <td valign="top">the directory from which to zip the files.</td>

  4413.     <td align="center" valign="top">Yes</td>

  4414.   </tr>

  4415.   <tr>

  4416.     <td valign="top">includes</td>

  4417.     <td valign="top">comma separated list of patterns of files that must be

  4418.       included. All files are included when omitted.</td>

  4419.     <td valign="top" align="center">No</td>

  4420.   </tr>

  4421.   <tr>

  4422.     <td valign="top">includesfile</td>

  4423.     <td valign="top">the name of a file. Each line of this file is

  4424.       taken to be an include pattern</td>

  4425.     <td valign="top" align="center">No</td>

  4426.   </tr>

  4427.   <tr>

  4428.     <td valign="top">excludes</td>

  4429.     <td valign="top">comma separated list of patterns of files that must be

  4430.       excluded. No files (except default excludes) are excluded when omitted.</td>

  4431.     <td valign="top" align="center">No</td>

  4432.   </tr>

  4433.   <tr>

  4434.     <td valign="top">excludesfile</td>

  4435.     <td valign="top">the name of a file. Each line of this file is

  4436.       taken to be an exclude pattern</td>

  4437.     <td valign="top" align="center">No</td>

  4438.   </tr>

  4439.   <tr>

  4440.     <td valign="top">defaultexcludes</td>

  4441.     <td valign="top">indicates whether default excludes should be used or not

  4442.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  4443.     <td valign="top" align="center">No</td>

  4444.   </tr>

  4445. </table>

  4446. <h3>Examples</h3>

  4447. <pre>  &lt;tar tarfile=&quot;${dist}/manual.tar&quot; basedir=&quot;htdocs/manual&quot; /&gt;

  4448.   &lt;gzip zipfile=&quot;${dist}/manual.tar.gz&quot; src=&quot;${dist}/manual.tar&quot; /&gt;</pre>

  4449. <p>tars all files in the <code>htdocs/manual</code> directory into a file called <code>manual.tar</code>

  4450. in the <code>${dist}</code>  directory, then applies the gzip task to compress

  4451. it.</p>

  4452. <pre>  &lt;tar tarfile=&quot;${dist}/manual.tar&quot;

  4453.        basedir=&quot;htdocs/manual&quot;

  4454.        excludes=&quot;mydocs/**, **/todo.html&quot;

  4455.   /&gt;</pre>

  4456. <p>tars all files in the <code>htdocs/manual</code> directory into a file called <code>manual.tar</code>

  4457. in the <code>${dist}</code> directory. Files in the directory <code>mydocs</code>,

  4458. or files with the name <code>todo.html</code> are excluded.</p>

  4459. <hr>

  4460. <h2><a name="taskdef">Taskdef</a></h2>

  4461. <h3>Description</h3>

  4462. <p>Adds a task definition to the current project, such that this new task can be

  4463. used in the current project. Two attributes are needed, the name that identifies

  4464. this task uniquely, and the full name of the class (including the packages) that

  4465. implements this task.</p>

  4466. <p>Taskdef should be used to add your own tasks to the system. See also &quot;<a

  4467. href="#writingowntask">Writing your own task</a>&quot;.</p>

  4468. <h3>Parameters</h3>

  4469. <table border="1" cellpadding="2" cellspacing="0">

  4470.   <tr>

  4471.     <td valign="top"><b>Attribute</b></td>

  4472.     <td valign="top"><b>Description</b></td>

  4473.     <td align="center" valign="top"><b>Required</b></td>

  4474.   </tr>

  4475.   <tr>

  4476.     <td valign="top">name</td>

  4477.     <td valign="top">the name of the task</td>

  4478.     <td valign="top" align="center">Yes</td>

  4479.   </tr>

  4480.   <tr>

  4481.     <td valign="top">classname</td>

  4482.     <td valign="top">the full class name implementing the task</td>

  4483.     <td valign="top" align="center">Yes</td>

  4484.   </tr>

  4485.   <tr>

  4486.     <td valign="top">classpath</td> <td valign="top">the classpath to

  4487.       use when looking up <code>classname</code>.</td> <td

  4488.     align="center" valign="top">No</td>

  4489.   </tr>

  4490. </table>

  4491. <h3>Parameters specified as nested elements</h3>

  4492. <h4>classpath</h4>

  4493. <p><code>Taskdef</code>'s <em>classpath</em> attribute is a <a

  4494. href="#path">PATH like structure</a> and can also be set via a nested

  4495. <em>classpath</em> element.</p>

  4496. <h3>Examples</h3>

  4497. <pre>  &lt;taskdef name=&quot;myjavadoc&quot; classname=&quot;com.mydomain.JavadocTask&quot; /&gt;</pre>

  4498. <p>makes a task called <code>myjavadoc</code> available to Ant. The class <code>com.mydomain.JavadocTask</code>

  4499. implements the task.</p>

  4500. <hr>

  4501. <h2><a name="touch">Touch</a></h2>

  4502. <h3>Description</h3>

  4503. <p>Changes the modification time of a file and possibly creates it at

  4504. the same time.</p>

  4505. <p>For JDK 1.1 only the creation of new files with a modification time

  4506. of now works, all other cases will emit a warning.</p>

  4507. <h3>Parameters</h3>

  4508. <table border="1" cellpadding="2" cellspacing="0">

  4509.   <tr>

  4510.     <td valign="top"><b>Attribute</b></td>

  4511.     <td valign="top"><b>Description</b></td>

  4512.     <td align="center" valign="top"><b>Required</b></td>

  4513.   </tr>

  4514.   <tr>

  4515.     <td valign="top">file</td>

  4516.     <td valign="top">the name of the file</td>

  4517.     <td valign="top" align="center">Yes</td>

  4518.   </tr>

  4519.   <tr>

  4520.     <td valign="top">millis</td>

  4521.     <td valign="top">specifies the new modification time of the file

  4522.        in milliseconds since midnight Jan 1 1970</td>

  4523.     <td valign="top" align="center">No</td>

  4524.   </tr>

  4525.   <tr>

  4526.     <td valign="top">datetime</td>

  4527.     <td valign="top">specifies the new modification time of the file

  4528.        in the format MM/DD/YYYY HH:MM AM_or_PM.</td>

  4529.     <td valign="top" align="center">No</td>

  4530.   </tr>

  4531. </table>

  4532. <p>If both <code>millis</code> and <code>datetime</code> are omitted

  4533. the current time is assumed.</p>

  4534. <h3>Examples</h3>

  4535. <pre>  &lt;touch file=&quot;myfile&quot; /&gt;</pre>

  4536. <p>creates <code>myfile</code> if it doesn't exist and changes the

  4537. modification time to the current time.</p>

  4538. <pre>  &lt;touch file=&quot;myfile&quot; datetime=&quot;06/28/2000 2:02 pm&quot; /&gt;</pre>

  4539. <p>creates <code>myfile</code> if it doesn't exist and changes the

  4540. modification time to Jun, 28 2000 2:02 pm (14:02 for those used to 24

  4541. hour times).</p>

  4542. <hr>

  4543. <h2><a name="transform">Transform</a></h2>

  4544. <h3>Description</h3>

  4545. <p>Executes a system command. When the <i>os</i> attribute is specified, then

  4546. the command is only executed when Ant is run on one of the specified operating

  4547. systems.</p>

  4548. <p>The files and/or directories of a number of <a

  4549. href="#fileset">FileSet</a>s are passed as arguments to the system

  4550. command. The timestamp of each source file is compared to the

  4551. timestamp of a target file which is defined by a nested <a

  4552. href="#mapper">mapper</a> element. At least one fileset and exactly

  4553. one mapper element are required.</p>

  4554. <h3>Parameters</h3>

  4555. <table border="1" cellpadding="2" cellspacing="0">

  4556.   <tr>

  4557.     <td valign="top"><b>Attribute</b></td>

  4558.     <td valign="top"><b>Description</b></td>

  4559.     <td align="center" valign="top"><b>Required</b></td>

  4560.   </tr>

  4561.   <tr>

  4562.     <td valign="top">executable</td>

  4563.     <td valign="top">the command to execute without any command line

  4564.       arguments.</td>

  4565.     <td align="center" valign="top">Yes</td>

  4566.   </tr>

  4567.   <tr>

  4568.     <td valign="top">dest</td>

  4569.     <td valign="top">the directory where the target files will be placed.</td>

  4570.     <td align="center" valign="top">Yes</td>

  4571.   </tr>

  4572.   <tr>

  4573.     <td valign="top">dir</td>

  4574.     <td valign="top">the directory in which the command should be executed.</td>

  4575.     <td align="center" valign="top">No</td>

  4576.   </tr>

  4577.   <tr>

  4578.     <td valign="top">os</td>

  4579.     <td valign="top">list of Operating Systems on which the command may be

  4580.       executed.</td>

  4581.     <td align="center" valign="top">No</td>

  4582.   </tr>

  4583.   <tr>

  4584.     <td valign="top">output</td>

  4585.     <td valign="top">the file to which the output of the command should be

  4586.       redirected.</td>

  4587.     <td align="center" valign="top">No</td>

  4588.   </tr>

  4589.   <tr>

  4590.     <td valign="top">timeout</td>

  4591.     <td valign="top">Stop the command if it doesn't finish within the

  4592.       specified time (given in milliseconds).</td>

  4593.     <td align="center" valign="top">No</td>

  4594.   </tr>

  4595.   <tr>

  4596.     <td valign="top">failonerror</td>

  4597.     <td valign="top">Stop the buildprocess if the command exits with a

  4598.       returncode other than 0.</td>

  4599.     <td align="center" valign="top">No</td>

  4600.   </tr>

  4601.   <tr>

  4602.     <td valign="top">parallel</td>

  4603.     <td valign="top">Run the command only once, appending all files as

  4604.       arguments. Defaults to true. If false, command will be executed

  4605.       once for every file.</td>

  4606.     <td align="center" valign="top">No</td>

  4607.   </tr>

  4608.   <tr>

  4609.     <td valign="top">type</td>

  4610.     <td valign="top">One of <em>file</em>, <em>dir</em> or

  4611.       <em>both</em>. If set to <em>file</em>, only the names of plain

  4612.       files will be sent to the command. If set to <em>dir</em>, only

  4613.       the names of directories are considered.</td>

  4614.     <td align="center" valign="top">No, default is <em>file</em></td>

  4615.   </tr>

  4616. </table>

  4617. <h3>Parameters specified as nested elements</h3>

  4618. <h4>fileset</h4>

  4619. <p>You can use any number of nested <code>&lt;fileset&gt;</code>

  4620. elements to define the files for this task and refer to

  4621. <code>&lt;fileset&gt;</code>s defined elsewhere.</p>

  4622. <h4>arg</h4>

  4623. <p>Command line arguments should be specified as nested

  4624. <code>&lt;arg&gt;</code> elements. See <a

  4625. href="index.html#arg">Command line arguments</a>.</p>

  4626. <h4>srcfile</h4>

  4627. <p>By default the file names of the source files will be added to the

  4628. end of the command line. If you need to place it somewhere different,

  4629. use a nested <code>&lt;srcfile&gt;</code> element between your

  4630. <code>&lt;arg&gt;</code> elements to mark the insertion point.</code>

  4631. <h4>targetfile</h4>

  4632. <p><code>&lt;targetfile&gt;</code> is similar to

  4633. <code>&lt;srcfile&gt;</code> and marks the position of the target

  4634. filename on the command line. If omitted, the target filenames will

  4635. not be added to the command line at all.</p>

  4636. <h4>env</h4>

  4637. <p>It is possible to specify environment variables to pass to the

  4638. system command via nested <code>&lt;env&gt;</code> elements. See the

  4639. description in the section about <a href="#env">exec</a></p>

  4640. <p>Please note that the environment of the current Ant process is

  4641. <b>not</b> passed to the system command if you specify variables using

  4642. <code>&lt;env&gt;</code>.</p>

  4643. <h3>Examples</h3>

  4644. <blockquote><pre>

  4645. &lt;transform executable=&quot;cc&quot; dest=&quot;src/C&quot; parallel=&quot;false&quot;&gt;

  4646.   &lt;arg value=&quot;-c&quot; /&gt;

  4647.   &lt;arg value=&quot;-o&quot; /&gt;

  4648.   &lt;targetfile/&gt;

  4649.   &lt;srcfile/&gt;

  4650.   &lt;fileset dir=&quot;src/C&quot; includes=&quot;*.c&quot; /&gt;

  4651.   &lt;mapper type=&quot;glob&quot; from=&quot;*.c&quot; to=&quot;*.o&quot; /&gt;

  4652. &lt;/transform&gt;

  4653. </pre></blockquote>

  4654. <p>invokes <code>cc -c -o TARGETFILE SOURCEFILE</code> for each

  4655. <code>.c</code> file that is newer than the corresponding

  4656. <code>.o</code>, replacing TARGETFILE with the absolute filename of

  4657. the <code>.o</code> and SOURCEFILE with the absolute name of the

  4658. <code>.c</code> file.</p>

  4659. <hr>

  4660. <h2><a name="tstamp">Tstamp</a></h2>

  4661. <h3>Description</h3>

  4662. <p>Sets the DSTAMP, TSTAMP and TODAY properties in the current project. The

  4663. DSTAMP is in the &quot;yyyymmdd&quot; format, the TSTAMP is in the &quot;hhmm&quot;

  4664. format and TODAY is &quot;month day year&quot;.</p>

  4665. <p>These properties can be used in the buildfile, for instance, to create

  4666. timestamped filenames or used to replace placeholder tags inside documents to

  4667. indicate, for example, the release date. The best place for this task is in your

  4668. initialization target.</p>

  4669. <h3>Parameters</h3>

  4670. <table border="1" cellpadding="2" cellspacing="0">

  4671.   <tr>

  4672.     <td valign="top"><b>Attribute</b></td>

  4673.     <td valign="top"><b>Description</b></td>

  4674.     <td align="center" valign="top"><b>Required</b></td>

  4675.   </tr>

  4676. </table>

  4677. <h3>Examples</h3>

  4678. <pre>  &lt;tstamp/&gt;</pre>

  4679. <hr>

  4680. <h2><a name="uptodate">Uptodate</a></h2>

  4681. <h3>Description</h3>

  4682. <p>Sets a property if a target files are more up to date than a set of

  4683. Source files. Source files are specified by nested &lt;srcfiles&gt;

  4684. elements, these are <a href="#fileset">FileSet</a>s, while target

  4685. files are specified using a nested <a href="#mapper">mapper</a>

  4686. element.</p>

  4687. <p>The value part of the property being set is <i>true</i> if the

  4688. timestamp of the target files is more recent than the timestamp of

  4689. every corresponding source file.</p>

  4690. <p>The default behavior is to use a <a href="#merge-mapper">merge

  4691. mapper</a> whith the <code>to</code> attribute set to the value of the

  4692. targetfile attribute.</p>

  4693. <p>Normally, this task is used to set properties that are useful to avoid target

  4694. execution depending on the relative age of the specified files.</p>

  4695. <h3>Parameters</h3>

  4696. <table border="1" cellpadding="2" cellspacing="0">

  4697.   <tr>

  4698.     <td valign="top"><b>Attribute</b></td>

  4699.     <td valign="top"><b>Description</b></td>

  4700.     <td align="center" valign="top"><b>Required</b></td>

  4701.   </tr>

  4702.   <tr>

  4703.     <td valign="top">property</td>

  4704.     <td valign="top">the name of the property to set.</td>

  4705.     <td valign="top" align="center">Yes</td>

  4706.   </tr>

  4707.   <tr>

  4708.     <td valign="top">targetfile</td>

  4709.     <td valign="top">the file for which we want to determine the status.</td>

  4710.     <td valign="top" align="center">Yes, unless a nested mapper element is 

  4711.       present.</td>

  4712.   </tr>

  4713. </table>

  4714. <h3>Examples</h3>

  4715. <pre>  &lt;uptodate property=&quot;xmlBuild.notRequired&quot; targetfile=&quot;${deploy}\xmlClasses.jar&quot; &gt;

  4716.     &lt;srcfiles dir= &quot;${src}/xml&quot; includes=&quot;**/*.dtd&quot; /&gt;

  4717.   &lt;/uptodate&gt;</pre>

  4718. <p>sets the property <code><i>xmlBuild.notRequired</i></code> to the value &quot;true&quot;

  4719. if the <i>${deploy}/xmlClasses.jar</i> is more up to date than any of the DTD files in the <i>${src}/xml</i> directory.</p>

  4720. <p>This can be written as

  4721. <pre>  &lt;uptodate property=&quot;xmlBuild.notRequired&quot;  &gt;

  4722.     &lt;srcfiles dir= &quot;${src}/xml&quot; includes=&quot;**/*.dtd&quot; /&gt;

  4723.     &lt;mapper type=&quot;merge&quot; to=&quot;${deploy}\xmlClasses.jar&quot; /&gt;

  4724.   &lt;/uptodate&gt;</pre>

  4725. <p>as well.</p>

  4726. <hr>

  4727. <h2><a name="unzip">Unjar/Unwar/Unzip</a></h2>

  4728. <h3>Description</h3>

  4729. <p>Unzips a zip-, war- or jarfile.</p>

  4730. <p>For JDK 1.1 &quot;last modified time&quot; field is set to current time instead of being 

  4731. carried from zipfile.</p>

  4732. <p>File permissions will not be restored on extracted files.</p>

  4733. <h3>Parameters</h3>

  4734. <table border="1" cellpadding="2" cellspacing="0">

  4735.   <tr>

  4736.     <td valign="top"><b>Attribute</b></td>

  4737.     <td valign="top"><b>Description</b></td>

  4738.     <td align="center" valign="top"><b>Required</b></td>

  4739.   </tr>

  4740.   <tr>

  4741.     <td valign="top">src</td>

  4742.     <td valign="top">zipfile to expand.</td>

  4743.     <td align="center" valign="top">Yes</td>

  4744.   </tr>

  4745.   <tr>

  4746.     <td valign="top">dest</td>

  4747.     <td valign="top">directory where to store the expanded files.</td>

  4748.     <td align="center" valign="top">Yes</td>

  4749.   </tr>

  4750. </table>

  4751. <h3>Examples</h3>

  4752. <blockquote>

  4753.   <p><code>&lt;unzip src=&quot;${tomcat_src}/tools-src.zip&quot; dest=&quot;${tools.home}&quot;

  4754.   /&gt;</code></p>

  4755. </blockquote>

  4756. <hr>

  4757. <h2><a name="untar">Untar</a></h2>

  4758. <h3>Description</h3>

  4759. <p>Untars a tarfile.</p>

  4760. <p>File permissions will not be restored on extracted files.</p>

  4761. <p>For JDK 1.1 &quot;last modified time&quot; field is set to current time instead of being 

  4762. carried from tarfile.</p>

  4763. <h3>Parameters</h3>

  4764. <table border="1" cellpadding="2" cellspacing="0">

  4765.   <tr>

  4766.     <td valign="top"><b>Attribute</b></td>

  4767.     <td valign="top"><b>Description</b></td>

  4768.     <td align="center" valign="top"><b>Required</b></td>

  4769.   </tr>

  4770.   <tr>

  4771.     <td valign="top">src</td>

  4772.     <td valign="top">tarfile to expand.</td>

  4773.     <td align="center" valign="top">Yes</td>

  4774.   </tr>

  4775.   <tr>

  4776.     <td valign="top">dest</td>

  4777.     <td valign="top">directory where to store the expanded files.</td>

  4778.     <td align="center" valign="top">Yes</td>

  4779.   </tr>

  4780. </table>

  4781. <h3>Examples</h3>

  4782. <blockquote>

  4783.   <p><code>

  4784. &lt;gunzip src=&quot;tools.tar.gz&quot;/&gt;<br>

  4785. &lt;untar src=&quot;tools.tar&quot; dest=&quot;${tools.home}&quot;/&gt;

  4786. </code></p>

  4787. </blockquote>

  4788. <hr>

  4789. <h2><a name="war">War</a></h2>

  4790. <h3>Description</h3>

  4791. <p>An extension of the <a href="#jar">Jar</a> task with special

  4792. treatment for files that should end up in the

  4793. <code>WEB-INF/lib</code>, <code>WEB-INF/classes</code> or

  4794. <code>WEB-INF</code> directories of the Web Application Archive.

  4795. <p>(The War task is a shortcut for specifying the particular layout of a WAR file. 

  4796. The same thing can be accomplished by using the <i>prefix</i> and <i>fullpath</i>

  4797. attributes of the prefixedfilesets in a Zip or Jar task.)</p>

  4798. <h3>Parameters</h3>

  4799. <table border="1" cellpadding="2" cellspacing="0">

  4800.   <tr>

  4801.     <td valign="top"><b>Attribute</b></td>

  4802.     <td valign="top"><b>Description</b></td>

  4803.     <td align="center" valign="top"><b>Required</b></td>

  4804.   </tr>

  4805.   <tr>

  4806.     <td valign="top">warfile</td>

  4807.     <td valign="top">the war-file to create.</td>

  4808.     <td valign="top" align="center">Yes</td>

  4809.   </tr>

  4810.   <tr>

  4811.     <td valign="top">webxml</td>

  4812.     <td valign="top">The deployment descriptor to use (WEB-INF/web.xml).</td>

  4813.     <td valign="top" align="center">Yes</td>

  4814.   </tr>

  4815.   <tr>

  4816.     <td valign="top">basedir</td>

  4817.     <td valign="top">the directory from which to jar the files.</td>

  4818.     <td valign="top" align="center">No</td>

  4819.   </tr>

  4820.   <tr>

  4821.     <td valign="top">compress</td>

  4822.     <td valign="top">Not only store data but also compress them, defaults to true</td>

  4823.     <td align="center" valign="top">No</td>

  4824.   </tr>

  4825.   <tr>

  4826.     <td valign="top">includes</td>

  4827.     <td valign="top">comma separated list of patterns of files that must be

  4828.       included. All files are included when omitted.</td>

  4829.     <td valign="top" align="center">No</td>

  4830.   </tr>

  4831.   <tr>

  4832.     <td valign="top">includesfile</td>

  4833.     <td valign="top">the name of a file. Each line of this file is

  4834.       taken to be an include pattern</td>

  4835.     <td valign="top" align="center">No</td>

  4836.   </tr>

  4837.   <tr>

  4838.     <td valign="top">excludes</td>

  4839.     <td valign="top">comma separated list of patterns of files that must be

  4840.       excluded. No files (except default excludes) are excluded when omitted.</td>

  4841.     <td valign="top" align="center">No</td>

  4842.   </tr>

  4843.   <tr>

  4844.     <td valign="top">excludesfile</td>

  4845.     <td valign="top">the name of a file. Each line of this file is

  4846.       taken to be an exclude pattern</td>

  4847.     <td valign="top" align="center">No</td>

  4848.   </tr>

  4849.   <tr>

  4850.     <td valign="top">defaultexcludes</td>

  4851.     <td valign="top">indicates whether default excludes should be used or not

  4852.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  4853.     <td valign="top" align="center">No</td>

  4854.   </tr>

  4855.   <tr>

  4856.     <td valign="top">manifest</td>

  4857.     <td valign="top">the manifest file to use.</td>

  4858.     <td valign="top" align="center">No</td>

  4859.   </tr>

  4860.   <tr>

  4861.     <td valign="top">whenempty</td>

  4862.     <td valign="top">Behavior to use if no files match.</td>

  4863.     <td valign="top" align="center">No</td>

  4864.   </tr>

  4865. </table>

  4866. <h3>Nested elements</h3>

  4867. <h4>lib</h4>

  4868. <p>The nested <code>lib</code> element specifies a <a

  4869. href="#fileset">FileSet</a>. All files included in this fileset will

  4870. end up in the <code>WEB-INF/lib</code> directory of the war file.</p>

  4871. <h4>classes</h4>

  4872. <p>The nested <code>classes</code> element specifies a <a

  4873. href="#fileset">FileSet</a>. All files included in this fileset will

  4874. end up in the <code>WEB-INF/classes</code> directory of the war file.</p>

  4875. <h4>webinf</h4>

  4876. <p>The nested <code>webinf</code> element specifies a <a

  4877. href="#fileset">FileSet</a>. All files included in this fileset will

  4878. end up in the <code>WEB-INF</code> directory of the war file. If this

  4879. fileset includes a file named <code>web.xml</code>, the file is

  4880. ignored and you will get a warning.</p>

  4881. <h3>Examples</h3>

  4882. <p>Assume the following structure in the project's base directory:

  4883. <pre>

  4884. thirdparty/libs/jdbc1.jar

  4885. thirdparty/libs/jdbc2.jar

  4886. build/main/com/myco/myapp/Servlet.class

  4887. src/metadata/myapp.xml

  4888. src/html/myapp/index.html

  4889. src/jsp/myapp/front.jsp

  4890. src/graphics/images/gifs/small/logo.gif

  4891. src/graphics/images/gifs/large/logo.gif

  4892. </pre>

  4893. then the war file <code>myapp.war</code> created with

  4894. <pre>

  4895. &lt;war warfile=&quot;myapp.war&quot; webxml=&quot;src/metadata/myapp.xml&quot;&gt;

  4896.   &lt;fileset dir=&quot;src/html/myapp&quot; /&gt;

  4897.   &lt;fileset dir=&quot;src/jsp/myapp&quot; /&gt;

  4898.   &lt;lib dir=&quot;thirdparty/libs&quot;&gt;

  4899.     &lt;exclude name=&quot;jdbc1.jar&quot; /&gt;

  4900.   &lt;/lib&gt;

  4901.   &lt;classes dir=&quot;build/main&quot; /&gt;

  4902.   &lt;prefixedfileset dir=&quot;src/graphics/images/gifs&quot; 

  4903.                    prefix="images"/&gt;

  4904. &lt;/war&gt;

  4905. </pre>

  4906. will consist of

  4907. <pre>

  4908. WEB-INF/web.xml

  4909. WEB-INF/lib/jdbc2.jar

  4910. WEB-INF/classes/com/myco/myapp/Servlet.class

  4911. META-INF/MANIFEST.MF

  4912. index.html

  4913. front.jsp

  4914. images/small/logo.gif

  4915. images/large/logo.gif

  4916. </pre>

  4917. using Ant's default manifest file. The content of

  4918. <code>WEB-INF/web.xml</code> is identical to

  4919. <code>src/metadata/myapp.xml</code>.

  4920. <hr>

  4921. <h2><a name="zip">Zip</a></h2>

  4922. <h3>Description</h3>

  4923. <p>Creates a zipfile.</p>

  4924. <p>The <i>basedir</i> attribute is the reference directory from where to zip.</p>

  4925. <p>Note that file permissions will not be stored in the resulting zipfile.</p>

  4926. <p>It is possible to refine the set of files that are being zipped. This can be

  4927. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>

  4928. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to

  4929. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify

  4930. the files you want to have excluded. This is also done with patterns. And

  4931. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  4932. want to use default exclusions or not. See the section on <a

  4933. href="#directorybasedtasks">directory based tasks</a>, on how the

  4934. inclusion/exclusion of files works, and how to write patterns. 

  4935. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  4936. supports all attributes of <code>&lt;fileset&gt;</code>

  4937. (<code>dir</code> becomes <code>basedir</code>) as well as the nested

  4938. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  4939. <code>&lt;patternset&gt;</code> elements.</p>

  4940. <p>Or, you may place within it nested file sets, or references to file sets.

  4941. In this case <code>basedir</code> is optional; the implicit file set is <em>only used</em>

  4942. if <code>basedir</code> is set. You may use any mixture of the implicit file set

  4943. (with <code>basedir</code> set, and optional attributes like <code>includes</code>

  4944. and optional subelements like <code>&lt;include&gt;</code>); explicit nested

  4945. <code>&lt;fileset&gt;</code> elements so long as at least one fileset total is specified. The ZIP file will

  4946. only reflect the relative paths of files <em>within</em> each fileset.</p>

  4947. <p><code>&lt;zip&gt;</code> elements may contain both regular <code>&lt;fileset&gt;</code> elements

  4948. and also <code>&lt;prefixedfileset&gt;</code> elements.  A <code>&lt;prefixedfileset&gt;</code> is an extended form of a fileset,

  4949. which may include one of two special attributes: 

  4950. <i>prefix</i> or <i>fullpath</i>. These attributes modify the location of the files when they are placed 

  4951. inside the archive. If the <i>prefix</i> attribute is set, all the files in the prefixedfileset are prefixed

  4952. with that path in the archive. If the <i>fullpath</i> attribute is set, the file described by the prefixedfileset is placed at that 

  4953. exact location in the archive. (The <i>fullpath</i> attribute can only be set for prefixedfilesets that 

  4954. represent a single file. The <i>prefix</i> and <i>fullpath</i> attributes cannot both be set on the

  4955. same prefixedfileset.)</p>

  4956. <p>The <code>whenempty</code> parameter controls what happens when no files match.

  4957. If <code>skip</code> (the default), the ZIP is not created and a warning is issued.

  4958. If <code>fail</code>, the ZIP is not created and the build is halted with an error.

  4959. If <code>create</code>, an empty ZIP file (explicitly zero entries) is created,

  4960. which should be recognized as such by compliant ZIP manipulation tools.</p>

  4961. <h3>Parameters</h3>

  4962. <table border="1" cellpadding="2" cellspacing="0">

  4963.   <tr>

  4964.     <td valign="top"><b>Attribute</b></td>

  4965.     <td valign="top"><b>Description</b></td>

  4966.     <td valign="top" align="center"><b>Required</b></td>

  4967.   </tr>

  4968.   <tr>

  4969.     <td valign="top">zipfile</td>

  4970.     <td valign="top">the zip-file to create.</td>

  4971.     <td align="center" valign="top">Yes</td>

  4972.   </tr>

  4973.   <tr>

  4974.     <td valign="top">basedir</td>

  4975.     <td valign="top">the directory from which to zip the files.</td>

  4976.     <td align="center" valign="top">No</td>

  4977.   </tr>

  4978.   <tr>

  4979.     <td valign="top">compress</td>

  4980.     <td valign="top">Not only store data but also compress them, defaults to true</td>

  4981.     <td align="center" valign="top">No</td>

  4982.   </tr>

  4983.   <tr>

  4984.     <td valign="top">includes</td>

  4985.     <td valign="top">comma separated list of patterns of files that must be

  4986.       included. All files are included when omitted.</td>

  4987.     <td valign="top" align="center">No</td>

  4988.   </tr>

  4989.   <tr>

  4990.     <td valign="top">includesfile</td>

  4991.     <td valign="top">the name of a file. Each line of this file is

  4992.       taken to be an include pattern</td>

  4993.     <td valign="top" align="center">No</td>

  4994.   </tr>

  4995.   <tr>

  4996.     <td valign="top">excludes</td>

  4997.     <td valign="top">comma separated list of patterns of files that must be

  4998.       excluded. No files (except default excludes) are excluded when omitted.</td>

  4999.     <td valign="top" align="center">No</td>

  5000.   </tr>

  5001.   <tr>

  5002.     <td valign="top">excludesfile</td>

  5003.     <td valign="top">the name of a file. Each line of this file is

  5004.       taken to be an exclude pattern</td>

  5005.     <td valign="top" align="center">No</td>

  5006.   </tr>

  5007.   <tr>

  5008.     <td valign="top">defaultexcludes</td>

  5009.     <td valign="top">indicates whether default excludes should be used or not

  5010.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  5011.     <td valign="top" align="center">No</td>

  5012.   </tr>

  5013.   <tr>

  5014.     <td valign="top">whenempty</td>

  5015.     <td valign="top">Behavior when no files match.</td>

  5016.     <td valign="top" align="center">No</td>

  5017.   </tr>

  5018. </table>

  5019. <h3>Examples</h3>

  5020. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;

  5021.        basedir=&quot;htdocs/manual&quot;

  5022.   /&gt;</pre>

  5023. <p>zips all files in the <code>htdocs/manual</code> directory into a file called <code>manual.zip</code>

  5024. in the <code>${dist}</code> directory.</p>

  5025. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;

  5026.        basedir=&quot;htdocs/manual&quot;

  5027.        excludes=&quot;mydocs/**, **/todo.html&quot;

  5028.   /&gt;</pre>

  5029. <p>zips all files in the <code>htdocs/manual</code> directory. Files in the directory <code>mydocs</code>,

  5030. or files with the name <code>todo.html</code> are excluded.</p>

  5031. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;

  5032.        basedir=&quot;htdocs/manual&quot;

  5033.        includes=&quot;api/**/*.html&quot;

  5034.        excludes=&quot;**/todo.html&quot;

  5035.   /&gt;</pre>

  5036. <p>zips all files in the <code>htdocs/manual</code> directory. Only html files under the directory <code>api</code>

  5037. are zipped, and files with the name <code>todo.html</code> are excluded.</p>

  5038. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;&gt;

  5039.     &lt;fileset dir=&quot;htdocs/manual&quot;/&gt;

  5040.     &lt;fileset dir=&quot;.&quot; includes=&quot;ChangeLog.txt&quot;/&gt;

  5041.   &lt;/zip&gt;</pre>

  5042. <p>zips all files in the <code>htdocs/manual</code> directory, and also adds the file <code>ChangeLog.txt</code> in the

  5043. current directory. <code>ChangeLog.txt</code> will be added to the top of the ZIP file, just as if

  5044. it had been located at <code>htdocs/manual/ChangeLog.txt</code>.</p>

  5045. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;&gt;

  5046.     &lt;prefixedfileset dir=&quot;htdocs/manual&quot; prefix=&quot;docs/user-guide&quot;/&gt;

  5047.     &lt;prefixedfileset dir=&quot;.&quot; includes=&quot;ChangeLog27.txt&quot; fullpath=&quot;docs/ChangeLog.txt&quot;/&gt;

  5048.   &lt;/zip&gt;</pre>

  5049. <p>zips all files in the <code>htdocs/manual</code> directory into the <code>docs/user-guide</code> directory

  5050. in the archive, and also adds the file <code>ChangeLog27.txt</code> in the

  5051. current directory as <code>docs/ChangeLog.txt</code>. For example, the archive might end up containing two files:

  5052. <code>docs/user-guide/html/index.html</code> and <code>docs/ChangeLog.txt</code></p>

  5053. 

  5054. <hr>

  5055. <h2><a name="optionaltasks">Optional tasks</a></h2>

  5056. <ul>

  5057.   <li><a href="dotnet.html">.NET Tasks</a></li>

  5058.   <li><a href="antlr.html">ANTLR</a></li>

  5059.   <li><a href="#cab">Cab</a></li>

  5060.   <li><a href="clearcase.html">Clearcase Tasks</a></li>

  5061.   <li><a href="ejb.html">EJB Tasks</a></li>

  5062.   <li><a href="#ftp">FTP</a></li>

  5063.   <li><a href="javacc.html">JavaCC</a></li>

  5064.   <li><a href="jlink.html">Jlink</a></li>

  5065.   <li><a href="junit.html">JUnit</a></li>

  5066.   <li><a href="native2ascii.html">Native2Ascii</a></li>

  5067.   <li><a href="#netrexxc">NetRexxC</a></li>

  5068.   <li><a href="propertyfile.html">PropertyFile</a></li>

  5069.   <li><a href="#renameexts">RenameExtensions</a></li>

  5070.   <li><a href="#script">Script</a></li>

  5071.   <li><a href="#telnet">Telnet</a></li>

  5072.   <li><a href="#vssget">VssGet</a></li>

  5073. </ul>

  5074. <hr>

  5075. <h2><a name="cab">Cab</a></h2>

  5076. <h3>Description</h3>

  5077. <p>The cab task creates Microsoft cab archive files.  It is invoked

  5078. similar to the <a href="#jar">jar</a> or <a href="#zip">zip</a> tasks.

  5079. This task will only work on Windows, and will be silently ignored on

  5080. other platforms.  You must have the Microsoft cabarc tool available in

  5081. your executable path.</p>

  5082. <p>See the section on <a href="#directorybasedtasks">directory based

  5083. tasks</a>, on how the inclusion/exclusion of files works, and how to

  5084. write patterns.</p>

  5085. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  5086. supports all attributes of <code>&lt;fileset&gt;</code>

  5087. (<code>dir</code> becomes <code>basedir</code>) as well as the nested

  5088. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  5089. <code>&lt;patternset&gt;</code> elements.</p>

  5090. <h3>Parameters</h3>

  5091. <table border="1" cellpadding="2" cellspacing="0">

  5092.   <tr>

  5093.     <td valign="top"><b>Attribute</b></td>

  5094.     <td valign="top"><b>Description</b></td>

  5095.     <td align="center" valign="top"><b>Required</b></td>

  5096.   </tr>

  5097.   <tr>

  5098.     <td valign="top">cabfile</td>

  5099.     <td valign="top">the name of the cab file to create.</td>

  5100.     <td valign="top" align="center">Yes</td>

  5101.   </tr>

  5102.   <tr>

  5103.     <td valign="top">basedir</td>

  5104.     <td valign="top">the directory to start archiving files from.</td>

  5105.     <td valign="top" align="center">Yes</td>

  5106.   </tr>

  5107.   <tr>

  5108.     <td valign="top">verbose</td>

  5109.     <td valign="top">set to &quot;yes&quot; if you want to see the output from

  5110.       the cabarc tool.  defaults to &quot;no&quot;.</td>

  5111.     <td valign="top" align="center">No</td>

  5112.   </tr>

  5113.   <tr>

  5114.     <td valign="top">compress</td>

  5115.     <td valign="top">set to &quot;no&quot; to store files without compressing.

  5116.       defaults to &quot;yes&quot;.</td>

  5117.     <td valign="top" align="center">No</td>

  5118.   </tr>

  5119.   <tr>

  5120.     <td valign="top">options</td>

  5121.     <td valign="top">use to set additional command-line options for

  5122.       the cabarc tool.  should not normally be necessary.</td>

  5123.     <td valign="top" align="center">No</td>

  5124.   </tr>

  5125.   <tr>

  5126.     <td valign="top">includes</td>

  5127.     <td valign="top">comma separated list of patterns of files that

  5128.       must be included. All files are included when omitted.</td>

  5129.     <td valign="top" align="center">No</td>

  5130.   </tr>

  5131.   <tr>

  5132.     <td valign="top">includesfile</td>

  5133.     <td valign="top">the name of a file. Each line of this file is

  5134.       taken to be an include pattern</td>

  5135.     <td valign="top" align="center">No</td>

  5136.   </tr>

  5137.   <tr>

  5138.     <td valign="top">excludes</td>

  5139.     <td valign="top">comma separated list of patterns of files that

  5140.       must be excluded. No files (except default excludes) are excluded

  5141.       when omitted.</td>

  5142.     <td valign="top" align="center">No</td>

  5143.   </tr>

  5144.   <tr>

  5145.     <td valign="top">excludesfile</td>

  5146.     <td valign="top">the name of a file. Each line of this file is

  5147.       taken to be an exclude pattern</td>

  5148.     <td valign="top" align="center">No</td>

  5149.   </tr>

  5150.   <tr>

  5151.     <td valign="top">defaultexcludes</td>

  5152.     <td valign="top">indicates whether default excludes should be used

  5153.       or not (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>

  5154.     <td valign="top" align="center">No</td>

  5155.   </tr>

  5156. </table>

  5157. <h3>Examples</h3>

  5158. <blockquote><pre>

  5159. &lt;cab cabfile=&quot;${dist}/manual.cab&quot;

  5160.      basedir=&quot;htdocs/manual&quot; 

  5161.   /&gt;

  5162. </pre></blockquote>

  5163. <p>cabs all files in the htdocs/manual directory into a file called

  5164. manual.cab in the ${dist} directory.</p>

  5165. <blockquote><pre>

  5166. &lt;cab cabfile=&quot;${dist}/manual.cab&quot;

  5167.      basedir=&quot;htdocs/manual&quot;

  5168.      excludes=&quot;mydocs/**, **/todo.html&quot;

  5169.   /&gt;

  5170. </pre></blockquote>

  5171. <p>cabs all files in the htdocs/manual directory into a file called

  5172. manual.cab in the ${dist} directory. Files in the directory mydocs,

  5173. or files with the name todo.html are excluded.</p>

  5174. <blockquote><pre>

  5175. &lt;cab cabfile=&quot;${dist}/manual.cab&quot;

  5176.      basedir=&quot;htdocs/manual&quot;

  5177.      includes=&quot;api/**/*.html&quot;

  5178.      excludes=&quot;**/todo.html&quot;

  5179.      verbose=&quot;yes&quot;

  5180.   /&gt;

  5181. </pre></blockquote>

  5182. <p>cab all files in the htdocs/manual directory into a file called

  5183. manual.cab in the ${dist} directory. Only html files under the

  5184. directory api are archived, and files with the name todo.html are

  5185. excluded. Output from the cabarc tool is displayed in the build

  5186. output.</p>

  5187. <hr>

  5188. <h2><a name="ftp">FTP</a></h2>

  5189. <h3>Description</h3>

  5190. <p>The ftp task implements a basic FTP client that can send, receive,

  5191. list, and delete files.  See below for descriptions and examples of how

  5192. to perform each task.</p>

  5193. <p>The ftp task makes no attempt to determine what file system syntax is

  5194. required by the remote server, and defaults to Unix standards.

  5195. <i>remotedir</i> must be specified in the exact syntax required by the ftp

  5196. server. If the usual Unix conventions are not supported by the server,

  5197. <i>separator</i> can be used to set the file separator that should be used

  5198. instead.</p>

  5199. <p>See the section on <a href="#directorybasedtasks">directory based

  5200. tasks</a>, on how the inclusion/exclusion of files works, and how to

  5201. write patterns.</p>

  5202. <h3>Parameters</h3>

  5203. <table border="1" cellpadding="2" cellspacing="0">

  5204.   <tr>

  5205.     <td valign="top"><b>Attribute</b></td>

  5206.     <td valign="top"><b>Description</b></td>

  5207.     <td align="center" valign="top"><b>Required</b></td>

  5208.   </tr>

  5209.   <tr>

  5210.     <td valign="top">server</td>

  5211.     <td valign="top">the address of the remote ftp server.</td>

  5212.     <td valign="top" align="center">Yes</td>

  5213.   </tr>

  5214.   <tr>

  5215.     <td valign="top">port</td>

  5216.     <td valign="top">the port number of the remote ftp server.

  5217.                      Defaults to port 21.</td>

  5218.     <td valign="top" align="center">No</td>

  5219.   </tr>

  5220.   <tr>

  5221.     <td valign="top">userid</td>

  5222.     <td valign="top">the login id to use on the ftp server.</td>

  5223.     <td valign="top" align="center">Yes</td>

  5224.   </tr>

  5225.   <tr>

  5226.     <td valign="top">password</td>

  5227.     <td valign="top">the login password to use on the ftp server.</td>

  5228.     <td valign="top" align="center">Yes</td>

  5229.   </tr>

  5230.   <tr>

  5231.     <td valign="top">remotedir</td>

  5232.     <td valign="top">the directory to which to upload files on the 

  5233.                      ftp server.</td>

  5234.     <td valign="top" align="center">No</td>

  5235.   </tr>

  5236.   <tr>

  5237.     <td valign="top">action</td>

  5238.     <td valign="top">the ftp action to perform, defaulting to &quot;send&quot;.  

  5239.                      Currently supports&quot;put&quot;, &quot;get&quot;,

  5240.                      &quot;del&quot;, and &quot;list&quot;.</td>

  5241.     <td valign="top" align="center">No</td>

  5242.   </tr>

  5243.   <tr>

  5244.     <td valign="top">binary</td>

  5245.     <td valign="top">selects binary-mode (&quot;yes&quot;) or text-mode 

  5246.                      (&quot;no&quot;) transfers.  

  5247.                      Defaults to &quot;yes&quot;</td>

  5248.     <td valign="top" align="center">No</td>

  5249.   </tr>

  5250.   <tr>

  5251.     <td valign="top">passive</td>

  5252.     <td valign="top">selects passive-mode (&quot;yes&quot;) transfers.  

  5253.                      Defaults to &quot;no&quot;</td>

  5254.     <td valign="top" align="center">No</td>

  5255.   </tr>

  5256.   <tr>

  5257.     <td valign="top">verbose</td>

  5258.     <td valign="top">displays information on each file transferred if set 

  5259.                      to &quot;yes&quot;. Defaults to &quot;no&quot;.</td>

  5260.     <td valign="top" align="center">No</td>

  5261.   </tr>

  5262.   <tr>

  5263.     <td valign="top">depends</td>

  5264.     <td valign="top">transfers only new or changed files if set to 

  5265.                      &quot;yes&quot;. Defaults to &quot;no&quot;.</td>

  5266.     <td valign="top" align="center">No</td>

  5267.   </tr>

  5268.   <tr>

  5269.     <td valign="top">newer</td>

  5270.     <td valign="top">a synonym for <i>depends</i>.</td>

  5271.     <td valign="top" align="center">No</td>

  5272.   </tr>

  5273.   <tr>

  5274.     <td valign="top">separator</td>

  5275.     <td valign="top">sets the file separator used on the ftp server.

  5276.                      Defaults to &quot;/&quot;.</td>

  5277.     <td valign="top" align="center">No</td>

  5278.   </tr>

  5279.   <tr>

  5280.     <td valign="top">listing</td>

  5281.     <td valign="top">the file to write results of the &quot;list&quot; action.

  5282.                      Required for the &quot;list&quot; action, ignored otherwise.</td>

  5283.     <td valign="top" align="center">No</td>

  5284.   </tr>

  5285. </table>

  5286. <h3>Sending Files</h3>

  5287. <p>The easiest way to describe how to send files is with a couple of examples:</p>

  5288. <pre>

  5289.   &lt;ftp server=&quot;ftp.apache.org&quot;

  5290.        userid=&quot;anonymous&quot;

  5291.        password=&quot;me@myorg.com&quot;&gt;

  5292.     &lt;fileset dir=&quot;htdocs/manual&quot; /&gt;

  5293.   &lt;/ftp&gt;

  5294. </pre>

  5295. <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and 

  5296. uploads all files in the <code>htdocs/manual</code> directory 

  5297. to the default directory for that user.</p>

  5298. <pre>  &lt;ftp server=&quot;ftp.apache.org&quot;

  5299.        remotedir=&quot;incoming&quot;

  5300.        userid=&quot;anonymous&quot;

  5301.        password=&quot;me@myorg.com&quot;

  5302.        depends=&quot;yes&quot;

  5303.   &gt;

  5304.     &lt;fileset dir=&quot;htdocs/manual&quot; /&gt;

  5305.   &lt;/ftp&gt;</pre>

  5306. <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and 

  5307. uploads all new or changed files in the <code>htdocs/manual</code> directory 

  5308. to the <code>incoming</code> directory relative to the default directory

  5309. for <code>anonymous</code>.</p>

  5310. <pre>  &lt;ftp server=&quot;ftp.apache.org&quot;

  5311.        port=&quot;2121&quot;

  5312.        remotedir=&quot;/pub/incoming&quot;

  5313.        userid=&quot;coder&quot;

  5314.        password=&quot;java1&quot;

  5315.        depends=&quot;yes&quot;

  5316.        binary=&quot;no&quot;

  5317.   &gt;

  5318.     &lt;fileset dir=&quot;htdocs/manual&quot;&gt;

  5319.       &lt;include name=&quot;**/*.html&quot; /&gt;

  5320.     &lt;/fileset&gt;

  5321.   &lt;/ftp&gt;</pre>

  5322. <p>Logs in to <code>ftp.apache.org</code> at port <code>2121</code> as 

  5323. <code>coder</code> with password <code>java1</code> and uploads all new or 

  5324. changed HTML files in the <code>htdocs/manual</code> directory to the 

  5325. <code>/pub/incoming</code> directory. The files are transferred in text mode. Passive mode has been switched on to send files from behind a firewall.</p>

  5326. <pre>  &lt;ftp server=&quot;ftp.nt.org&quot;

  5327.        remotedir=&quot;c:\uploads&quot;

  5328.        userid=&quot;coder&quot;

  5329.        password=&quot;java1&quot;

  5330.        separator=&quot;\&quot;

  5331.        verbose=&quot;yes&quot;</pre>

  5332. <PRE>

  5333.   &gt;

  5334.     &lt;fileset dir=&quot;htdocs/manual&quot;&gt;

  5335.       &lt;include name=&quot;**/*.html&quot; /&gt;

  5336.     &lt;/fileset&gt;

  5337.   &lt;/ftp&gt;</PRE><p>Logs in to the Windows-based <code>ftp.nt.org</code> as 

  5338. <code>coder</code> with password <code>java1</code> and uploads all 

  5339. HTML files in the <code>htdocs/manual</code> directory to the 

  5340. <code>c:\uploads</code> directory.  Progress messages are displayed as each

  5341. file is uploaded.</p>

  5342. <h3>Getting Files</h3>

  5343. <p>Getting files from an FTP server works pretty much the same way as 

  5344. sending them does.  The only difference is that the nested filesets

  5345. use the remotedir attribute as the base directory for the files on the

  5346. FTP server, and the dir attribute as the local directory to put the files

  5347. into.  The file structure from the FTP site is preserved on the local machine.</p>

  5348. <pre>

  5349.   &lt;ftp action=&quot;get&quot;

  5350.        server=&quot;ftp.apache.org&quot;

  5351.        userid=&quot;anonymous&quot;

  5352.        password=&quot;me@myorg.com&quot;&gt;

  5353.     &lt;fileset dir=&quot;htdocs/manual&quot; &gt;

  5354.       &lt;include name=&quot;**/*.html&quot; /&gt;

  5355.     &lt;/fileset&gt;

  5356.   &lt;/ftp&gt;

  5357. </pre>

  5358. <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and 

  5359. recursively downloads all .html files from default directory for that user 

  5360. into the <code>htdocs/manual</code> directory on the local machine.</p>

  5361. <h3>Deleting Files</h3>

  5362. As you've probably guessed by now, you use nested fileset elements to 

  5363. select the files to delete from the remote FTP server.  Again, the 

  5364. filesets are relative to the remote directory, not a local directory.  In

  5365. fact, the dir attribute of the fileset is ignored completely.

  5366. <pre>

  5367.   &lt;ftp action=&quot;del&quot;

  5368.        server=&quot;ftp.apache.org&quot;

  5369.        userid=&quot;anonymous&quot;

  5370.        password=&quot;me@myorg.com&quot; &gt;

  5371.     &lt;fileset&gt;

  5372.       &lt;include name=&quot;**/*.tmp&quot; /&gt;

  5373.     &lt;/fileset&gt;

  5374.   &lt;/ftp&gt;

  5375. </pre>

  5376. <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and

  5377. tries to delete all *.tmp files from the default directory for that user.

  5378. If you don't have permission to delete a file, a BuildException is thrown.</p>

  5379. <h3>Listing Files</h3>

  5380. <pre>

  5381.   &lt;ftp action=&quot;list&quot;

  5382.        server=&quot;ftp.apache.org&quot;

  5383.        userid=quot;anonymous&quot;

  5384.        password=&quot;me@myorg.com&quot; 

  5385.        listing=&quot;data/ftp.listing&quot; &gt;

  5386.     &lt;fileset&gt;

  5387.       &lt;include name=&quot;**&quot; /&gt;

  5388.     &lt;/fileset&gt;

  5389.   &lt;/ftp&gt;

  5390. </pre>

  5391. <p>This provides a file listing in <code>data/ftp.listing</code> of all the files on

  5392. the FTP server relative to the default directory of the <code>anonymous</code>

  5393. user. The listing is in whatever format the FTP server normally lists files.</p>

  5394. <hr>

  5395. <h2><a name="netrexxc">NetRexxC</a></h2>

  5396. <h3>Description</h3>

  5397. <p>Compiles a <a href="http://www2.hursley.ibm.com/netrexx">NetRexx</a>

  5398. source tree within the running (Ant) VM.</p>

  5399. <p>The source and destination directory will be recursively scanned for

  5400. NetRexx source files to compile.  Only NetRexx files that have no corresponding

  5401. class file or where the class file is older than the java file will be compiled.</p>

  5402. <p>Files in the source tree are copied to the destination directory,

  5403. allowing support files to be located properly in the classpath. The source 

  5404. files are copied because the NetRexx compiler cannot produce class files in a

  5405. specific directory via parameters</p>

  5406. <p>The directory structure of the source tree should follow the package

  5407. hierarchy.</p>

  5408. <p>It is possible to refine the set of files that are being compiled/copied.

  5409. This can be done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and

  5410. <i>defaultexcludes</i> attributes. With the <i>includes</i> or <i>includesfile</i> attribute you 

  5411. specify the files you want to have included by using patterns. The 

  5412. <i>exclude</i> or <i>excludesfile</i> attribute is used to specify the files you want to have 

  5413. excluded.  This is also done with patterns.  And finally with the 

  5414. <i>defaultexcludes</i> attribute, you can specify whether you

  5415. want to use default exclusions or not. See the section on <a

  5416. href="#directorybasedtasks">directory based tasks</a>, on how the

  5417. inclusion/exclusion of files works, and how to write patterns.</p>

  5418. <p>This task forms an implicit <a href="#fileset">FileSet</a> and

  5419. supports all attributes of <code>&lt;fileset&gt;</code>

  5420. (<code>dir</code> becomes <code>srcdir</code>) as well as the nested

  5421. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  5422. <code>&lt;patternset&gt;</code> elements.</p>

  5423. 

  5424. <h3>Parameters</h3>

  5425. <table border="1" cellpadding="2" cellspacing="0">

  5426.   <tr>

  5427.     <td valign="top"><b>Attribute</b></td>

  5428.     <td valign="top"><b>Description</b></td>

  5429.     <td align="center" valign="top"><b>Required</b></td>

  5430.   </tr>

  5431.   <tr>

  5432.     <td valign="top">binary</td>

  5433.     <td valign="top">Whether literals are treated as the java binary

  5434.       type rather than the NetRexx types</td>

  5435.     <td valign="top" align="center">No</td>

  5436.   </tr>

  5437.   <tr>

  5438.     <td valign="top">classpath</td>

  5439.     <td valign="top">The classpath to use during compilation</td>

  5440.     <td valign="top" align="center">No</td>

  5441.   </tr>

  5442.   <tr>

  5443.     <td valign="top">comments</td>

  5444.     <td valign="top">Whether comments are passed through to the

  5445.       generated java source</td>

  5446.     <td valign="top" align="center">No</td>

  5447.   </tr>

  5448.   <tr>

  5449.     <td valign="top">compact</td>

  5450.     <td valign="top">Whether error messages come out in compact or

  5451.       verbose format</td>

  5452.     <td valign="top" align="center">No</td>

  5453.   </tr>

  5454.   <tr>

  5455.     <td valign="top">compile</td>

  5456.     <td valign="top">Whether the NetRexx compiler should compile the

  5457.       generated java code</td>

  5458.     <td valign="top" align="center">No</td>

  5459.   </tr>

  5460.   <tr>

  5461.     <td valign="top">console</td>

  5462.     <td valign="top">Whether or not messages should be displayed on the

  5463.       'console'</td>

  5464.     <td valign="top" align="center">No</td>

  5465.   </tr>

  5466.   <tr>

  5467.     <td valign="top">crossref</td>

  5468.     <td valign="top">Whether variable cross references are generated</td>

  5469.     <td valign="top" align="center">No</td>

  5470.   </tr>

  5471.   <tr>

  5472.     <td valign="top">decimal</td>

  5473.     <td valign="top">Whether decimal arithmetic should be used for the

  5474.       NetRexx code</td>

  5475.     <td valign="top" align="center">No</td>

  5476.   </tr>

  5477.   <tr>

  5478.     <td valign="top">defaultexcludes</td>

  5479.     <td valign="top">indicates whether default excludes should be used or not

  5480.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when

  5481.       omitted.</td>

  5482.     <td valign="top" align="center">No</td>

  5483.   </tr>

  5484.   <tr>

  5485.     <td valign="top">destDir</td>

  5486.     <td valign="top">the destination directory into which the NetRexx

  5487.       source files should be copied and then compiled</td>

  5488.     <td valign="top" align="center">Yes</td>

  5489.   </tr>

  5490.   <tr>

  5491.     <td valign="top">diag</td>

  5492.     <td valign="top">Whether diagnostic information about the compile is

  5493.       generated</td>

  5494.     <td valign="top" align="center">No</td>

  5495.   </tr>

  5496.   <tr>

  5497.     <td valign="top">excludes</td>

  5498.     <td valign="top">comma separated list of patterns of files that must be

  5499.       excluded. No files (except default excludes) are excluded when

  5500.       omitted.</td>

  5501.     <td valign="top" align="center">No</td>

  5502.   </tr>

  5503.   <tr>

  5504.     <td valign="top">excludesfile</td>

  5505.     <td valign="top">the name of a file. Each line of this file is

  5506.       taken to be an exclude pattern</td>

  5507.     <td valign="top" align="center">No</td>

  5508.   </tr>

  5509.   <tr>

  5510.     <td valign="top">explicit</td>

  5511.     <td valign="top">Whether variables must be declared explicitly

  5512.       before use</td>

  5513.     <td valign="top" align="center">No</td>

  5514.   </tr>

  5515.   <tr>

  5516.     <td valign="top">format</td>

  5517.     <td valign="top">Whether the generated java code is formatted nicely

  5518.       or left to match NetRexx line numbers for call stack debugging</td>

  5519.     <td valign="top" align="center">No</td>

  5520.   </tr>

  5521.   <tr>

  5522.     <td valign="top">includes</td>

  5523.     <td valign="top">comma separated list of patterns of files that must be

  5524.       included. All files are included when omitted.</td>

  5525.     <td valign="top" align="center">No</td>

  5526.   </tr>

  5527.   <tr>

  5528.     <td valign="top">includesfile</td>

  5529.     <td valign="top">the name of a file. Each line of this file is

  5530.       taken to be an include pattern</td>

  5531.     <td valign="top" align="center">No</td>

  5532.   </tr>

  5533.   <tr>

  5534.     <td valign="top">java</td>

  5535.     <td valign="top">Whether the generated java code is produced</td>

  5536.     <td valign="top" align="center">No</td>

  5537.   </tr>

  5538.   <tr>

  5539.     <td valign="top">keep</td>

  5540.     <td valign="top">Sets whether the generated java source file should be kept

  5541.       after compilation. The generated files will have an extension of

  5542.       .java.keep, <b>not</b> .java</td>

  5543.     <td valign="top" align="center">No</td>

  5544.   </tr>

  5545.   <tr>

  5546.     <td valign="top">logo</td>

  5547.     <td valign="top">Whether the compiler text logo is displayed when

  5548.       compiling</td>

  5549.     <td valign="top" align="center">No</td>

  5550.   </tr>

  5551.   <tr>

  5552.     <td valign="top">replace</td>

  5553.     <td valign="top">Whether the generated .java file should be replaced

  5554.       when compiling</td>

  5555.     <td valign="top" align="center">No</td>

  5556.   </tr>

  5557.   <tr>

  5558.     <td valign="top">savelog</td>

  5559.     <td valign="top">Whether the compiler messages will be written to

  5560.       NetRexxC.log as well as to the console</td>

  5561.     <td valign="top" align="center">No</td>

  5562.   </tr>

  5563.   <tr>

  5564.     <td valign="top">sourcedir</td>

  5565.     <td valign="top">Tells the NetRexx compiler to store the class files in the

  5566.       same directory as the source files. The alternative is the working

  5567.       directory</td>

  5568.     <td valign="top" align="center">No</td>

  5569.   </tr>

  5570.   <tr>

  5571.     <td valign="top">srcDir</td>

  5572.     <td valign="top">Set the source dir to find the source Netrexx

  5573.       files</td>

  5574.     <td valign="top" align="center">Yes</td>

  5575.   </tr>

  5576.   <tr>

  5577.     <td valign="top">strictargs</td>

  5578.     <td valign="top">Tells the NetRexx compiler that method calls always

  5579.       need parentheses, even if no arguments are needed, e.g. 

  5580.       <code>aStringVar.getBytes</code> vs. 

  5581.       <code>aStringVar.getBytes()</code></td>

  5582.     <td valign="top" align="center">No</td>

  5583.   </tr>

  5584.   <tr>

  5585.     <td valign="top">strictassign</td>

  5586.     <td valign="top">Tells the NetRexx compile that assignments must

  5587.       match exactly on type</td>

  5588.     <td valign="top" align="center">No</td>

  5589.   </tr>

  5590.   <tr>

  5591.     <td valign="top">strictcase</td>

  5592.     <td valign="top">Specifies whether the NetRexx compiler should be

  5593.       case sensitive or not</td>

  5594.     <td valign="top" align="center">No</td>

  5595.   </tr>

  5596.   <tr>

  5597.     <td valign="top">strictimport</td>

  5598.     <td valign="top">Whether classes need to be imported explicitly using an 

  5599.       <code>import</code> statement.  By default the NetRexx compiler will 

  5600.       import certain packages automatically</td>

  5601.     <td valign="top" align="center">No</td>

  5602.   </tr>

  5603.   <tr>

  5604.     <td valign="top">strictprops</td>

  5605.     <td valign="top">Whether local properties need to be qualified

  5606.       explicitly using <code>this</code></td>

  5607.     <td valign="top" align="center">No</td>

  5608.   </tr>

  5609.   <tr>

  5610.     <td valign="top">strictsignal</td>

  5611.     <td valign="top">Whether the compiler should force catching of

  5612.       exceptions by explicitly named types</td>

  5613.     <td valign="top" align="center">No</td>

  5614.   </tr>

  5615.   <tr>

  5616.     <td valign="top">symbols</td>

  5617.     <td valign="top">Whether debug symbols should be generated into the

  5618.       class file</td>

  5619.     <td valign="top" align="center">No</td>

  5620.   </tr>

  5621.   <tr>

  5622.     <td valign="top">time</td>

  5623.     <td valign="top">Asks the NetRexx compiler to print compilation

  5624.       times to the console</td>

  5625.     <td valign="top" align="center">No</td>

  5626.   </tr>

  5627.   <tr>

  5628.     <td valign="top">trace</td>

  5629.     <td valign="top">Turns on or off tracing and directs the resultant

  5630.       trace output</td>

  5631.     <td valign="top" align="center">No</td>

  5632.   </tr>

  5633.   <tr>

  5634.     <td valign="top">utf8</td>

  5635.     <td valign="top">Tells the NetRexx compiler that the source is in UTF8</td>

  5636.     <td valign="top" align="center">No</td>

  5637.   </tr>

  5638.   <tr>

  5639.     <td valign="top">verbose</td>

  5640.     <td valign="top">Whether lots of warnings and error messages should

  5641.       be generated</td>

  5642.     <td valign="top" align="center">Yes</td>

  5643.   </tr>

  5644. </table>

  5645. <h3>Examples</h3>

  5646. <blockquote>

  5647.   <p><code>&lt;netrexxc srcDir=&quot;/source/project&quot;

  5648.            includes=&quot;vnr/util/*&quot;

  5649.            destDir=&quot;/source/project/build&quot;

  5650.            classpath=&quot;/source/project2/proj.jar&quot;

  5651.            comments=&quot;true&quot;

  5652.            crossref=&quot;false&quot; replace=&quot;true&quot;

  5653.            keep=&quot;true&quot; /&gt;</code>

  5654.   </p>

  5655. </blockquote>

  5656. <hr>

  5657. <h2><a name="renameexts">RenameExtensions</a></h2>

  5658. <h3><i>Deprecated</i></h3>

  5659. <p><i>This task has been deprecated.  Use the <a href="#move">move</a>

  5660. task with a <a href="#glob-mapper">glob mapper</a> instead.</i></p>

  5661. <h3>Description</h3>

  5662. <p>Renames files in the <code>srcDir</code> directory ending with the

  5663. <code>fromExtension</code> string so that they end with the 

  5664. <code>toExtension</code> string. Files are only replaced if 

  5665. <code>replace</code> is true

  5666. </p>

  5667. <p>See the section on 

  5668. <a href="#directorybasedtasks">directory based tasks</a>, on how the

  5669. inclusion/exclusion of files works, and how to write patterns. 

  5670. This task forms an implicit <a href="#fileset">FileSet</a> and

  5671. supports all attributes of <code>&lt;fileset&gt;</code>

  5672. (<code>dir</code> becomes <code>srcDir</code>) as well as the nested

  5673. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code> and

  5674. <code>&lt;patternset&gt;</code> elements.</p>

  5675. <h3>Parameters</h3>

  5676. <table border="1" cellpadding="2" cellspacing="0">

  5677.   <tr>

  5678.     <td valign="top"><b>Attribute</b></td>

  5679.     <td valign="top"><b>Description</b></td>

  5680.     <td align="center" valign="top"><b>Required</b></td>

  5681.   </tr>

  5682.   <tr>

  5683.     <td valign="top">defaultexcludes</td>

  5684.     <td valign="top">indicates whether default excludes should be used or not

  5685.       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when

  5686.       omitted.</td>

  5687.     <td valign="top" align="center">No</td>

  5688.   </tr>

  5689.   <tr>

  5690.     <td valign="top">excludes</td>

  5691.     <td valign="top">comma separated list of patterns of files that must be

  5692.       excluded. No files (except default excludes) are excluded when

  5693.       omitted.</td>

  5694.     <td valign="top" align="center">No</td>

  5695.   </tr>

  5696.   <tr>

  5697.     <td valign="top">excludesfile</td>

  5698.     <td valign="top">the name of a file. Each line of this file is

  5699.       taken to be an exclude pattern</td>

  5700.     <td valign="top" align="center">No</td>

  5701.   </tr>

  5702.   <tr>

  5703.     <td valign="top">fromExtention</td>

  5704.     <td valign="top">The string that files must end in to be renamed</td>

  5705.     <td valign="top" align="center">Yes</td>

  5706.   </tr>

  5707.   <tr>

  5708.     <td valign="top">includes</td>

  5709.     <td valign="top">comma separated list of patterns of files that must be

  5710.       included. All files are included when omitted.</td>

  5711.     <td valign="top" align="center">No</td>

  5712.   </tr>

  5713.   <tr>

  5714.     <td valign="top">includesfile</td>

  5715.     <td valign="top">the name of a file. Each line of this file is

  5716.       taken to be an include pattern</td>

  5717.     <td valign="top" align="center">No</td>

  5718.   </tr>

  5719.   <tr>

  5720.     <td valign="top">replace</td>

  5721.     <td valign="top">Whether the file being renamed to should be

  5722.       replaced if it already exists</td>

  5723.     <td valign="top" align="center">No</td>

  5724.   </tr>

  5725.   <tr>

  5726.     <td valign="top">srcDir</td>

  5727.     <td valign="top">The starting directory for files to search in</td>

  5728.     <td valign="top" align="center">Yes</td>

  5729.   </tr>

  5730.   <tr>

  5731.     <td valign="top">toExtension</td>

  5732.     <td valign="top">The string that renamed files will end with on

  5733.       completion</td>

  5734.     <td valign="top" align="center">Yes</td>

  5735.   </tr>

  5736. </table>

  5737. <h3>Examples</h3>

  5738. <blockquote>

  5739.   <p><code>&lt;renameext srcDir=&quot;/source/project1&quot;

  5740.               includes=&quot;**&quot;

  5741.               excludes=&quot;**/samples/*&quot;

  5742.               fromExtension=&quot;.java.keep&quot;

  5743.               toExtension=&quot;.java&quot;

  5744.               replace=&quot;true&quot; /&gt;

  5745. </code>

  5746.   </p>

  5747. </blockquote>

  5748. 

  5749. <hr>

  5750. <h2><a name="script">Script</a></h2>

  5751. <h3>Description</h3>

  5752. <p>Execute a script in a 

  5753.   <a href="http://oss.software.ibm.com/developerworks/opensource/bsf/">BSF</a> supported language.

  5754. <p>All items (tasks, targets, etc) of the running project are

  5755. accessible from the script, using either their <code>name</code> or

  5756. <code>id</code> attributes.</p>

  5757. <p>Scripts can do almost anything a task written in Java could do.</p>

  5758. <h3>Parameters</h3>

  5759. <table border="1" cellpadding="2" cellspacing="0">

  5760.   <tr>

  5761.     <td valign="top"><b>Attribute</b></td>

  5762.     <td valign="top"><b>Description</b></td>

  5763.     <td align="center" valign="top"><b>Required</b></td>

  5764.   </tr>

  5765.   <tr>

  5766.     <td valign="top">language</td>

  5767.     <td valign="top">The programming language the script is written in.

  5768.       Must be a supported BSF language</td>

  5769.     <td valign="top" align="center">No</td>

  5770.   </tr>

  5771.   <tr>

  5772.     <td valign="top">src</td>

  5773.     <td valign="top">The location of the script as a file, if not inline</td>

  5774.     <td valign="top" align="center">No</td>

  5775.   </tr>

  5776. </table>

  5777. <h3>Examples</h3>

  5778. <blockquote><pre>

  5779. &lt;project name=&quot;squares&quot; default=&quot;main&quot; basedir=&quot;.&quot;&gt;

  5780. 

  5781.   &lt;target name=&quot;setup&quot;&gt;

  5782. 

  5783.     &lt;script language=&quot;javascript&quot;&gt; &lt;![CDATA[

  5784. 

  5785.       for (i=1; i&lt;=10; i++) {

  5786.         echo = squares.createTask(&quot;echo&quot;);

  5787.         main.addTask(echo);

  5788.         echo.setMessage(i*i);

  5789.       }

  5790. 

  5791.     ]]&gt; &lt;/script&gt;

  5792. 

  5793.   &lt;/target&gt;

  5794. 

  5795.   &lt;target name=&quot;main&quot; depends=&quot;setup&quot; /&gt;

  5796. 

  5797. &lt;/project&gt;

  5798. </pre></blockquote>

  5799. <p>generates</p>

  5800. <blockquote><pre>

  5801. setup:

  5802. 

  5803. main:

  5804. 1

  5805. 4

  5806. 9

  5807. 16

  5808. 25

  5809. 36

  5810. 49

  5811. 64

  5812. 81

  5813. 100

  5814. 

  5815. BUILD SUCCESSFUL

  5816. </pre></blockquote>

  5817. <p>Another example, using <a href="#references">references by id</a>

  5818. and two different scripting languages:</p>

  5819. <blockquote><pre>

  5820. &lt;project name=&quot;testscript&quot; default=&quot;main&quot;&gt;

  5821.   &lt;target name=&quot;sub&quot;&gt;

  5822.     &lt;echo id=&quot;theEcho&quot; /&gt;

  5823.   &lt;/target&gt;

  5824. 

  5825.   &lt;target name=&quot;sub1&quot;&gt;

  5826.     &lt;script language=&quot;netrexx&quot;&gt;&lt;![CDATA[

  5827.       theEcho.setMessage(&quot;In sub1&quot;)

  5828.       sub.execute

  5829.     ]]&gt;&lt;/script&gt;

  5830.   &lt;/target&gt;

  5831. 

  5832.   &lt;target name=&quot;sub2&quot;&gt;

  5833.     &lt;script language=&quot;javascript&quot;&gt;&lt;![CDATA[

  5834.       theEcho.setMessage(&quot;In sub2&quot;);

  5835.       sub.execute();

  5836.     ]]&gt;&lt;/script&gt;

  5837.   &lt;/target&gt;

  5838. 

  5839.   &lt;target name=&quot;main&quot; depends=&quot;sub1,sub2&quot; /&gt;

  5840. &lt;/project&gt;

  5841. </pre></blockquote>

  5842. <p>generates</p>

  5843. <blockquote><pre>

  5844. sub1:

  5845. In sub1

  5846. 

  5847. sub2:

  5848. In sub2

  5849. 

  5850. main:

  5851. 

  5852. BUILD SUCCESSFUL

  5853. </pre></blockquote>

  5854. <hr>

  5855. <h2><a name="telnet">Telnet</a></h2>

  5856. <h3>Description</h3>

  5857. Task to automate a remote telnet session. The task uses nested &lt;read&gt; to indicate strings to wait for, and  &lt;write&gt; tags to specify text to send.  

  5858. 

  5859. <p>If you do specify a userid and password, the system will assume a common unix prompt to wait on. This behavior can be easily over-ridden.</p>

  5860. <h3>Parameters</h3>

  5861. <table border="1" cellpadding="2" cellspacing="0">

  5862.   <tr>

  5863.     <th>Attribute</th>

  5864.     <th>Values</th>

  5865.     <th>Required</th>

  5866.   </tr>

  5867.   <tr>

  5868.      <td>userid</td>

  5869.      <td>the login id to use on the telnet server.</td>

  5870.      <td>No</td>

  5871.   </tr>

  5872.   <tr>

  5873.      <td>password</td>

  5874.      <td>the login password to use on the telnet server.</td>

  5875.      <td>No</td>

  5876.   </tr>

  5877.   <tr>

  5878.      <td>server</td>

  5879.      <td>the address of the remote telnet server.</td>

  5880.      <td>Yes</td>

  5881.   </tr>

  5882.   <tr>

  5883.      <td>port</td>

  5884.      <td>the port number of the remote telnet server. Defaults to port 23.</td>

  5885.      <td>No</td>

  5886.   </tr>

  5887.   <tr>

  5888.      <td>initialCR</td>

  5889.      <td>send a cr after connecting ("yes"). Defaults to "no".</td>

  5890.      <td>No</td>

  5891.   </tr>

  5892.   <tr>

  5893.      <td>timeout</td>

  5894.      <td>set a default timeout to wait for a response. Specified in seconds. Default is no timeout.</td>

  5895.      <td>No</td>

  5896.   </tr>

  5897. </table>

  5898. <h3>Examples</h3>

  5899. A simple example of connecting to a server and running a command.  This assumes a prompt of "ogin:" for the userid, and a prompt of "assword:" for the password.

  5900. <blockquote><pre>

  5901. &lt;telnet userid=&quot;bob&quot; password=&quot;badpass&quot; server=&quot;localhost&quot;&gt;

  5902.    &lt;read&gt;/home/bob&lt;/read&gt;

  5903.    &lt;write&gt;ls&lt;/write&gt;

  5904.    &lt;read string=&quot;/home/bob&quot;/&gt;

  5905. &lt;/telnet&gt;

  5906. </pre></blockquote>

  5907. 

  5908. This task can be rewritten as:

  5909. <blockquote><pre>

  5910. &lt;telnet server=&quot;localhost&quot;&gt;

  5911.    &lt;read&gt;ogin:&lt;/read&gt;

  5912.    &lt;write&gt;bob&lt;/write&gt;

  5913.    &lt;read&gt;assword:&lt;/read&gt;

  5914.    &lt;write&gt;badpass&lt;/write&gt;

  5915.    &lt;read&gt;/home/bob&lt;/read&gt;

  5916.    &lt;write&gt;ls&lt;/write&gt;

  5917.    &lt;read&gt;/home/bob&lt;/read&gt;

  5918. &lt;/telnet&gt;

  5919. </pre></blockquote>

  5920. 

  5921. A timeout can be specified at the &lt;telnet&gt; level or at the &lt;read&gt; level. This will connect, issue a sleep command that is suppressed from displaying and wait 10 seconds before quitting.

  5922. <blockquote><pre>

  5923. &lt;telnet userid=&quot;bob&quot; password=&quot;badpass&quot; server=&quot;localhost&quot; timeout=&quot;20&quot;&gt;

  5924.    &lt;read&gt;/home/bob&lt;/read&gt;

  5925.    &lt;write echo=&quot;false&quot;&gt;sleep 15&lt;/write&gt;

  5926.    &lt;read timeout=&quot;10&quot;&gt;/home/bob&lt;/read&gt;

  5927. &lt;/telnet&gt;

  5928. </pre></blockquote>

  5929. 

  5930. The task can be used with other ports as well:

  5931. <blockquote><pre>

  5932. &lt;telnet port=&quot;80&quot; server=&quot;localhost&quot; timeout=&quot;20&quot;&gt;

  5933.    &lt;read/&gt;

  5934.    &lt;write&gt;GET / http/0.9&lt;/write&gt;

  5935.    &lt;write/&gt;

  5936.    &lt;read timeout=&quot;10&quot;&gt;&amp;lt;/HTML&amp;gt;&lt;/read&gt;

  5937. &lt;/telnet&gt;

  5938. </pre></blockquote>

  5939. <hr>

  5940. <h2><a name="vssget">VssGet</a></h2>

  5941. <h3>Description</h3>

  5942. Task to perform GET commands to Microsoft Visual Source Safe.

  5943. <p>If you specify two or more attributes from version, date and 

  5944. label only one will be used in the order version, date, label.</p>

  5945. <h3>Parameters</h3>

  5946. <table border="1" cellpadding="2" cellspacing="0">

  5947.   <tr>

  5948.     <th>Attribute</th>

  5949.     <th>Values</th>

  5950.     <th>Required</th>

  5951.   </tr>

  5952.   <tr>

  5953.      <td>login</td>

  5954.      <td>username,password</td>

  5955.      <td>No</td>

  5956.   </tr>

  5957.   <tr>

  5958.      <td>vsspath</td>

  5959.      <td>SourceSafe path</td>

  5960.      <td>Yes</td>

  5961.   </tr>

  5962.   <tr>

  5963.      <td>localpath</td>

  5964.      <td>Override the working directory and get to the specified path</td>

  5965.      <td>No</td>

  5966.   </tr>

  5967.   <tr>

  5968.      <td>writable</td>

  5969.      <td>true or false</td>

  5970.      <td>No</td>

  5971.   </tr>

  5972.   <tr>

  5973.      <td>recursive</td>

  5974.      <td>true or false</td>

  5975.      <td>No</td>

  5976.   </tr>

  5977.   <tr>

  5978.      <td>version</td>

  5979.      <td>a version number to get</td>

  5980.      <td>No</td>

  5981.   </tr>

  5982.   <tr>

  5983.      <td>date</td>

  5984.      <td>a date stamp to get at</td>

  5985.      <td>No</td>

  5986.   </tr>

  5987.   <tr>

  5988.      <td>label</td>

  5989.      <td>a label to get for</td>

  5990.      <td>No</td>

  5991.   </tr>

  5992.   <tr>

  5993.      <td>ssdir</td>

  5994.      <td>directory where <code>ss.exe</code> resides. By default the

  5995.      task expects it to be in the PATH.</td>

  5996.      <td>No</td>

  5997.   </tr>

  5998. </table>

  5999. <p>Note that only one of version, date or label should be specified</p>

  6000. <h3>Examples</h3>

  6001. <blockquote>

  6002. <pre>

  6003. &lt;vssget localPath=&quot;C:\mysrc\myproject&quot;

  6004.         recursive=&quot;true&quot; 

  6005.         label=&quot;Release1&quot;

  6006.         login=&quot;me,mypassword&quot;

  6007.         vsspath=&quot;/source/aProject&quot;

  6008.         writable=&quot;true&quot;/&gt;

  6009. </pre>

  6010. </blockquote>

  6011. <p>Does a get on the VSS-Project <i>$/source/aproject</i> using the username

  6012. <i>me</i> and the password <i>mypassword</i>. It will recursively get the files 

  6013. which are labeled <i>Release1</i> and write them to the local directory

  6014. <i>C:\mysrc\myproject</i>. The local files will be writable.</p>

  6015. <hr>

  6016. 

  6017. <h2><a name="buildevents">Build Events</a></h2>

  6018. Ant is capable of generating build events as it performs the tasks necessary to build a project. 

  6019. Listeners can be attached to ant to receive these events. This capability could be used, for example,

  6020. to connect Ant to a GUI or to integrate Ant with an IDE. 

  6021. 

  6022. <p>To use build events you need to create an ant <code>Project</code> object. You can then call the 

  6023. <code>addBuildListener</code> method to add your listener to the project. Your listener must implement

  6024. the <code>org.apache.tools.antBuildListener</code> interface. The listener will receive BuildEvents 

  6025. for the following events

  6026. <ul>

  6027. <li>Build started

  6028. <li>Build finished

  6029. <li>Target started

  6030. <li>Target finished

  6031. <li>Task started

  6032. <li>Task finished

  6033. <li>Message logged

  6034. </ul>

  6035. 

  6036. If you wish to attach a listener from the command line you may use the -listener option. For example

  6037. <blockquote>

  6038.   <pre>ant -listener org.apache.tools.ant.XmlLogger</pre>

  6039. </blockquote>

  6040. will run ant with a listener which generates an XML representation of the build progress. This 

  6041. listener is included with ant as is the default listener which generates the logging to standard

  6042. output.

  6043. 

  6044. 

  6045. <hr>

  6046. <h2><a name="writingowntask">Writing your own task</a></h2>

  6047. <p>It is very easy to write your own task:</p>

  6048. <ol>

  6049.   <li>Create a Java class that extends <code>org.apache.tools.ant.Task</code>.</li>

  6050.   <li>For each attribute, write a setter method. The setter method must be a 

  6051.     <code>public void</code> method that takes a single argument. The

  6052.     name of the method must begin with &quot;set&quot;, followed by the

  6053.     attribute name, with the first character in uppercase, and the rest in

  6054.     lowercase. The type of the attribute can be <code>String</code>, any 

  6055.     primitive type (they are converted for you from their String-representation

  6056. 	in the build-file. If you specify a boolean your method will be passed the value 

  6057. 	<i>true</i> if the value specified in the build-file is one of &quot;true&quot;,

  6058. 	&quot;yes&quot; or &quot;on&quot;), <code>Class</code>, <code>File</code>

  6059. 	(in which case the value of the attribute is interpreted relative to the 

  6060. 	project's basedir) or any other type that has a constructor with a single 

  6061. 	<code>String</code> argument</li>

  6062.   <li>If your task has enumerated attributes, you should consider using

  6063.     a subclass of org.apache.tools.ant.types.EnumeratedAttribute as argument

  6064.     to your setter method. See org.apache.tools.ant.taskdefs.FixCRLF for

  6065.     an example.</li>

  6066.   <li>If the task should support character data, write a <code>public void 

  6067.     addText(String)</code> method.</li>

  6068.   <li>For each nested element, write a create or add method. A create method 

  6069.     must be a <code>public</code> method that takes no arguments and returns 

  6070.     an Object type. The name of the create method must begin with 

  6071.     &quot;create&quot;, followed by the element name. An add method must be 

  6072.     a <code>public void</code> method that takes a single argument of an 

  6073.     Object type with a no argument constructor. The name of the add method 

  6074.     must begin with &quot;add&quot;, followed by the element name.

  6075.   <li>Write a <code>public void execute</code> method, with no arguments, that

  6076.     throws a <code>BuildException</code>. This method implements the task

  6077.     itself.</li>

  6078. </ol>

  6079. <h3>The life cycle of a task</h3>

  6080. <ol>

  6081.   <li>The task gets instantiated using a no-arg constructor at parser

  6082.     time. This means even tasks that are never executed get

  6083.     instantiated.</li>

  6084. 

  6085.   <li>The tasks gets references to its project and location inside the

  6086.     build file via their inherited <code>project</code> and

  6087.     <code>location</code> variables.</li>

  6088. 

  6089.   <li>If the user specified an id attribute to this task, the project

  6090.     registers a reference to this newly created task - at parser

  6091.     time.</li>

  6092. 

  6093.   <li>The task gets a reference to the target it belongs to via its

  6094.     inherited <code>target</code> variable.</li>

  6095. 

  6096.   <li><code>init()</code> is called at parser time.</li>

  6097. 

  6098.   <li>All child elements of the XML element corresponding to this task

  6099.     are created via this task's <code>createXXX()</code> methods or

  6100.     instantiated and added to this task via its <code>addXXX()</code>

  6101.     methods - at parser time.</li>

  6102. 

  6103.   <li>All attributes of this task get set via their corresponding

  6104.     <code>setXXX</code> methods - at runtime.</li>

  6105. 

  6106.   <li>The content character data sections inside the XML element

  6107.     corresponding to this task is added to the task via its

  6108.     <code>addText</code> method - at runtime.</li>

  6109. 

  6110.   <li>All attributes of all child elements get set via their corresponding

  6111.     <code>setXXX</code> methods - at runtime.</li>

  6112. 

  6113.   <li><code>execute()</code> is called at runtime.</li>

  6114. 

  6115. </ol>

  6116. <h3>Example</h3>

  6117. <p>Let's write our own task, that prints a message on the System.out stream. The

  6118. task has one attribute called &quot;message&quot;.</p>

  6119. <blockquote>

  6120.   <pre>package com.mydomain;

  6121. 

  6122. import org.apache.tools.ant.BuildException;

  6123. import org.apache.tools.ant.Task;

  6124. 

  6125. public class MyVeryOwnTask extends Task {

  6126.   private String msg;

  6127. 

  6128.   // The method executing the task

  6129.   public void execute() throws BuildException {

  6130.     System.out.println(msg);

  6131.   }

  6132. 

  6133.   // The setter for the &quot;message&quot; attribute

  6134.   public void setMessage(String msg) {

  6135.     this.msg = msg;

  6136.   }

  6137. }</pre>

  6138. </blockquote>

  6139. <p>It's really this simple;-)</p>

  6140. <p>Adding your task to the system is rather simple too:</p>

  6141. <ol>

  6142.   <li>Make sure the class that implements your task is in the classpath when

  6143.     starting Ant.</li>

  6144.   <li>Add a <i>taskdef</i> element to your project. This actually adds

  6145.     your task to the system.</li>

  6146.   <li>Use your task in the rest of the buildfile.</li>

  6147. </ol>

  6148. <h3>Example</h3>

  6149. <blockquote>

  6150.   <pre>&lt;?xml version=&quot;1.0&quot;?&gt;

  6151. 

  6152. &lt;project name=&quot;OwnTaskExample&quot; default=&quot;main&quot; basedir=&quot;.&quot;&gt;

  6153.   &lt;taskdef name=&quot;mytask&quot; classname=&quot;com.mydomain.MyVeryOwnTask&quot;/&gt;

  6154. 

  6155.   &lt;target name=&quot;main&quot;&gt;

  6156.     &lt;mytask message=&quot;Hello World! MyVeryOwnTask works!&quot; /&gt;

  6157.   &lt;/target&gt;

  6158. &lt;/project&gt;

  6159. </pre>

  6160. </blockquote>

  6161. <p>Another way to add a task (more permanently), is to add the task name and

  6162. implementing class name to the <code>default.properties</code> file in the <code>org.apache.tools.ant.taskdefs</code>

  6163. package. Then you can use it as if it were a built in task.</p>

  6164. <hr>

  6165. <h2><a name="faq">FAQ, DTD, external resources</a></h2>

  6166. <p>There is an online FAQ for Ant at <a

  6167. href="http://jakarta.apache.org/jyve-faq/Turbine/screen/DisplayTopics/action/SetAll/project_id/2/faq_id/16">jakarta.apache.org</a>. This

  6168. FAQ is interactive, which means you can ask and answer questions

  6169. online.</p>

  6170. <p>One of the questions poping up quite often is &quot;Is there a DTD for

  6171. buildfiles?&quot;. Please refer to the FAQ for an answer.</p>

  6172. <hr>

  6173. <h2><a name="feedback">Feedback</a></h2>

  6174. <p>To provide feedback on this software, please subscribe to the Ant User

  6175. Mail List (<a href="mailto:ant-user-subscribe@jakarta.apache.org">ant-user-subscribe@jakarta.apache.org</a>)</p>

  6176. <p>If you want to contribute to Ant or stay current with the latest

  6177. development, join the Ant Development Mail List (<a

  6178. href="mailto:ant-dev-subscribe@jakarta.apache.org">ant-dev-subscribe@jakarta.apache.org</a>)</p>

  6179. <p>Archives of both lists can be found at <a

  6180. href="http://archive.covalent.net/">http://archive.covalent.net/</a>. Many

  6181. thanks to Covalent Technologies. Another archive can be found at <a

  6182. href="http://marc.theaimsgroup.com">http://marc.theaimsgroup.com</a>. If

  6183. you know of any additional archive sites, please report to the

  6184. lists.</p>

  6185. <hr>

  6186. <p align="center">Copyright &copy; 2000 Apache Software Foundation. All rights

  6187. Reserved.</p>

  6188. 

  6189. </body>

  6190. 

  6191. </html>
Please read the following content carefully:

Dear OpenI User

Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.

For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》

Agree and continue
Disagree, exit