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: f2471de482
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f2471de482'
${ noResults }
ant/docs/index.html

2153 lines
88 KiB
Raw Blame History 

  1. <html>

  2. 

  3. <head>

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

  5. <title>Ant</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>James Duncan Davison (<a href="mailto:duncan@x180.com">duncan@x180.com</a>)</li>

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

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

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

  18. </ul>

  19. 

  20. <p>Version 1.0.8 - 2000/03/04</p>

  21. 

  22. <hr>

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

  24. <ul>

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

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

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

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

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

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

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

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

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

  34.   <li><a href="#license">License</a></li>

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

  36. </ul>

  37. <hr>

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

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

  40. makes wrinkles.</p>

  41. <h3>Why?</h3>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  59. Task interface.</p>

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

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

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

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

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

  65. on.</p>

  66. <hr>

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

  68. <h3>Binary edition</h3>

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

  70. href="http://jakarta.apache.org/builds/tomcat/release/v3.0/ant.zip">http://jakarta.apache.org/builds/tomcat/release/v3.0/ant.zip</a>.

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

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

  73. <h3>Source edition</h3>

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

  75. href="http://jakarta.apache.org/builds/tomcat/release/v3.0/src/jakarta-tools.src.zip">http://jakarta.apache.org/builds/tomcat/release/v3.0/src/jakarta-tools.src.zip</a>

  76. (latest stable) or from <a

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

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

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

  80. <hr>

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

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

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

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

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

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

  87. <blockquote>

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

  89. </blockquote>

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

  91. <blockquote>

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

  93. </blockquote>

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

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

  96. <hr>

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

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

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

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

  101. <ul>

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

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

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

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

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

  107. </ul>

  108. <h3>Windows</h3>

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

  110. environment:</p>

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

  112. set JAVA_HOME=c:\jdk1.2.2

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

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

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

  116. the environment:</p>

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

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

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

  120. <h3>Advanced</h3>

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

  122. least the following:</p>

  123. <p>The classpath for Ant must contain <code>ant.jar</code> and <code>xml.jar</code>.</p>

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

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

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

  127. must be added.</p>

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

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

  130. must be set to the directory containing a bin directory, which contains the <code>antRun</code> shell script necessary to run execs on Unix.</p>

  131. <hr>

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

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

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

  135. <p>When nothing is specified, Ant looks for a <code>build.xml</code> file in the

  136. current directory. When found, it uses that file as a buildfile. To make Ant use

  137. another buildfile, use the commandline option <i>-buildfile &lt;file&gt;</i>,

  138. where <i>&lt;file&gt;</i> is the buildfile you want to use.</p>

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

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

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

  142. the value.</p>

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

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

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

  146. <p>It is also possible to specify the target that should be executed. Default

  147. the target that is mentioned in the <i>default</i> attribute of the project is

  148. used. This can be overridden by adding the target name to the end of the

  149. commandline.</p>

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

  151. <pre>ant [options] [target]

  152. Options:

  153. -help                  print this message

  154. -quiet                 be extra quiet

  155. -verbose               be extra verbose

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

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

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

  159. <h3>Examples</h3>

  160. <blockquote>

  161.   <pre>ant</pre>

  162. </blockquote>

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

  164. the default target.</p>

  165. <blockquote>

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

  167. </blockquote>

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

  169. the default target.</p>

  170. <blockquote>

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

  172. </blockquote>

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

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

  175. <blockquote>

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

  177. </blockquote>

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

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

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

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

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

  183. with:</p>

  184. <blockquote>

  185.   <pre>set CLASSPATH=c:\ant\lib\ant.jar;c:\ant\lib\xml.jar;c:\jdk1.2.2\lib\tools.jar

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

  187. </blockquote>

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

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

  190. command.</p>

  191. <hr>

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

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

  194. <h3>Projects</h3>

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

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

  197.   <tr>

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

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

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

  201.   </tr>

  202.   <tr>

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

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

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

  206.   </tr>

  207.   <tr>

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

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

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

  211.   </tr>

  212.   <tr>

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

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

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

  216.       property on forehand. When this is done, it might be ommitted in the

  217.       project tag.</td>

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

  219.   </tr>

  220. </table>

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

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

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

  224. <h3>Targets</h3>

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

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

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

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

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

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

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

  232. <blockquote>

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

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

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

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

  237. </blockquote>

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

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

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

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

  242. the previous example).</p>

  243. <p>A target has also the ability to perform its execution if a property has been

  244. set. This allows, for example, better control on the building process depending

  245. on the state of the system (java version, OS, command line properties, etc...).

  246. To make target <i>sense</i> this property you should add the <i>if</i> attribute

  247. with the name of the property that the target should react to, for example</p>

  248. <blockquote>

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

  250. </blockquote>

  251. <p>If no <i>if</i> attribute is present, the target will always be executed.</p>

  252. <p>It is a good practice to place your <a href="#property">property</a> and <a

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

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

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

  256. have the name "init".</p>

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

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

  259.   <tr>

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

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

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

  263.   </tr>

  264.   <tr>

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

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

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

  268.   </tr>

  269.   <tr>

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

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

  272.       target depends.</td>

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

  274.   </tr>

  275.   <tr>

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

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

  278.       target to execute.</td>

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

  280.   </tr>

  281. </table>

  282. <h3>Tasks</h3>

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

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

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

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

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

  288. <blockquote>

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

  290. </blockquote>

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

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

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

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

  295. <h3>Properties</h3>

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

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

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

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

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

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

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

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

  304. <h3>Token Filters</h3>

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

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

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

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

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

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

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

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

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

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

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

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

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

  318. <h3>Examples</h3>

  319. <blockquote>

  320.   <pre>&lt;project name=&quot;foo&quot; default=&quot;dist&quot; basedir=&quot;.&quot;&gt;

  321.   &lt;target name=&quot;init&quot;&gt;

  322.     &lt;tstamp/&gt;

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

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

  325.     &lt;filter token=&quot;version&quot; value=&quot;1.0.3&quot; /&gt;

  326.     &lt;filter token=&quot;year&quot; value=&quot;2000&quot; /&gt;

  327.   &lt;/target&gt;

  328. 

  329.   &lt;target name=&quot;prepare&quot; depends=&quot;init&quot;&gt;

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

  331.   &lt;/target&gt;

  332. 

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

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

  335.   &lt;/target&gt;

  336. 

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

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

  339.     &lt;jar jarfile=&quot;${dist}/lib/foo${DSTAMP}.jar&quot;

  340.      basedir=&quot;${build}&quot; items=&quot;com&quot;/&gt;

  341.   &lt;/target&gt;

  342. 

  343.   &lt;target name=&quot;clean&quot; depends=&quot;init&quot;&gt;

  344.     &lt;deltree dir=&quot;${build}&quot; /&gt;

  345.     &lt;deltree dir=&quot;${dist}&quot; /&gt;

  346.   &lt;/target&gt;

  347. &lt;/project&gt;

  348. </pre>

  349. </blockquote>

  350. <hr>

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

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

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

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

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

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

  357. time:</p>

  358. <ul>

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

  360.     patterns</li>

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

  362.     patterns</li>

  363. </ul>

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

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

  366. <h3>Patterns</h3>

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

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

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

  370. <p>Examples:</p>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  391. <p>Examples:</p>

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

  393.   <tr>

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

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

  396.       anywhere in the directory tree.

  397.       <p>Matches:</p>

  398.       <p>CVS/Repository<br>

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

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

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

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

  403.   </tr>

  404.   <tr>

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

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

  407.       <p>Matches:</p>

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

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

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

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

  412.   </tr>

  413.   <tr>

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

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

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

  417.       <p>Matches:</p>

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

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

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

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

  422.   </tr>

  423.   <tr>

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

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

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

  427.   </tr>

  428. </table>

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

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

  431. <h3>Examples</h3>

  432. <pre>  &lt;copydir src=&quot;${src}&quot;

  433.            dest=&quot;${dist}&quot;

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

  435.            excludes=&quot;**/*.gif&quot; /&gt;</pre>

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

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

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

  439. <hr>

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

  441. <ul>

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

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

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

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

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

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

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

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

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

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

  452.   <li><a href="#expand">Expand</a></li>

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

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

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

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

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

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

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

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

  461.   <li><a href="#keysubst">KeySubst</a></li>

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

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

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

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

  466.   <li><a href="#tar">Tar</a></li>

  467.   <li><a href="#taskdef">Taskdef</a></li>

  468.   <li><a href="#tstamp">Tstamp</a></li>

  469.   <li><a href="#zip">Zip</a></li>

  470. </ul>

  471. <hr>

  472. <h2><a name="ant">Ant</a></h2>

  473. <h3><b>Description:</b></h3>

  474. <p>Runs Ant on a supplied buildfile. This can be used to build subprojects.</p>

  475. <p>When the <i>antfile</i> attribute is omitted, the file &quot;build.xml&quot;

  476. in the supplied directory (<i>dir</i> attribute) is used.</p>

  477. <p>If no target attribute is supplied, the default target of the new project is

  478. used.</p>

  479. <p>The properties of the current project will be available in the new project.

  480. These properties will override the properties that are set in the new project.

  481. (See also the <a href="#property">properties task</a>).</p>

  482. <h3>Parameters:</h3>

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

  484.   <tr>

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

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

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

  488.   </tr>

  489.   <tr>

  490.     <td valign="top">antfile</td>

  491.     <td valign="top">the buildfile to use.</td>

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

  493.   </tr>

  494.   <tr>

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

  496.     <td valign="top">the directory to use as a basedir for the new Ant project.</td>

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

  498.   </tr>

  499.   <tr>

  500.     <td valign="top">target</td>

  501.     <td valign="top">the target of the new Ant project that should be executed.</td>

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

  503.   </tr>

  504. </table>

  505. <h3>Examples</h3>

  506. <blockquote>

  507.   <p><code>&lt;ant antfile=&quot;subproject/subbuild.xml&quot; dir=&quot;subproject&quot;

  508.   target=&quot;compile&quot; /&gt;</code></p>

  509.   <p><code>&lt;ant dir=&quot;subproject&quot; /&gt;</code></p>

  510. </blockquote>

  511. <hr>

  512. <h2><a name="available">Available</a></h2>

  513. <h3>Description</h3>

  514. <p>Sets a property is a resource is available at runtime. This resource can be a

  515. file resource, a class in classpath or a JVM system resource.</p>

  516. <p>The value part of the properties being set is <i>true</i> if the resource is

  517. present, otherwise, the property is not set.</p>

  518. <p>Normally, this task is used to set properties that are useful to avoid target

  519. execution depending on system parameters.</p>

  520. <h3>Parameters</h3>

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

  522.   <tr>

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

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

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

  526.   </tr>

  527.   <tr>

  528.     <td valign="top">property</td>

  529.     <td valign="top">the name of the property to set.</td>

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

  531.   </tr>

  532.   <tr>

  533.     <td valign="top">class</td>

  534.     <td valign="top">the class to look for in classpath.</td>

  535.     <td valign="middle" align="center" rowspan="3">Yes</td>

  536.   </tr>

  537.   <tr>

  538.     <td valign="top">resource</td>

  539.     <td valign="top">the resource to look for in the JVM</td>

  540.   </tr>

  541.   <tr>

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

  543.     <td valign="top">the file to look for.</td>

  544.   </tr>

  545. </table>

  546. <h3>Examples</h3>

  547. <pre>  &lt;available classname=&quot;org.whatever.Myclass&quot; property=&quot;Myclass.present&quot; /&gt;</pre>

  548. <p>sets the property <code><i>Myclass.present</i></code> to the value &quot;true&quot;

  549. if the <i>org.whatever.Myclass</i> is found in Ant's classpath.</p>

  550. <hr>

  551. <h2><a name="chmod">Chmod</a></h2>

  552. <h3>Description</h3>

  553. <p>Changes the permissions of a file. Right now it has efect only under Unix.

  554. The permissions are also UNIX style, like the argument for the chmod command.</p>

  555. <h3>Parameters</h3>

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

  557.   <tr>

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

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

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

  561.   </tr>

  562.   <tr>

  563.     <td valign="top">src</td>

  564.     <td valign="top">the file of which the permissions must be changed.</td>

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

  566.   </tr>

  567.   <tr>

  568.     <td valign="top">perm</td>

  569.     <td valign="top">the new permissions.</td>

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

  571.   </tr>

  572. </table>

  573. <h3>Examples</h3>

  574. <blockquote>

  575.   <p><code>&lt;chmod src=&quot;${dist}/start.sh&quot; perm=&quot;ugo+rx&quot;

  576.   /&gt;</code></p>

  577. </blockquote>

  578. <p>makes the &quot;start.sh&quot; file readable and executable for anyone on a

  579. UNIX system.</p>

  580. <hr>

  581. <h2><a name="copydir">Copydir</a></h2>

  582. <h3>Description</h3>

  583. <p>Copies a directory tree from the source to the destination.</p>

  584. <p>It is possible to refine the set of files that are being copied. This can be

  585. done with the <i>includes</i>, <i>excludes</i> and <i>defaultexcludes</i>

  586. attributes. With the <i>includes</i> attribute you specify the files you want to

  587. have included by using patterns. The <i>exclude</i> attribute is used to specify

  588. the files you want to have excluded. This is also done with patterns. And

  589. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  590. want to use default exclusions or not. See the section on <a

  591. href="#directorybasedtasks">directory based tasks</a>, on how the

  592. inclusion/exclusion of files works, and how to write patterns. The patterns are

  593. relative to the <i>src</i> directory.</p>

  594. <p>The <i>ignore</i> attribute contains the names of the files/directories that

  595. must be excluded from the copy. The names specified in the <i>ignore</i>

  596. attribute are just names, they do not contain any path information! Note that

  597. this attribute has been replaced by the <i>excludes</i> attribute.</p>

  598. <h3>Parameters</h3>

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

  600.   <tr>

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

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

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

  604.   </tr>

  605.   <tr>

  606.     <td valign="top">src</td>

  607.     <td valign="top">the directory to copy.</td>

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

  609.   </tr>

  610.   <tr>

  611.     <td valign="top">dest</td>

  612.     <td valign="top">the directory to copy to.</td>

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

  614.   </tr>

  615.   <tr>

  616.     <td valign="top">ignore</td>

  617.     <td valign="top">comma separated list of filenames/directorynames to ignore.

  618.       No files (except default excludes) are excluded when omitted. (<b>deprecated</b>,

  619.       use <i>excludes</i> instead).</td>

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

  621.   </tr>

  622.   <tr>

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

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

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

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

  627.   </tr>

  628.   <tr>

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

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

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

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

  633.   </tr>

  634.   <tr>

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

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

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

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

  639.   </tr>

  640.   <tr>

  641.     <td valign="top">filtering</td>

  642.     <td valign="top">indicates whether token filtering should take place during

  643.       the copy</td>

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

  645.   </tr>

  646. </table>

  647. <h3>Examples</h3>

  648. <pre>  &lt;copydir src=&quot;${src}/resources&quot;

  649.            dest=&quot;${dist}&quot;

  650.   /&gt;</pre>

  651. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>.</p>

  652. <pre>  &lt;copydir src=&quot;${src}/resources&quot;

  653.            dest=&quot;${dist}&quot;

  654.            includes=&quot;**/*.java&quot;

  655.            excludes=&quot;**/Test.java&quot;

  656.   /&gt;</pre>

  657. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>

  658. recursively. All java files are copied, except for files with the name <code>Test.java</code>.</p>

  659. <pre>  &lt;copydir src=&quot;${src}/resources&quot;

  660.            dest=&quot;${dist}&quot;

  661.            includes=&quot;**/*.java&quot;

  662.            excludes=&quot;mypackage/test/**&quot; /&gt;</pre>

  663. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>

  664. recursively. All java files are copied, except for the files under the <code>mypackage/test</code>

  665. directory.</p>

  666. <hr>

  667. <h2><a name="copyfile">Copyfile</a></h2>

  668. <h3>Description</h3>

  669. <p>Copies a file from the source to the destination. The file is only copied if

  670. the source file is newer than the destination file, or when the destination file

  671. does not exist.</p>

  672. <h3>Parameters</h3>

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

  674.   <tr>

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

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

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

  678.   </tr>

  679.   <tr>

  680.     <td valign="top">src</td>

  681.     <td valign="top">the filename of the file to copy.</td>

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

  683.   </tr>

  684.   <tr>

  685.     <td valign="top">dest</td>

  686.     <td valign="top">the filename of the file where to copy to.</td>

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

  688.   </tr>

  689.   <tr>

  690.     <td valign="top">filtering</td>

  691.     <td valign="top">indicates whether token filtering should take place during

  692.       the copy</td>

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

  694.   </tr>

  695. </table>

  696. <h3>Examples</h3>

  697. <blockquote>

  698.   <p><code>&lt;copyfile src=&quot;test.java&quot; dest=&quot;subdir/test.java&quot;

  699.   /&gt;</code></p>

  700.   <p><code>&lt;copyfile src=&quot;${src}/index.html&quot; dest=&quot;${dist}/help/index.html&quot;

  701.   /&gt;</code></p>

  702. </blockquote>

  703. <hr>

  704. <h2><a name="cvs">Cvs</a></h2>

  705. <h3>Description</h3>

  706. <p>Checks out a package/module from a <a href="http://www.cyclic.com/">CVS</a>

  707. repository.</p>

  708. <p>When doing automated builds, the <a href="#get">get task</a> should be

  709. preferred, because of speed.</p>

  710. <h3>Parameters</h3>

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

  712.   <tr>

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

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

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

  716.   </tr>

  717.   <tr>

  718.     <td valign="top">cvsRoot</td>

  719.     <td valign="top">the CVSROOT variable.</td>

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

  721.   </tr>

  722.   <tr>

  723.     <td valign="top">dest</td>

  724.     <td valign="top">the directory where the checked out files should be placed.</td>

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

  726.   </tr>

  727.   <tr>

  728.     <td valign="top">package</td>

  729.     <td valign="top">the package/module to check out.</td>

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

  731.   </tr>

  732.   <tr>

  733.     <td valign="top">tag</td>

  734.     <td valign="top">the tag of the package/module to check out.</td>

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

  736.   </tr>

  737. </table>

  738. <h3>Examples</h3>

  739. <pre>  &lt;cvs cvsRoot=&quot;:pserver:anoncvs@jakarta.apache.org:/home/cvspublic&quot;

  740.        package=&quot;jakarta-tools&quot;

  741.        dest=&quot;${ws.dir}&quot;

  742.   /&gt;</pre>

  743. <p>checks out the package/module &quot;jakarta-tools&quot; from the CVS

  744. repository pointed to by the cvsRoot attribute, and stores the files in &quot;${ws.dir}&quot;.</p>

  745. <hr>

  746. <h2><a name="delete">Delete</a></h2>

  747. <h3>Description</h3>

  748. <p>Deletes a single file.</p>

  749. <h3>Parameters</h3>

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

  751.   <tr>

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

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

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

  755.   </tr>

  756.   <tr>

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

  758.     <td valign="top">the file to delete.</td>

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

  760.   </tr>

  761. </table>

  762. <h3>Examples</h3>

  763. <pre>  &lt;delete file=&quot;/lib/ant.jar&quot; /&gt;</pre>

  764. <p>deletes the file <code>/lib/ant.jar</code>.</p>

  765. <pre>  &lt;delete file=&quot;${ant}&quot; /&gt;</pre>

  766. <p>deletes the file <code>${ant}</code>.</p>

  767. <hr>

  768. <h2><a name="deltree">Deltree</a></h2>

  769. <h3>Description</h3>

  770. <p>Deletes a directory with all its files and subdirectories.</p>

  771. <h3>Parameters</h3>

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

  773.   <tr>

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

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

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

  777.   </tr>

  778.   <tr>

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

  780.     <td valign="top">the directory to delete.</td>

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

  782.   </tr>

  783. </table>

  784. <h3>Examples</h3>

  785. <pre>  &lt;deltree dir=&quot;dist&quot; /&gt;</pre>

  786. <p>deletes the directory <code>dist</code>, including its files and

  787. subdirectories.</p>

  788. <pre>  &lt;deltree dir=&quot;${dist}&quot; /&gt;</pre>

  789. <p>deletes the directory <code>${dist}</code>, including its files and

  790. subdirectories.</p>

  791. <hr>

  792. <h2><a name="echo">Echo</a></h2>

  793. <h3>Description</h3>

  794. <p>Echoes a message to System.out.</p>

  795. <h3>Parameters</h3>

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

  797.   <tr>

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

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

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

  801.   </tr>

  802.   <tr>

  803.     <td valign="top">message</td>

  804.     <td valign="top">the message to echo.</td>

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

  806.   </tr>

  807. </table>

  808. <h3>Examples</h3>

  809. <pre>  &lt;echo message=&quot;Hello world&quot; /&gt;</pre>

  810. <hr>

  811. <h2><a name="exec">Exec</a></h2>

  812. <h3>Description</h3>

  813. <p>Executes a system command. When the <i>os</i> attribute is specified, then

  814. the command is only executed when Ant is run on one of the specified operating

  815. systems.</p>

  816. <h3>Parameters</h3>

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

  818.   <tr>

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

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

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

  822.   </tr>

  823.   <tr>

  824.     <td valign="top">command</td>

  825.     <td valign="top">the command to execute.</td>

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

  827.   </tr>

  828.   <tr>

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

  830.     <td valign="top">the directory in which the command should be executed.</td>

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

  832.   </tr>

  833.   <tr>

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

  835.     <td valign="top">list of Operating Systems on which the command may be

  836.       executed.</td>

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

  838.   </tr>

  839.   <tr>

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

  841.     <td valign="top">the file to which the output of the command should be

  842.       redirected.</td>

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

  844.   </tr>

  845. </table>

  846. <h3>Examples</h3>

  847. <blockquote>

  848.   <p><code>&lt;exec dir=&quot;${src}&quot; command=&quot;dir&quot; os=&quot;windows&quot;

  849.   output=&quot;dir.txt&quot; /&gt;</code></p>

  850. </blockquote>

  851. <hr>

  852. <h2><a name="expand">Expand</a></h2>

  853. <h3>Description</h3>

  854. <p>Unzips a zipfile.</p>

  855. <h3>Parameters</h3>

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

  857.   <tr>

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

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

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

  861.   </tr>

  862.   <tr>

  863.     <td valign="top">src</td>

  864.     <td valign="top">zipfile to expand.</td>

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

  866.   </tr>

  867.   <tr>

  868.     <td valign="top">dest</td>

  869.     <td valign="top">directory where to store the expanded files.</td>

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

  871.   </tr>

  872. </table>

  873. <h3>Examples</h3>

  874. <blockquote>

  875.   <p><code>&lt;expand src=&quot;${tomcat_src}/tools-src.zip&quot; dest=&quot;${tools.home}&quot;

  876.   /&gt;</code></p>

  877. </blockquote>

  878. <hr>

  879. <h2><a name="filter">Filter</a></h2>

  880. <h3>Description</h3>

  881. <p>Sets a token filter for this project. Token filters are used by all tasks

  882. that perform file copying operations through the Project commodity methods.</p>

  883. <p>Note: the token string must not contain the separators chars (@).</p>

  884. <h3>Parameters</h3>

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

  886.   <tr>

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

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

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

  890.   </tr>

  891.   <tr>

  892.     <td valign="top">token</td>

  893.     <td valign="top">the token string without @</td>

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

  895.   </tr>

  896.   <tr>

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

  898.     <td valign="top">the string that should be put to replace the token when the

  899.       file is copied</td>

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

  901.   </tr>

  902. </table>

  903. <h3>Examples</h3>

  904. <pre>  &lt;filter token=&quot;year&quot; value=&quot;2000&quot; /&gt;

  905.   &lt;copydir src=&quot;${src.dir}&quot; dest=&quot;${dest.dir}&quot;/&gt;</pre>

  906. <p>will copy recursively all the files from the <i>src.dir</i> directory into

  907. the <i>dest.dir</i> directory replacing all the occurencies of the string <i>@year@</i>

  908. with <i>2000.</i></p>

  909. <hr>

  910. <h2><a name="get">Get</a></h2>

  911. <h3>Description</h3>

  912. <p>Gets a file from an URL. When the verbose option is &quot;on&quot;, this task

  913. displays a '.' for every 100 Kb retrieved.</p>

  914. <p>This task should be preferred above the <a href="#cvs">CVS task</a> when

  915. doing automated builds. CVS is significant slower than loading a compressed

  916. archive with http/ftp.</p>

  917. <h3>Parameters</h3>

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

  919.   <tr>

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

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

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

  923.   </tr>

  924.   <tr>

  925.     <td valign="top">src</td>

  926.     <td valign="top">the URL from which to retrieve a file.</td>

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

  928.   </tr>

  929.   <tr>

  930.     <td valign="top">dest</td>

  931.     <td valign="top">the file where to store the retrieved file.</td>

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

  933.   </tr>

  934.   <tr>

  935.     <td valign="top">verbose</td>

  936.     <td valign="top">show verbose information (&quot;on&quot;/&quot;off&quot;).</td>

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

  938.   </tr>

  939. </table>

  940. <h3>Examples</h3>

  941. <pre>  &lt;get src=&quot;http://jakarta.apache.org/&quot; dest=&quot;help/index.html&quot; /&gt;</pre>

  942. <p>gets the index page of http://jakarta.apache.org/, and stores it in the file <code>help/index.html</code>.</p>

  943. <hr>

  944. <h2><a name="gzip">GZip</a></h2>

  945. <h3>Description</h3>

  946. <p>GZips a file.</p>

  947. <h3>Parameters</h3>

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

  949.   <tr>

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

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

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

  953.   </tr>

  954.   <tr>

  955.     <td valign="top">src</td>

  956.     <td valign="top">the file to gzip.</td>

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

  958.   </tr>

  959.   <tr>

  960.     <td valign="top">zipfile</td>

  961.     <td valign="top">the destination file.</td>

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

  963.   </tr>

  964. </table>

  965. <h3>Examples</h3>

  966. <blockquote>

  967.   <p><code>&lt;gzip src=&quot;test.tar&quot; zipfile=&quot;test.tar.gz&quot;

  968.   /&gt;</code></p>

  969. </blockquote>

  970. <hr>

  971. <h2><a name="fixcrlf">FixCRLF</a></h2>

  972. <h3>Description</h3>

  973. <p>Adjusts a text file to local.</p>

  974. <p>The <i>basedir</i> attribute is the reference directory from where to jar.</p>

  975. <h3>Parameters</h3>

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

  977.   <tr>

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

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

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

  981.   </tr>

  982.   <tr>

  983.     <td valign="top">srcDir</td>

  984.     <td valign="top">Where to find the files to be fixed up.</td>

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

  986.   </tr>

  987.   <tr>

  988.     <td valign="top">destDir</td>

  989.     <td valign="top">Where to place the corrected files.  Defaults to

  990.       srcDir (replacing the original file)</td>

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

  992.   </tr>

  993.   <tr>

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

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

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

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

  998.   </tr>

  999.   <tr>

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

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

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

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

  1004.   </tr>

  1005.   <tr>

  1006.     <td valign="top">cr</td>

  1007.     <td valign="top">Specifies how carriage return (CR) characters are to

  1008.       be handled.  Valid values for this property are:

  1009.       <ul>

  1010.       <li>add: ensure that there is a CR before every LF

  1011.       <li>asis: leave CR characters alone

  1012.       <li>remove: remove all CR characters

  1013.       </ul>

  1014.       Default is based on the platform on which you are running this task.

  1015.       For Unix platforms, the default is remove.  For DOS based systems

  1016.       (including Windows), the default is add.

  1017.       <p>

  1018.       Note: Unless this property is specified as "asis", extra CR characters

  1019.       which do not preceed a LF will be removed.

  1020.       </td>

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

  1022.   </tr>

  1023.   <tr>

  1024.     <td valign="top">tab</td>

  1025.     <td valign="top">Specifies how tab characters are to be handled.  Valid

  1026.       values for this property are:

  1027.       <ul>

  1028.       <li>add: convert sequences of spaces which span a tab stop to tabs

  1029.       <li>asis: leave tab and space characters alone

  1030.       <li>remove: convert tabs to spaces

  1031.       </ul>

  1032.       Default for this parameter is "asis".

  1033.       <p>

  1034.       Note: Unless this property is specified as "asis", extra spaces and

  1035.       tabs after the last non-whitespace character on the line will be removed.

  1036.       </td>

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

  1038.   </tr>

  1039.   <tr>

  1040.     <td valign="top">eof</td>

  1041.     <td valign="top">Specifies how DOS end of file (control-Z) characters are

  1042.       to be handled.  Valid values for this property are:

  1043.       <ul>

  1044.       <li>add: ensure that there is an EOF character at the end of the file

  1045.       <li>asis: leave EOF characters alone

  1046.       <li>remove: remove any EOF character found at the end

  1047.       </ul>

  1048.       Default is based on the platform on which you are running this task.

  1049.       For Unix platforms, the default is remove.  For DOS based systems

  1050.       (including Windows), the default is asis.

  1051.       </td>

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

  1053.   </tr>

  1054. </table>

  1055. <h3>Examples</h3>

  1056. <pre>  &lt;fixcrlf srcdir=&quot;${src}&quot;

  1057.        cr=&quot;remove&quot; eof=&quot;remove&quot;

  1058.        includes=&quot;**/*.sh&quot;

  1059.   /&gt;</pre>

  1060. <p>Removes carriage return and eof characters from the shell scripts.  Tabs and

  1061. spaces are left as is.

  1062. <pre>  &lt;fixcrlf srcdir=&quot;${src}&quot;

  1063.        cr=&quot;add&quot;

  1064.        includes=&quot;**/*.bat&quot;

  1065.   /&gt;</pre>

  1066. <p>Ensures that there are carriage return characters prior to evey line feed.

  1067. Tabs and spaces are left as is.

  1068. EOF characters are left alone if run on

  1069. DOS systems, and are removed if run on Unix systems.</p>

  1070. <pre>  &lt;fixcrlf srcdir=&quot;${src}&quot;

  1071.        tabs=&quot;add&quot;

  1072.        includes=&quot;**/Makefile&quot;

  1073.   /&gt;</pre>

  1074. <p>Adds or removes CR characters to match local OS conventions, and

  1075. converts spaces to tabs when appropriate.  EOF characters are left alone if

  1076. run on DOS systems, and are removed if run on Unix systems.

  1077. Many versions of make require tabs prior to commands.</p>

  1078. <pre>  &lt;fixcrlf srcdir=&quot;${src}&quot;

  1079.        tabs=&quot;remove&quot;

  1080.        includes=&quot;**/README*&quot;

  1081.   /&gt;</pre>

  1082. <p>Adds or removes CR characters to match local OS conventions, and

  1083. converts all tabs to spaces.  EOF characters are left alone if run on

  1084. DOS systems, and are removed if run on Unix systems.

  1085. You never know what editor a user will use to browse README's.</p>

  1086. <hr>

  1087. <h2><a name="jar">Jar</a></h2>

  1088. <h3>Description</h3>

  1089. <p>Jars a set of files.</p>

  1090. <p>The <i>basedir</i> attribute is the reference directory from where to jar.</p>

  1091. <p>It is possible to refine the set of files that are being jarred. This can be

  1092. done with the <i>includes</i>, <i>excludes</i> and <i>defaultexcludes</i>

  1093. attributes. With the <i>includes</i> attribute you specify the files you want to

  1094. have included by using patterns. The <i>exclude</i> attribute is used to specify

  1095. the files you want to have excluded. This is also done with patterns. And

  1096. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  1097. want to use default exclusions or not. See the section on <a

  1098. href="#directorybasedtasks">directory based tasks</a>, on how the

  1099. inclusion/exclusion of files works, and how to write patterns. The patterns are

  1100. relative to the <i>basedir</i> directory.</p>

  1101. <p>The <i>includes</i>, <i>excludes</i> and <i>defaultexcludes</i> attributes

  1102. replace the <i>items</i> and <i>ignore</i> attributes. The following explains

  1103. how the deprecated <i>items</i> and <i>ignore</i> attribute behave.</p>

  1104. <p>When &quot;*&quot; is used for <i>items</i>, all files in the basedir, and

  1105. its subdirectories, will be jarred. Otherwise all the files and directories

  1106. mentioned in the items list will jarred. When a directory is specified, then all

  1107. files within it are also jarred.</p>

  1108. <p>With the <i>ignore</i> attribute, you can specify files or directories to

  1109. ignore. These files will not be jarred. The items in the <i>ignore</i> attribute

  1110. override the items in the <i>items</i> attribute. The names specified in the <i>ignore</i>

  1111. attribute are just names, they do not contain any path information!</p>

  1112. <h3>Parameters</h3>

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

  1114.   <tr>

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

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

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

  1118.   </tr>

  1119.   <tr>

  1120.     <td valign="top">jarfile</td>

  1121.     <td valign="top">the jar-file to create.</td>

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

  1123.   </tr>

  1124.   <tr>

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

  1126.     <td valign="top">the directory from which to jar the files.</td>

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

  1128.   </tr>

  1129.   <tr>

  1130.     <td valign="top">items</td>

  1131.     <td valign="top">a comma separated list of the files/directories to jar. All

  1132.       files are included when omitted. (<b>deprecated</b>, use <i>includes</i>

  1133.       instead).</td>

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

  1135.   </tr>

  1136.   <tr>

  1137.     <td valign="top">ignore</td>

  1138.     <td valign="top">comma separated list of filenames/directorynames to exclude

  1139.       from the jar. No files (except default excludes) are excluded when

  1140.       omitted. (<b>deprecated</b>, use <i>excludes</i> instead).</td>

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

  1142.   </tr>

  1143.   <tr>

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

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

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

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

  1148.   </tr>

  1149.   <tr>

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

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

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

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

  1154.   </tr>

  1155.   <tr>

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

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

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

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

  1160.   </tr>

  1161.   <tr>

  1162.     <td valign="top">manifest</td>

  1163.     <td valign="top">the manifest file to use.</td>

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

  1165.   </tr>

  1166. </table>

  1167. <h3>Examples</h3>

  1168. <pre>  &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot; basedir=&quot;${build}/classes&quot; /&gt;</pre>

  1169. <p>jars all files in the <code>${build}/classes</code> directory in a file

  1170. called <code>app.jar</code> in the <code>${dist}/lib</code> directory.</p>

  1171. <pre>  &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot;

  1172.        basedir=&quot;${build}/classes&quot;

  1173.        excludes=&quot;**/Test.class&quot;

  1174.   /&gt;</pre>

  1175. <p>jars all files in the <code>${build}/classes</code> directory in a file

  1176. called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Files

  1177. with the name <code>Test.class</code> are excluded.</p>

  1178. <pre>  &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot;

  1179.        basedir=&quot;${build}/classes&quot;

  1180.        includes=&quot;mypackage/test/**&quot;

  1181.        excludes=&quot;**/Test.class&quot;

  1182.   /&gt;</pre>

  1183. <p>jars all files in the <code>${build}/classes</code> directory in a file

  1184. called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Only

  1185. files under the directory <code>mypackage/test</code> are used, and files with

  1186. the name <code>Test.class</code> are excluded.</p>

  1187. <h3>Deprecated examples</h3>

  1188. <pre>  &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot; basedir=&quot;${build}/classes&quot; items=&quot;*&quot; /&gt;</pre>

  1189. <p>jars all files in the <code>${build}/classes</code> directory in a file

  1190. called <code>app.jar</code> in the <code>${dist}/lib</code> directory.</p>

  1191. <pre>  &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot; basedir=&quot;${build}/classes&quot; items=&quot;*&quot; ignore=&quot;Test.class&quot; /&gt;</pre>

  1192. <p>jars all files in the <code>${build}/classes</code> directory in a file

  1193. called <code>app.jar</code> in the <code>${dist}/lib</code> directory.

  1194. Files/directories with the name <code>Test.class</code> are excluded.</p>

  1195. <hr>

  1196. <h2><a name="java">Java</a></h2>

  1197. <h3>Description</h3>

  1198. <p>Executes a Java class within the running (Ant) VM or forks another VM if

  1199. specified.</p>

  1200. <p>Be careful that the executed class doesn't call System.exit(), because it

  1201. will terminate the VM and thus Ant. In case this happens, it's highly suggested

  1202. that you set the fork attribute so that System.exit() stops the other VM and not

  1203. the one that is currently running Ant.</p>

  1204. <h3>Parameters</h3>

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

  1206.   <tr>

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

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

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

  1210.   </tr>

  1211.   <tr>

  1212.     <td valign="top">class</td>

  1213.     <td valign="top">the Java class to execute.</td>

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

  1215.   </tr>

  1216.   <tr>

  1217.     <td valign="top">args</td>

  1218.     <td valign="top">the arguments for the class that is executed.</td>

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

  1220.   </tr>

  1221.   <tr>

  1222.     <td valign="top">fork</td>

  1223.     <td valign="top">if enabled triggers the class execution in another VM

  1224.       (disabled by default)</td>

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

  1226.   </tr>

  1227.   <tr>

  1228.     <td valign="top">jvmargs</td>

  1229.     <td valign="top">the arguments to pass to the forked VM (ignored if fork is

  1230.       disabled)</td>

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

  1232.   </tr>

  1233. </table>

  1234. <h3>Examples</h3>

  1235. <pre>  &lt;java classname=&quot;test.Main&quot; /&gt;</pre>

  1236. <pre>  &lt;java classname=&quot;test.Main&quot; args=&quot;-h&quot; /&gt;</pre>

  1237. <pre>  &lt;java classname=&quot;test.Main&quot;

  1238.         args=&quot;-h&quot;

  1239.         fork=&quot;yes&quot;

  1240.         jvmargs=&quot;-Xrunhprof:cpu=samples,file=log.txt,depth=3&quot;

  1241.   /&gt;</pre>

  1242. <hr>

  1243. <h2><a name="javac">Javac</a></h2>

  1244. <h3>Description</h3>

  1245. <p>Compiles a source tree within the running (Ant) VM.</p>

  1246. <p>The source and destination directory will be recursively scanned for Java

  1247. source files to compile. Only Java files that have no corresponding class file

  1248. or where the class file is older than the java file will be compiled.</p>

  1249. <p>Files in the source tree, that are no java files, are copied to the

  1250. destination directory, allowing support files to be located properly in the

  1251. classpath.</p>

  1252. <p>The directory structure of the source tree should follow the package

  1253. hierarchy.</p>

  1254. <p>It is possible to refine the set of files that are being compiled/copied.

  1255. This can be done with the <i>includes</i>, <i>excludes</i> and <i>defaultexcludes</i>

  1256. attributes. With the <i>includes</i> attribute you specify the files you want to

  1257. have included by using patterns. The <i>exclude</i> attribute is used to specify

  1258. the files you want to have excluded. This is also done with patterns. And

  1259. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  1260. want to use default exclusions or not. See the section on <a

  1261. href="#directorybasedtasks">directory based tasks</a>, on how the

  1262. inclusion/exclusion of files works, and how to write patterns. The patterns are

  1263. relative to the <i>srcdir</i> directory.</p>

  1264. <p>It is possible to use different compilers. This can be selected with the

  1265. &quot;build.compiler&quot; property. There are three choices:</p>

  1266. <ul>

  1267.   <li>classic (the standard compiler of JDK 1.1/1.2)</li>

  1268.   <li>modern (the new compiler of JDK 1.3)</li>

  1269.   <li>jikes (the <a

  1270.     href="http://oss.software.ibm.com/developerworks/opensource/jikes/project">Jikes</a>

  1271.     compiler)</li>

  1272. </ul>

  1273. <p>For JDK 1.1/1.2 is classic the default. For JDK 1.3 is modern the default.</p>

  1274. <h3>Parameters</h3>

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

  1276.   <tr>

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

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

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

  1280.   </tr>

  1281.   <tr>

  1282.     <td valign="top">srcdir</td>

  1283.     <td valign="top">location of the java files.</td>

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

  1285.   </tr>

  1286.   <tr>

  1287.     <td valign="top">destdir</td>

  1288.     <td valign="top">location where to store the class files.</td>

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

  1290.   </tr>

  1291.   <tr>

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

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

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

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

  1296.   </tr>

  1297.   <tr>

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

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

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

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

  1302.   </tr>

  1303.   <tr>

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

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

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

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

  1308.   </tr>

  1309.   <tr>

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

  1311.     <td valign="top">the classpath to use.</td>

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

  1313.   </tr>

  1314.   <tr>

  1315.     <td valign="top">bootclasspath</td>

  1316.     <td valign="top">location of bootstrap class files.</td>

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

  1318.   </tr>

  1319.   <tr>

  1320.     <td valign="top">extdirs</td>

  1321.     <td valign="top">location of installed extensions.</td>

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

  1323.   </tr>

  1324.   <tr>

  1325.     <td valign="top">debug</td>

  1326.     <td valign="top">indicates whether there should be compiled with debug

  1327.       information (&quot;on&quot;).</td>

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

  1329.   </tr>

  1330.   <tr>

  1331.     <td valign="top">optimize</td>

  1332.     <td valign="top">indicates whether there should be compiled with

  1333.       optimization (&quot;on&quot;).</td>

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

  1335.   </tr>

  1336.   <tr>

  1337.     <td valign="top">deprecation</td>

  1338.     <td valign="top">indicates whether there should be compiled with deprecation

  1339.       information (&quot;on&quot;).</td>

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

  1341.   </tr>

  1342.   <tr>

  1343.     <td valign="top">filtering</td>

  1344.     <td valign="top">indicates whether token filtering should take place</td>

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

  1346.   </tr>

  1347. </table>

  1348. <h3>Examples</h3>

  1349. <pre>  &lt;javac srcdir=&quot;${src}&quot;

  1350.          destdir=&quot;${build}&quot;

  1351.          classpath=&quot;xyz.jar&quot;

  1352.          debug=&quot;on&quot;

  1353.   /&gt;</pre>

  1354. <p>compiles all .java files under the directory <code>${src}</code>, and stores

  1355. the .class files in the directory <code>${build}</code>. It also copies the non-java

  1356. files from the tree under <code>${src}</code> to the tree under <code>${build}</code>.

  1357. The classpath used contains <code>xyz.jar</code>, and debug information is on.</p>

  1358. <pre>  &lt;javac srcdir=&quot;${src}&quot;

  1359.          destdir=&quot;${build}&quot;

  1360.          includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;

  1361.          excludes=&quot;mypackage/p1/testpackage/**&quot;

  1362.          classpath=&quot;xyz.jar&quot;

  1363.          debug=&quot;on&quot;

  1364.   /&gt;</pre>

  1365. <p>compiles .java files under the directory <code>${src}</code>, and stores the

  1366. .class files in the directory <code>${build}</code>. It also copies the non-java

  1367. files from the tree under <code>${src}</code> to the tree under <code>${build}</code>.

  1368. The classpath used contains <code>xyz.jar</code>, and debug information is on.

  1369. Only files under <code>mypackage/p1</code> and <code>mypackage/p2</code> are

  1370. used. Files in the <code>mypackage/p1/testpackage</code> directory are excluded

  1371. form compilation and copy.</p>

  1372. <hr>

  1373. <h2><a name="javadoc">Javadoc/Javadoc2</a></h2>

  1374. <h3>Description</h3>

  1375. <p>Generates code documentation using the javadoc tool.</p>

  1376. <p>The source directory will be recursively scanned for Java source files to but

  1377. only those matching the inclusion rules will be passed to the javadoc tool. This

  1378. allows wildcards to be used to choose between package names, reducing verbosity

  1379. and management costs over time. This task, however, has no notion of

  1380. &quot;changed&quot; files, unlike the <a href="#javac">javac</a> task, but it's

  1381. not used so frequently.</p>

  1382. <p>This task works seamlessly between different javadoc versions (1.1 and 1.2),

  1383. with the obvious restriction that the 1.2 attributes will be ignored if run in a

  1384. 1.1 VM.</p>

  1385. <p>NOTE: since javadoc calls System.exit(), we cannot run javadoc inside the

  1386. same VM without breaking functionality. For this reason, this task always forks

  1387. the VM. But this is not a performance penalty since javadoc is normally a heavy

  1388. application and must be called just once.</p>

  1389. <p>DEPRECATION: the javadoc2 task simply points to the javadoc task and it's

  1390. there for back compatibility reasons. Since this task will be removed in future

  1391. versions, you are strongly encouraged to use <a href="#javadoc">javadoc</a>

  1392. instead.</p>

  1393. <h3>Parameters</h3>

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

  1395.   <tr>

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

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

  1398.     <td align="center" valign="top"><b>Availability</b></td>

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

  1400.   </tr>

  1401.   <tr>

  1402.     <td valign="top">sourcepath</td>

  1403.     <td valign="top">Specify where to find source files</td>

  1404.     <td align="center" valign="top">all</td>

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

  1406.   </tr>

  1407.   <tr>

  1408.     <td valign="top">destdir</td>

  1409.     <td valign="top">Destination directory for output files</td>

  1410.     <td align="center" valign="top">all</td>

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

  1412.   </tr>

  1413.   <tr>

  1414.     <td valign="top">sourcefiles</td>

  1415.     <td valign="top">Space separated list of source files</td>

  1416.     <td align="center" valign="top">all</td>

  1417.     <td align="center" valign="middle" rowspan="2">at least one of the two</td>

  1418.   </tr>

  1419.   <tr>

  1420.     <td valign="top">packagenames</td>

  1421.     <td valign="top">Space separated list of package files (with terminating

  1422.       wildcard)</td>

  1423.     <td align="center" valign="top">all</td>

  1424.   </tr>

  1425.   <tr>

  1426.     <td valign="top">Classpath</td>

  1427.     <td valign="top">Specify where to find user class files</td>

  1428.     <td align="center" valign="top">all</td>

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

  1430.   </tr>

  1431.   <tr>

  1432.     <td valign="top">Bootclasspath</td>

  1433.     <td valign="top">Override location of class files loaded by the bootstrap

  1434.       class loader</td>

  1435.     <td align="center" valign="top">1.2</td>

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

  1437.   </tr>

  1438.   <tr>

  1439.     <td valign="top">Extdirs</td>

  1440.     <td valign="top">Override location of installed extensions</td>

  1441.     <td align="center" valign="top">1.2</td>

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

  1443.   </tr>

  1444.   <tr>

  1445.     <td valign="top">Overview</td>

  1446.     <td valign="top">Read overview documentation from HTML file</td>

  1447.     <td align="center" valign="top">1.2</td>

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

  1449.   </tr>

  1450.   <tr>

  1451.     <td valign="top">Public</td>

  1452.     <td valign="top">Show only public classes and members</td>

  1453.     <td align="center" valign="top">all</td>

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

  1455.   </tr>

  1456.   <tr>

  1457.     <td valign="top">Protected</td>

  1458.     <td valign="top">Show protected/public classes and members (default)</td>

  1459.     <td align="center" valign="top">all</td>

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

  1461.   </tr>

  1462.   <tr>

  1463.     <td valign="top">Package</td>

  1464.     <td valign="top">Show package/protected/public classes and members</td>

  1465.     <td align="center" valign="top">all</td>

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

  1467.   </tr>

  1468.   <tr>

  1469.     <td valign="top">Private</td>

  1470.     <td valign="top">Show all classes and members</td>

  1471.     <td align="center" valign="top">all</td>

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

  1473.   </tr>

  1474.   <tr>

  1475.     <td valign="top">Old</td>

  1476.     <td valign="top">Generate output using JDK 1.1 emulating doclet</td>

  1477.     <td align="center" valign="top">1.2</td>

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

  1479.   </tr>

  1480.   <tr>

  1481.     <td valign="top">Verbose</td>

  1482.     <td valign="top">Output messages about what Javadoc is doing</td>

  1483.     <td align="center" valign="top">1.2</td>

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

  1485.   </tr>

  1486.   <tr>

  1487.     <td valign="top">Locale</td>

  1488.     <td valign="top">Locale to be used, e.g. en_US or en_US_WIN</td>

  1489.     <td align="center" valign="top">1.2</td>

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

  1491.   </tr>

  1492.   <tr>

  1493.     <td valign="top">Encoding</td>

  1494.     <td valign="top">Source file encoding name</td>

  1495.     <td align="center" valign="top">all</td>

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

  1497.   </tr>

  1498.   <tr>

  1499.     <td valign="top">Version</td>

  1500.     <td valign="top">Include @version paragraphs</td>

  1501.     <td align="center" valign="top">all</td>

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

  1503.   </tr>

  1504.   <tr>

  1505.     <td valign="top">Use</td>

  1506.     <td valign="top">Create class and package usage pages</td>

  1507.     <td align="center" valign="top">1.2</td>

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

  1509.   </tr>

  1510.   <tr>

  1511.     <td valign="top">Author</td>

  1512.     <td valign="top">Include @author paragraphs</td>

  1513.     <td align="center" valign="top">all</td>

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

  1515.   </tr>

  1516.   <tr>

  1517.     <td valign="top">Splitindex</td>

  1518.     <td valign="top">Split index into one file per letter</td>

  1519.     <td align="center" valign="top">1.2</td>

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

  1521.   </tr>

  1522.   <tr>

  1523.     <td valign="top">Windowtitle</td>

  1524.     <td valign="top">Browser window title for the documenation (text)</td>

  1525.     <td align="center" valign="top">1.2</td>

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

  1527.   </tr>

  1528.   <tr>

  1529.     <td valign="top">Doctitle</td>

  1530.     <td valign="top">Include title for the package index(first) page (html-code)</td>

  1531.     <td align="center" valign="top">1.2</td>

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

  1533.   </tr>

  1534.   <tr>

  1535.     <td valign="top">Header</td>

  1536.     <td valign="top">Include header text for each page (html-code)</td>

  1537.     <td align="center" valign="top">1.2</td>

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

  1539.   </tr>

  1540.   <tr>

  1541.     <td valign="top">Footer</td>

  1542.     <td valign="top">Include footer text for each page (html-code)</td>

  1543.     <td align="center" valign="top">1.2</td>

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

  1545.   </tr>

  1546.   <tr>

  1547.     <td valign="top">bottom</td>

  1548.     <td valign="top">Include bottom text for each page (html-code)</td>

  1549.     <td align="center" valign="top">1.2</td>

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

  1551.   </tr>

  1552.   <tr>

  1553.     <td valign="top">link</td>

  1554.     <td valign="top">Create links to javadoc output at the given URL</td>

  1555.     <td align="center" valign="top">1.2</td>

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

  1557.   </tr>

  1558.   <tr>

  1559.     <td valign="top">linkoffline</td>

  1560.     <td valign="top">Link to docs at &lt;url&gt; using package list at

  1561.       &lt;url2&gt;</td>

  1562.     <td align="center" valign="top">1.2</td>

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

  1564.   </tr>

  1565.   <tr>

  1566.     <td valign="top">group</td>

  1567.     <td valign="top">Group specified packages together in overview page</td>

  1568.     <td align="center" valign="top">1.2</td>

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

  1570.   </tr>

  1571.   <tr>

  1572.     <td valign="top">nodeprecated</td>

  1573.     <td valign="top">Do not include @deprecated information</td>

  1574.     <td align="center" valign="top">all</td>

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

  1576.   </tr>

  1577.   <tr>

  1578.     <td valign="top">nodeprecatedlist</td>

  1579.     <td valign="top">Do not generate deprecated list</td>

  1580.     <td align="center" valign="top">1.2</td>

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

  1582.   </tr>

  1583.   <tr>

  1584.     <td valign="top">notree</td>

  1585.     <td valign="top">Do not generate class hierarchy</td>

  1586.     <td align="center" valign="top">all</td>

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

  1588.   </tr>

  1589.   <tr>

  1590.     <td valign="top">noindex</td>

  1591.     <td valign="top">Do not generate index</td>

  1592.     <td align="center" valign="top">all</td>

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

  1594.   </tr>

  1595.   <tr>

  1596.     <td valign="top">nohelp</td>

  1597.     <td valign="top">Do not generate help link</td>

  1598.     <td align="center" valign="top">1.2</td>

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

  1600.   </tr>

  1601.   <tr>

  1602.     <td valign="top">nonavbar</td>

  1603.     <td valign="top">Do not generate navigation bar</td>

  1604.     <td align="center" valign="top">1.2</td>

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

  1606.   </tr>

  1607.   <tr>

  1608.     <td valign="top">serialwarn</td>

  1609.     <td valign="top">Generate warning about @serial tag</td>

  1610.     <td align="center" valign="top">1.2</td>

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

  1612.   </tr>

  1613.   <tr>

  1614.     <td valign="top">helpfile</td>

  1615.     <td valign="top">Specifies the HTML help file to use</td>

  1616.     <td align="center" valign="top">1.2</td>

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

  1618.   </tr>

  1619.   <tr>

  1620.     <td valign="top">stylesheetfile</td>

  1621.     <td valign="top">Specifies the CSS stylesheet to use</td>

  1622.     <td align="center" valign="top">1.2</td>

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

  1624.   </tr>

  1625.   <tr>

  1626.     <td valign="top">charset</td>

  1627.     <td valign="top">Charset for cross-platform viewing of generated

  1628.       documentation</td>

  1629.     <td align="center" valign="top">1.2</td>

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

  1631.   </tr>

  1632.   <tr>

  1633.     <td valign="top">docencoding</td>

  1634.     <td valign="top">Output file encoding name</td>

  1635.     <td align="center" valign="top">1.1</td>

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

  1637.   </tr>

  1638. </table>

  1639. <h3>Example</h3>

  1640. <pre>  &lt;javadoc packagenames=&quot;com.dummy.test.*&quot;

  1641.            sourcepath=&quot;src&quot;

  1642.            destdir=&quot;docs/api&quot;

  1643.            author=&quot;true&quot;

  1644.            version=&quot;true&quot;

  1645.            use=&quot;true&quot;

  1646.            windowtitle=&quot;Test API&quot;

  1647.            doctitle=&quot;&lt;h1&gt;Test&lt;/h1&gt;&quot;

  1648.            bottom=&quot;&lt;i&gt;Copyright &amp;#169; 2000 Dummy Corp. All Rights Reserved.&lt;/i&gt;&quot;

  1649.   /&gt;</pre>

  1650. <hr>

  1651. <h2><a name="keysubst">KeySubst</a></h2>

  1652. <h3>Description</h3>

  1653. <p>Performs keyword substitution in the source file, and writes the result to

  1654. the destination file.</p>

  1655. <p>Keys in the source file are of the form ${keyname}. The <i>keys</i> attribute

  1656. contains key/value pairs. When a key is found in the <i>keys</i> attribute, then

  1657. &quot;${keyname}&quot; is replaced by the corresponding value.</p>

  1658. <p>The <i>keys</i> attribute is of the form

  1659. &quot;name1=value1*name2=value2*name3=value3&quot;. The '*' is called the

  1660. separator, which might we changed with the <i>sep</i> attribute.</p>

  1661. <p>Note: the source file and destination file may not be the same.</p>

  1662. <h3>Parameters</h3>

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

  1664.   <tr>

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

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

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

  1668.   </tr>

  1669.   <tr>

  1670.     <td valign="top">src</td>

  1671.     <td valign="top">the source file.</td>

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

  1673.   </tr>

  1674.   <tr>

  1675.     <td valign="top">dest</td>

  1676.     <td valign="top">the destination file.</td>

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

  1678.   </tr>

  1679.   <tr>

  1680.     <td valign="top">sep</td>

  1681.     <td valign="top">the separator for the name/value pairs.</td>

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

  1683.   </tr>

  1684.   <tr>

  1685.     <td valign="top">keys</td>

  1686.     <td valign="top">name/value pairs for replacement.</td>

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

  1688.   </tr>

  1689. </table>

  1690. <h3>Examples</h3>

  1691. <pre>  &lt;keysubst src=&quot;abc.txt&quot; dest=&quot;def.txt&quot; keys=&quot;VERSION=1.0.3*DATE=2000-01-10&quot; /&gt;</pre>

  1692. <hr>

  1693. <h2><a name="mkdir">Mkdir</a></h2>

  1694. <h3>Description</h3>

  1695. <p>Creates a directory. Also non-existent parent directories are created, when

  1696. necessary.</p>

  1697. <h3>Parameters</h3>

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

  1699.   <tr>

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

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

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

  1703.   </tr>

  1704.   <tr>

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

  1706.     <td valign="top">the directory to create.</td>

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

  1708.   </tr>

  1709. </table>

  1710. <h3>Examples</h3>

  1711. <pre>&lt;mkdir dir=&quot;${dist}&quot; /&gt;</pre>

  1712. <p>creates a directory <code>${dist}</code>.</p>

  1713. <pre>&lt;mkdir dir=&quot;${dist}/lib&quot; /&gt;</pre>

  1714. <p>creates a directory <code>${dist}/lib</code>.</p>

  1715. <hr>

  1716. <h2><a name="property">Property</a></h2>

  1717. <h3>Description</h3>

  1718. <p>Sets a property (by name and value), or set of properties (from file or

  1719. resource) in the project.</p>

  1720. <p>When a property was set by the user, or was a property in a parent project

  1721. (that started this project with the <a href="#ant">ant task</a>), then this

  1722. property cannot be set, and will be ignored. This means that properties set

  1723. outside the current project always override the properties of the current

  1724. project.</p>

  1725. <p>There are three ways to set properties:</p>

  1726. <ul>

  1727.   <li>By supplying both the <i>name</i> and <i>value</i> attribute.</li>

  1728.   <li>By setting the <i>file</i> attribute with the filename of the property

  1729.     file to load. This property file has the format as defined by the file used

  1730.     in the class java.util.Properties.</li>

  1731.   <li>By setting the <i>resource</i> attribute with the resource name of the

  1732.     property file to load. This property file has the format as defined by the

  1733.     file used in the class java.util.Properties.</li>

  1734. </ul>

  1735. <p>Although combinations of the three ways are possible, only one should be used

  1736. at a time. Problems might occur with the order in which properties are set, for

  1737. instance.</p>

  1738. <p>The value part of the properties being set, might contain references to other

  1739. properties. These references are resolved at the time these properties are set.

  1740. This also holds for properties loaded from a property file.</p>

  1741. <h3>Parameters</h3>

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

  1743.   <tr>

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

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

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

  1747.   </tr>

  1748.   <tr>

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

  1750.     <td valign="top">the name of the property to set.</td>

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

  1752.   </tr>

  1753.   <tr>

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

  1755.     <td valign="top">the value of the property.</td>

  1756.     <td valign="middle" align="center" rowspan="3">Yes</td>

  1757.   </tr>

  1758.   <tr>

  1759.     <td valign="top">resource</td>

  1760.     <td valign="top">the resource name of the property file.</td>

  1761.   </tr>

  1762.   <tr>

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

  1764.     <td valign="top">the filename of the property file .</td>

  1765.   </tr>

  1766. </table>

  1767. <h3>Examples</h3>

  1768. <pre>  &lt;property name=&quot;foo.dist&quot; value=&quot;dist&quot; /&gt;</pre>

  1769. <p>sets the property <code>foo.dist</code> to the value &quot;dist&quot;.</p>

  1770. <pre>  &lt;property file=&quot;foo.properties&quot; /&gt;</pre>

  1771. <p>reads a set of properties from a file called &quot;foo.properties&quot;.</p>

  1772. <pre>  &lt;property resource=&quot;foo.properties&quot; /&gt;</pre>

  1773. <p>reads a set of properties from a resource called &quot;foo.properties&quot;.</p>

  1774. <hr>

  1775. <h2><a name="replace">Replace</a></h2>

  1776. <h3>Description</h3>

  1777. <p>Replaces the occurrence of a given string with another string in a file.</p>

  1778. <h3>Parameters</h3>

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

  1780.   <tr>

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

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

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

  1784.   </tr>

  1785.   <tr>

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

  1787.     <td valign="top">file for which the token should be replaced.</td>

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

  1789.   </tr>

  1790.   <tr>

  1791.     <td valign="top">token</td>

  1792.     <td valign="top">the token which must be replaced.</td>

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

  1794.   </tr>

  1795.   <tr>

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

  1797.     <td valign="top">the new value for the token. When omitted, an empty string

  1798.       (&quot;&quot;) is used.</td>

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

  1800.   </tr>

  1801. </table>

  1802. <h3>Examples</h3>

  1803. <pre>  &lt;replace file=&quot;${src}/index.html&quot; token=&quot;@@@&quot; value=&quot;wombat&quot; /&gt;</pre>

  1804. <p>replaces occurrences of the string &quot;@@@&quot; with the string

  1805. &quot;wombat&quot;, in the file <code>${src}/index.html</code>.</p>

  1806. <hr>

  1807. <h2><a name="rmic">Rmic</a></h2>

  1808. <h3>Description</h3>

  1809. <p>Runs the rmic compiler for a certain class.</p>

  1810. <h3>Parameters</h3>

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

  1812.   <tr>

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

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

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

  1816.   </tr>

  1817.   <tr>

  1818.     <td valign="top">base</td>

  1819.     <td valign="top">the location to store the compiled files.</td>

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

  1821.   </tr>

  1822.   <tr>

  1823.     <td valign="top">class</td>

  1824.     <td valign="top">the class for which to run <code>rmic</code>.</td>

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

  1826.   </tr>

  1827.   <tr>

  1828.     <td valign="top">filtering</td>

  1829.     <td valign="top">indicates whether token filtering should take place</td>

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

  1831.   </tr>

  1832. </table>

  1833. <h3>Examples</h3>

  1834. <pre>  &lt;rmic classname=&quot;com.xyz.FooBar&quot; base=&quot;${build}/classes&quot; /&gt;</pre>

  1835. <p>runs the rmic compiler for the class <code>com.xyz.FooBar</code>. The

  1836. compiled files will be stored in the directory <code>${build}/classes</code>.</p>

  1837. <hr>

  1838. <h2><a name="tar">Tar</a></h2>

  1839. <h3>Description</h3>

  1840. <p>Creates a tar archive.</p>

  1841. <p>The <i>basedir</i> attribute is the reference directory from where to tar.</p>

  1842. <p>It is possible to refine the set of files that are being tarred. This can be

  1843. done with the <i>includes</i>, <i>excludes</i> and <i>defaultexcludes</i>

  1844. attributes. With the <i>includes</i> attribute you specify the files you want to

  1845. have included by using patterns. The <i>exclude</i> attribute is used to specify

  1846. the files you want to have excluded. This is also done with patterns. And

  1847. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  1848. want to use default exclusions or not. See the section on <a

  1849. href="#directorybasedtasks">directory based tasks</a>, on how the

  1850. inclusion/exclusion of files works, and how to write patterns. The patterns are

  1851. relative to the <i>basedir</i> directory.</p>

  1852. <p>The <i>includes</i>, <i>excludes</i> and <i>defaultexcludes</i> attributes

  1853. replace the <i>items</i> and <i>ignore</i> attributes. The following explains

  1854. how the deprecated <i>items</i> and <i>ignore</i> attribute behave.</p>

  1855. <p>When &quot;*&quot; is used for <i>items</i>, all files in the basedir, and

  1856. its subdirectories, will be tarred. Otherwise all the files and directories

  1857. mentioned in the items list will tarred. When a directory is specified, then all

  1858. files within it are also tarred.</p>

  1859. <p>With the <i>ignore</i> attribute, you can specify files or directories to

  1860. ignore. These files will not be tarred. The items in the <i>ignore</i> attribute

  1861. override the items in the <i>items</i> attribute. The names specified in the <i>ignore</i>

  1862. attribute are just names, they do not contain any path information!</p>

  1863. <p>Note that this task does not perform compression. You might want to use the <a href="#gzip">GZip</a>

  1864. task to come up with a .tar.gz package.</p>

  1865. <h3>Parameters</h3>

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

  1867.   <tr>

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

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

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

  1871.   </tr>

  1872.   <tr>

  1873.     <td valign="top">tarfile</td>

  1874.     <td valign="top">the tar-file to create.</td>

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

  1876.   </tr>

  1877.   <tr>

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

  1879.     <td valign="top">the directory from which to zip the files.</td>

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

  1881.   </tr>

  1882.   <tr>

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

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

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

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

  1887.   </tr>

  1888.   <tr>

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

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

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

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

  1893.   </tr>

  1894.   <tr>

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

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

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

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

  1899.   </tr>

  1900. </table>

  1901. <h3>Examples</h3>

  1902. <pre>  &lt;tar tarfile=&quot;${dist}/manual.tar&quot; basedir=&quot;htdocs/manual&quot; /&gt;

  1903.   &lt;gzip zipfile=&quot;${dist}/manual.tar.gz&quot; src=&quot;${dist}/manual.tar&quot; /&gt;</pre>

  1904. <p>tars all files in the <code>htdocs/manual</code> directory in a file called <code>manual.tar</code>

  1905. in the <code>${dist}</code>  directory, then applies the gzip task to compress

  1906. it.</p>

  1907. <pre>  &lt;tar tarfile=&quot;${dist}/manual.tar&quot;

  1908.        basedir=&quot;htdocs/manual&quot;

  1909.        excludes=&quot;mydocs/**, **/todo.html&quot;

  1910.   /&gt;</pre>

  1911. <p>tars all files in the <code>htdocs/manual</code> directory in a file called <code>manual.tar</code>

  1912. in the <code>${dist}</code> directory. Files in the directory <code>mydocs</code>,

  1913. or files with the name <code>todo.html</code> are excluded.</p>

  1914. <hr>

  1915. <h2><a name="taskdef">Taskdef</a></h2>

  1916. <h3>Description</h3>

  1917. <p>Adds a task definition to the current project, such that this new task can be

  1918. used in the current project. Two attributes are needed, the name that identifies

  1919. this task uniquely, and the full name of the class (including the packages) that

  1920. implements this task.</p>

  1921. <p>Taskdef should be used to add your own tasks to the system. See also &quot;<a

  1922. href="#writingowntask">Writing your own task</a>&quot;.</p>

  1923. <h3>Parameters</h3>

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

  1925.   <tr>

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

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

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

  1929.   </tr>

  1930.   <tr>

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

  1932.     <td valign="top">the name of the task</td>

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

  1934.   </tr>

  1935.   <tr>

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

  1937.     <td valign="top">the full class name implementing the task</td>

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

  1939.   </tr>

  1940. </table>

  1941. <h3>Examples</h3>

  1942. <pre>  &lt;taskdef name=&quot;myjavadoc&quot; classname=&quot;com.mydomain.JavadocTask&quot; /&gt;</pre>

  1943. <p>makes a task called <code>myjavadoc</code> available to Ant. The class <code>com.mydomain.JavadocTask</code>

  1944. implements the task.</p>

  1945. <hr>

  1946. <h2><a name="tstamp">Tstamp</a></h2>

  1947. <h3>Description</h3>

  1948. <p>Sets the DSTAMP, TSTAMP and TODAY properties in the current project. The

  1949. DSTAMP is in the &quot;yyyymmdd&quot; format, the TSTAMP is in the &quot;hhmm&quot;

  1950. format and TODAY is &quot;month day year&quot;.</p>

  1951. <p>These properties can be used in the buildfile, for instance, to create

  1952. timestamped filenames or used to replace placeholder tags inside documents to

  1953. indicate, for example, the release date. The best place for this task is in your

  1954. initialization target.</p>

  1955. <h3>Parameters</h3>

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

  1957.   <tr>

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

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

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

  1961.   </tr>

  1962. </table>

  1963. <h3>Examples</h3>

  1964. <pre>  &lt;tstamp/&gt;</pre>

  1965. <hr>

  1966. <h2><a name="zip">Zip</a></h2>

  1967. <h3>Description</h3>

  1968. <p>Creates a zipfile.</p>

  1969. <p>The <i>basedir</i> attribute is the reference directory from where to zip.</p>

  1970. <p>It is possible to refine the set of files that are being zipped. This can be

  1971. done with the <i>includes</i>, <i>excludes</i> and <i>defaultexcludes</i>

  1972. attributes. With the <i>includes</i> attribute you specify the files you want to

  1973. have included by using patterns. The <i>exclude</i> attribute is used to specify

  1974. the files you want to have excluded. This is also done with patterns. And

  1975. finally with the <i>defaultexcludes</i> attribute, you can specify whether you

  1976. want to use default exclusions or not. See the section on <a

  1977. href="#directorybasedtasks">directory based tasks</a>, on how the

  1978. inclusion/exclusion of files works, and how to write patterns. The patterns are

  1979. relative to the <i>basedir</i> directory.</p>

  1980. <p>The <i>includes</i>, <i>excludes</i> and <i>defaultexcludes</i> attributes

  1981. replace the <i>items</i> and <i>ignore</i> attributes. The following explains

  1982. how the deprecated <i>items</i> and <i>ignore</i> attribute behave.</p>

  1983. <p>When &quot;*&quot; is used for <i>items</i>, all files in the basedir, and

  1984. its subdirectories, will be zipped. Otherwise all the files and directories

  1985. mentioned in the items list will zipped. When a directory is specified, then all

  1986. files within it are also zipped.</p>

  1987. <p>With the <i>ignore</i> attribute, you can specify files or directories to

  1988. ignore. These files will not be zipped. The items in the <i>ignore</i> attribute

  1989. override the items in the <i>items</i> attribute. The names specified in the <i>ignore</i>

  1990. attribute are just names, they do not contain any path information!</p>

  1991. <h3>Parameters</h3>

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

  1993.   <tr>

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

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

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

  1997.   </tr>

  1998.   <tr>

  1999.     <td valign="top">zipfile</td>

  2000.     <td valign="top">the zip-file to create.</td>

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

  2002.   </tr>

  2003.   <tr>

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

  2005.     <td valign="top">the directory from which to zip the files.</td>

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

  2007.   </tr>

  2008.   <tr>

  2009.     <td valign="top">items</td>

  2010.     <td valign="top">a comma separated list of the files/directories to zip. All

  2011.       files are included when omitted. (<b>deprecated</b>, use <i>includes</i>

  2012.       instead).</td>

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

  2014.   </tr>

  2015.   <tr>

  2016.     <td valign="top">ignore</td>

  2017.     <td valign="top">comma separated list of filenames/directorynames to exclude

  2018.       from the zip. No files (except default excludes) are excluded when

  2019.       omitted. (<b>deprecated</b>, use <i>excludes</i> instead).</td>

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

  2021.   </tr>

  2022.   <tr>

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

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

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

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

  2027.   </tr>

  2028.   <tr>

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

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

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

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

  2033.   </tr>

  2034.   <tr>

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

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

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

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

  2039.   </tr>

  2040. </table>

  2041. <h3>Examples</h3>

  2042. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;

  2043.        basedir=&quot;htdocs/manual&quot;

  2044.   /&gt;</pre>

  2045. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>

  2046. in the <code>${dist}</code> directory.</p>

  2047. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;

  2048.        basedir=&quot;htdocs/manual&quot;

  2049.        excludes=&quot;mydocs/**, **/todo.html&quot;

  2050.   /&gt;</pre>

  2051. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>

  2052. in the <code>${dist}</code> directory. Files in the directory <code>mydocs</code>,

  2053. or files with the name <code>todo.html</code> are excluded.</p>

  2054. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;

  2055.        basedir=&quot;htdocs/manual&quot;

  2056.        includes=&quot;api/**/*.html&quot;

  2057.        excludes=&quot;**/todo.html&quot;

  2058.   /&gt;</pre>

  2059. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>

  2060. in the <code>${dist}</code> directory. Only html files under the directory <code>api</code>

  2061. are zipped, and files with the name <code>todo.html</code> are excluded.</p>

  2062. <h3>Deprecated examples</h3>

  2063. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;

  2064.        basedir=&quot;htdocs/manual&quot;

  2065.        items=&quot;*&quot;

  2066.   /&gt;</pre>

  2067. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>

  2068. in the <code>${dist}</code> directory.</p>

  2069. <pre>  &lt;zip zipfile=&quot;${dist}/manual.zip&quot;

  2070.        basedir=&quot;htdocs/manual&quot;

  2071.        items=&quot;*&quot;

  2072.        ignore=&quot;mydocs, todo.html&quot;

  2073.   /&gt;</pre>

  2074. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>

  2075. in the <code>${dist}</code> directory. Files/directories with the names <code>mydocs</code>

  2076. and <code>todo.html</code> are excluded.</p>

  2077. <hr>

  2078. <h2><a name="writingowntask">Writing your own task</a></h2>

  2079. <p>It is very easy to write your own task:</p>

  2080. <ol>

  2081.   <li>Create a Java class that extends <code>org.apache.tools.ant.Task</code>.</li>

  2082.   <li>For each attribute, write a setter method. The setter method must be a <code>public

  2083.     void</code> method that takes one <code>String</code> as an argument. The

  2084.     name of the method must begin with &quot;set&quot;, followed by the

  2085.     attribute name, with the first character in uppercase, and the rest in

  2086.     lowercase.</li>

  2087.   <li>Write a <code>public void execute</code> method, with no arguments, that

  2088.     throws a <code>BuildException</code>. This method implements the task

  2089.     itself.</li>

  2090. </ol>

  2091. <p>It is important to know that Ant first calls the setters for the attributes

  2092. it encounters for a specific task in the buildfile, before it executes is.</p>

  2093. <p>Let's write our own task, that prints a message on the System.out stream. The

  2094. task has one attribute called &quot;message&quot;.</p>

  2095. <blockquote>

  2096.   <pre>package com.mydomain;

  2097. 

  2098. import org.apache.tools.ant.BuildException;

  2099. import org.apache.tools.ant.Task;

  2100. 

  2101. public class MyVeryOwnTask extends Task {

  2102.   private String msg;

  2103. 

  2104.   // The method executing the task

  2105.   public void execute() throws BuildException {

  2106.     System.out.println(msg);

  2107.   }

  2108. 

  2109.   // The setter for the &quot;message&quot; attribute

  2110.   public void setMessage(String msg) {

  2111.     this.msg = msg;

  2112.   }

  2113. }</pre>

  2114. </blockquote>

  2115. <p>It's really this simple;-)</p>

  2116. <p>Adding your task to the system is rather simple too:</p>

  2117. <ol>

  2118.   <li>Make sure the class that implements your task is in the classpath when

  2119.     starting Ant.</li>

  2120.   <li>In your initialization target, add a <i>taskdef</i> task. This actually adds

  2121.     your task to the system.</li>

  2122.   <li>Use your task in the rest of the buildfile.</li>

  2123. </ol>

  2124. <h3>Example</h3>

  2125. <blockquote>

  2126.   <pre>&lt;?xml version=&quot;1.0&quot;?&gt;

  2127. 

  2128. &lt;project name=&quot;OwnTaskExample&quot; default=&quot;main&quot; basedir=&quot;.&quot;&gt;

  2129.   &lt;target name=&quot;init&quot;&gt;

  2130.     &lt;taskdef name=&quot;mytask&quot; classname=&quot;com.mydomain.MyVeryOwnTask&quot;/&gt;

  2131.   &lt;/target&gt;

  2132. 

  2133.   &lt;target name=&quot;main&quot; depends=&quot;init&quot;&gt;

  2134.     &lt;mytask message=&quot;Hello World! MyVeryOwnTask works!&quot; /&gt;

  2135.   &lt;/target&gt;

  2136. &lt;/project&gt;

  2137. </pre>

  2138. </blockquote>

  2139. <p>Another way to add a task (more permanently), is to add the task name and

  2140. implementing class name to the <code>default.properties</code> file in the <code>org.apache.tools.ant.taskdefs</code>

  2141. package. Then you can use it as if it were a built in task.</p>

  2142. <hr>

  2143. <h2><a name="feedback">Feedback</a></h2>

  2144. <p>To provide feedback on this software, please subscribe to the Ant Development

  2145. Mail List <a href="mailto:(ant-dev-subscribe@jakarta.apache.org">(ant-dev-subscribe@jakarta.apache.org</a>)</p>

  2146. <hr>

  2147. <p align="center">Copyright © 2000 Apache Software Foundation. All rights

  2148. Reserved.</p>

  2149. 

  2150. </body>

  2151. 

  2152. </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