1 | <html>
|
---|
2 | <head>
|
---|
3 | <meta http-equiv="Content-Language" content="en-us">
|
---|
4 | <title>Overview of Ant Tasks</title>
|
---|
5 | <base target="mainFrame">
|
---|
6 | <link rel="stylesheet" type="text/css" href="stylesheets/antmanual.css">
|
---|
7 | </head>
|
---|
8 |
|
---|
9 | <body>
|
---|
10 | <h2><a name="top"></a>Overview of Ant Tasks</h2>
|
---|
11 |
|
---|
12 | <p>Given the large number of tasks available with Ant, it may be
|
---|
13 | difficult to get an overall view of what each task can do. The following
|
---|
14 | tables provide a short description of each task and a link to the complete
|
---|
15 | documentation.</p>
|
---|
16 |
|
---|
17 | <a href="#archive">Archive Tasks</a><br>
|
---|
18 | <a href="#audit">Audit/Coverage Tasks</a><br>
|
---|
19 | <a href="#compile">Compile Tasks</a><br>
|
---|
20 | <a href="#deploy">Deployment Tasks</a><br>
|
---|
21 | <a href="#doc">Documentation Tasks</a><br>
|
---|
22 | <a href="#ejb">EJB Tasks</a><br>
|
---|
23 | <a href="#exec">Execution Tasks</a><br>
|
---|
24 | <a href="#file">File Tasks</a><br>
|
---|
25 | <a href="#extensions">Java2 Extensions Tasks</a><br>
|
---|
26 | <a href="#log">Logging Tasks</a><br>
|
---|
27 | <a href="#mail">Mail Tasks</a><br>
|
---|
28 | <a href="#misc">Miscellaneous Tasks</a><br>
|
---|
29 | <a href="#net">.NET Tasks</a><br>
|
---|
30 | <a href="#preproc">Pre-process Tasks</a><br>
|
---|
31 | <a href="#prop">Property Tasks</a><br>
|
---|
32 | <a href="#remote">Remote Tasks</a><br>
|
---|
33 | <a href="#scm">SCM Tasks</a><br>
|
---|
34 | <a href="#testing">Testing Tasks</a><br>
|
---|
35 | <a href="#vaj">Visual Age for Java Tasks</a><br>
|
---|
36 |
|
---|
37 |
|
---|
38 | <p></p>
|
---|
39 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
40 | <th align="left">
|
---|
41 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
42 | <a name="archive">Archive Tasks</a></th>
|
---|
43 | </font>
|
---|
44 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
45 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
46 | </font>
|
---|
47 | </table>
|
---|
48 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
49 | <tr valign="top">
|
---|
50 | <th nowrap>Task Name</th>
|
---|
51 | <th nowrap>Description</th>
|
---|
52 | </tr>
|
---|
53 |
|
---|
54 | <tr valign="top">
|
---|
55 | <td nowrap><a href="CoreTasks/unpack.html">BUnzip2</a></td>
|
---|
56 | <td><p>Expands a file packed using GZip or BZip2.</p></td>
|
---|
57 | </tr>
|
---|
58 |
|
---|
59 | <tr valign="top">
|
---|
60 | <td nowrap><a href="CoreTasks/pack.html">BZip2</a></td>
|
---|
61 | <td><p>Packs a file using the GZip or BZip2 algorithm. This task
|
---|
62 | does not do any dependency checking; the output file is always
|
---|
63 | generated</p></td>
|
---|
64 | </tr>
|
---|
65 |
|
---|
66 | <tr valign="top">
|
---|
67 | <td nowrap><a href="OptionalTasks/cab.html">Cab</a></td>
|
---|
68 | <td><p>Creates Microsoft CAB archive files. It is invoked
|
---|
69 | similar to the <a href="CoreTasks/jar.html">Jar</a> or
|
---|
70 | <a href="CoreTasks/zip.html">Zip</a> tasks. This task will work on
|
---|
71 | Windows using the external <i>cabarc</i> tool (provided by Microsoft),
|
---|
72 | which must be located in your executable path.</p></td>
|
---|
73 | </tr>
|
---|
74 |
|
---|
75 | <tr valign="top">
|
---|
76 | <td nowrap><a href="CoreTasks/ear.html">Ear</a></td>
|
---|
77 | <td><p>An extension of the <a href="CoreTasks/jar.html">Jar</a> task with
|
---|
78 | special treatment for files that should end up in an
|
---|
79 | Enterprise Application archive.</p></td>
|
---|
80 | </tr>
|
---|
81 |
|
---|
82 | <tr valign="top">
|
---|
83 | <td nowrap><a href="CoreTasks/gunzip.html">GUnzip</a></td>
|
---|
84 | <td><p>Expands a GZip file.</p></td>
|
---|
85 | </tr>
|
---|
86 |
|
---|
87 | <tr valign="top">
|
---|
88 | <td nowrap><a href="CoreTasks/gzip.html">GZip</a></td>
|
---|
89 | <td><p>GZips a set of files.</p></td>
|
---|
90 | </tr>
|
---|
91 |
|
---|
92 | <tr valign="top">
|
---|
93 | <td nowrap><a href="CoreTasks/jar.html">Jar</a></td>
|
---|
94 | <td><p>Jars a set of files.</p></td>
|
---|
95 | </tr>
|
---|
96 |
|
---|
97 | <tr valign="top">
|
---|
98 | <td nowrap><a href="OptionalTasks/jlink.html">Jlink</a></td>
|
---|
99 | <td><p><i>Deprecated.</i> Use the <code>zipfileset</code>
|
---|
100 | and <code>zipgroupfileset</code> attributes of the
|
---|
101 | <a href="CoreTasks/jar.html">Jar</a> or
|
---|
102 | <a href="CoreTasks/zip.html">Zip</a> tasks instead.</p></td>
|
---|
103 | </tr>
|
---|
104 |
|
---|
105 | <tr valign="top">
|
---|
106 | <td nowrap><a href="CoreTasks/manifest.html">Manifest</a></td>
|
---|
107 | <td><p>Creates a manifest file.</p></td>
|
---|
108 | </tr>
|
---|
109 |
|
---|
110 | <tr valign="top">
|
---|
111 | <td nowrap><a href="OptionalTasks/rpm.html">Rpm</a></td>
|
---|
112 | <td><p>Invokes the <i>rpm</i> executable to build a Linux installation
|
---|
113 | file. This task currently only works on Linux or other Unix platforms
|
---|
114 | with RPM support.</p></td>
|
---|
115 | </tr>
|
---|
116 |
|
---|
117 | <tr valign="top">
|
---|
118 | <td nowrap><a href="CoreTasks/signjar.html">SignJar</a></td>
|
---|
119 | <td><p>Signs a jar or zip file with the <i>javasign</i>
|
---|
120 | command-line tool.</p></td>
|
---|
121 | </tr>
|
---|
122 |
|
---|
123 | <tr valign="top">
|
---|
124 | <td nowrap><a href="CoreTasks/tar.html">Tar</a></td>
|
---|
125 | <td><p>Creates a tar archive.</p></td>
|
---|
126 | </tr>
|
---|
127 |
|
---|
128 | <tr valign="top">
|
---|
129 | <td nowrap><a href="CoreTasks/unzip.html">Unjar</a></td>
|
---|
130 | <td><p>Unzips a jarfile.</p></td>
|
---|
131 | </tr>
|
---|
132 |
|
---|
133 | <tr valign="top">
|
---|
134 | <td nowrap><a href="CoreTasks/untar.html">Untar</a></td>
|
---|
135 | <td><p>Untars a tarfile.</p></td>
|
---|
136 | </tr>
|
---|
137 |
|
---|
138 | <tr valign="top">
|
---|
139 | <td nowrap><a href="CoreTasks/unzip.html">Unwar</a></td>
|
---|
140 | <td><p>Unzips a warfile.</p></td>
|
---|
141 | </tr>
|
---|
142 |
|
---|
143 | <tr valign="top">
|
---|
144 | <td nowrap><a href="CoreTasks/unzip.html">Unzip</a></td>
|
---|
145 | <td><p>Unzips a zipfile.</p></td>
|
---|
146 | </tr>
|
---|
147 |
|
---|
148 | <tr valign="top">
|
---|
149 | <td nowrap><a href="CoreTasks/war.html">War</a></td>
|
---|
150 | <td><p>An extension of the <a href="CoreTasks/jar.html">Jar</a> task
|
---|
151 | with special treatment for files that should end up in the
|
---|
152 | <code>WEB-INF/lib</code>, <code>WEB-INF/classes</code>, or
|
---|
153 | <code>WEB-INF</code> directories of the Web Application Archive.</p></td>
|
---|
154 | </tr>
|
---|
155 |
|
---|
156 | <tr valign="top">
|
---|
157 | <td nowrap><a href="CoreTasks/zip.html">Zip</a></td>
|
---|
158 | <td><p>Creates a zipfile.</p></td>
|
---|
159 | </tr>
|
---|
160 | </table>
|
---|
161 |
|
---|
162 | <p></p>
|
---|
163 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
164 | <th align="left">
|
---|
165 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
166 | <a name="audit">Audit/Coverage Tasks</a></th>
|
---|
167 | </font>
|
---|
168 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
169 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
170 | </font>
|
---|
171 | </table>
|
---|
172 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
173 | <tr valign="top">
|
---|
174 | <th nowrap>Task Name</th>
|
---|
175 | <th>Description</th>
|
---|
176 | </tr>
|
---|
177 |
|
---|
178 | <tr valign="top">
|
---|
179 | <td nowrap><a href="OptionalTasks/jdepend.html">JDepend</a></td>
|
---|
180 | <td><p>Invokes the <a href="http://www.clarkware.com/software/JDepend.html">
|
---|
181 | JDepend</a> parser. This parser "traverses a set of Java source-file
|
---|
182 | directories and generates design-quality metrics for each Java
|
---|
183 | package".</p></td>
|
---|
184 | </tr>
|
---|
185 |
|
---|
186 | <tr valign="top">
|
---|
187 | <td nowrap><a href="OptionalTasks/jpcoverage.html">JProbe</a></td>
|
---|
188 | <td><p>These tasks run the tools from the
|
---|
189 | <a href="http://www.sitraka.com">JProbe</a> suite. This task was written
|
---|
190 | using JProbe Suite Server Side 3.0.</p></td>
|
---|
191 | </tr>
|
---|
192 |
|
---|
193 | <tr valign="top">
|
---|
194 | <td nowrap><a href="OptionalTasks/mmetrics.html">MMetrics</a></td>
|
---|
195 | <td><p>Computes the metrics of a set of Java source files, using the
|
---|
196 | <a href="http://www.webgain.com/products/quality_analyzer/">
|
---|
197 | Metamata Metrics/WebGain Quality Analyzer</a> source-code analyzer,
|
---|
198 | and writes the results to an XML file.</p></td>
|
---|
199 | </tr>
|
---|
200 |
|
---|
201 | <tr valign="top">
|
---|
202 | <td nowrap><a href="OptionalTasks/maudit.html">Maudit</a></td>
|
---|
203 | <td><p>Performs static analysis on a set of Java source-code and
|
---|
204 | byte-code files, using the
|
---|
205 | <a href="http://www.webgain.com/products/quality_analyzer/">
|
---|
206 | Metamata Metrics/WebGain Quality Analyzer</a> source-code
|
---|
207 | analyzer.</p></td>
|
---|
208 | </tr>
|
---|
209 | </table>
|
---|
210 |
|
---|
211 | <p></p>
|
---|
212 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
213 | <th align="left">
|
---|
214 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
215 | <a name="compile">Compile Tasks</a></th>
|
---|
216 | </font>
|
---|
217 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
218 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
219 | </font>
|
---|
220 | </table>
|
---|
221 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
222 | <tr valign="top">
|
---|
223 | <th nowrap>Task Name</th>
|
---|
224 | <th>Description</th>
|
---|
225 | </tr>
|
---|
226 |
|
---|
227 | <tr valign="top">
|
---|
228 | <td nowrap><a href="OptionalTasks/depend.html">Depend</a></td>
|
---|
229 | <td><p>Determines which classfiles are out-of-date with respect to their
|
---|
230 | source, removing the classfiles of any other classes that depend on the
|
---|
231 | out-of-date classes, forcing the re-compile of the removed classfiles.
|
---|
232 | Typically used in conjunction with the
|
---|
233 | <a href="CoreTasks/javac.html">Javac</a> task.</p></td>
|
---|
234 |
|
---|
235 | <tr valign="top">
|
---|
236 | <td nowrap><a href="CoreTasks/javac.html">Javac</a></td>
|
---|
237 | <td><p>Compiles the specified source file(s) within the running
|
---|
238 | (Ant) VM, or in another VM if the <code>fork</code> attribute is
|
---|
239 | specified.</p></td>
|
---|
240 | </tr>
|
---|
241 |
|
---|
242 | <tr valign="top">
|
---|
243 | <td nowrap><a href="OptionalTasks/jspc.html">JspC</a></td>
|
---|
244 | <td><p>Runs the JSP compiler. It can be used to precompile JSP pages
|
---|
245 | for fast initial invocation of JSP pages, deployment on a server without
|
---|
246 | the full JDK installed, or simply to syntax-check the pages without
|
---|
247 | deploying them. The <a href="CoreTasks/javac.html">Javac</a> task
|
---|
248 | can be used to compile the generated Java source.
|
---|
249 | (For Weblogic JSP compiles,
|
---|
250 | see the <a href="OptionalTasks/wljspc.html">Wljspc</a> task.)</p></td>
|
---|
251 | </tr>
|
---|
252 |
|
---|
253 | <tr valign="top">
|
---|
254 | <td nowrap><a href="OptionalTasks/netrexxc.html">NetRexxC</a></td>
|
---|
255 | <td><p>Compiles a
|
---|
256 | <a href="http://www2.hursley.ibm.com/netrexx" target="_top">NetRexx</a>
|
---|
257 | source tree within the running (Ant) VM.</p></td>
|
---|
258 | </tr>
|
---|
259 |
|
---|
260 | <tr valign="top">
|
---|
261 | <td nowrap><a href="CoreTasks/rmic.html">Rmic</a></td>
|
---|
262 | <td><p>Runs the <i>rmic</i> compiler on the specified file(s).</p></td>
|
---|
263 | </tr>
|
---|
264 |
|
---|
265 | <tr valign="top">
|
---|
266 | <td nowrap><a href="OptionalTasks/wljspc.html">Wljspc</a></td>
|
---|
267 | <td><p>Compiles JSP pages using Weblogic's JSP compiler,
|
---|
268 | <i>weblogic.jspc</i>. (For non-Weblogic JSP compiles, see the
|
---|
269 | <a href="OptionalTasks/jspc.html">JspC</a> task.</p></td>
|
---|
270 | </tr>
|
---|
271 |
|
---|
272 | </table>
|
---|
273 |
|
---|
274 | <p></p>
|
---|
275 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
276 | <th align="left">
|
---|
277 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
278 | <a name="deploy">Deployment Tasks</a></th>
|
---|
279 | </font>
|
---|
280 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
281 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
282 | </font>
|
---|
283 | </table>
|
---|
284 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
285 | <tr valign="top">
|
---|
286 | <th nowrap>Task Name</th>
|
---|
287 | <th>Description</th>
|
---|
288 | </tr>
|
---|
289 |
|
---|
290 | <tr valign="top">
|
---|
291 | <td nowrap><a href="OptionalTasks/serverdeploy.html">ServerDeploy</a></td>
|
---|
292 | <td><p>Task to run a "hot" deployment tool for vendor-specific
|
---|
293 | J2EE server.
|
---|
294 | </p></td>
|
---|
295 | </tr>
|
---|
296 | </table>
|
---|
297 |
|
---|
298 | <p></p>
|
---|
299 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
300 | <th align="left">
|
---|
301 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
302 | <a name="doc">Documentation Tasks</a></th>
|
---|
303 | </font>
|
---|
304 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
305 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
306 | </font>
|
---|
307 | </table>
|
---|
308 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
309 | <tr valign="top">
|
---|
310 | <th nowrap>Task Name</th>
|
---|
311 | <th>Description</th>
|
---|
312 | </tr>
|
---|
313 |
|
---|
314 | <tr valign="top">
|
---|
315 | <td nowrap><a href="CoreTasks/javadoc.html">Javadoc/<i>Javadoc2</i></a></td>
|
---|
316 | <td><p>Generates code documentation using the <i>javadoc</i> tool.
|
---|
317 | The Javadoc2 task is deprecated; use the Javadoc task instead.</p></td>
|
---|
318 | </tr>
|
---|
319 |
|
---|
320 | <tr valign="top">
|
---|
321 | <td nowrap><a href="OptionalTasks/stylebook.html">Stylebook</a></td>
|
---|
322 | <td><p>Executes the Apache Stylebook documentation generator.
|
---|
323 | Unlike the command-line version of this tool, all three arguments
|
---|
324 | are required to run the Stylebook task.</p></td>
|
---|
325 | </tr>
|
---|
326 | </table>
|
---|
327 |
|
---|
328 | <p></p>
|
---|
329 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
330 | <th align="left">
|
---|
331 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
332 | <a name="ejb">EJB Tasks</a></th>
|
---|
333 | </font>
|
---|
334 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
335 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
336 | </font>
|
---|
337 | </table>
|
---|
338 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
339 | <tr valign="top">
|
---|
340 | <th nowrap>Task Name</th>
|
---|
341 | <th>Description</th>
|
---|
342 | </tr>
|
---|
343 |
|
---|
344 | <tr valign="top">
|
---|
345 | <td nowrap><a href="OptionalTasks/ejb.html">EJB Tasks</a></td>
|
---|
346 | <td><p>(See the documentation describing the EJB tasks.)</p></td>
|
---|
347 | </tr>
|
---|
348 | </table>
|
---|
349 |
|
---|
350 | <p></p>
|
---|
351 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
352 | <th align="left">
|
---|
353 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
354 | <a name="exec">Execution Tasks</a></th>
|
---|
355 | </font>
|
---|
356 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
357 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
358 | </font>
|
---|
359 | </table>
|
---|
360 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
361 | <tr valign="top">
|
---|
362 | <th nowrap>Task Name</th>
|
---|
363 | <th>Description</th>
|
---|
364 | </tr>
|
---|
365 |
|
---|
366 | <tr valign="top">
|
---|
367 | <td nowrap><a href="CoreTasks/ant.html">Ant</a></td>
|
---|
368 | <td><p>Runs Ant on a supplied buildfile, optionally
|
---|
369 | passing properties (with possibly new values).
|
---|
370 | This task can be used to build sub-projects.</p></td>
|
---|
371 | </tr>
|
---|
372 |
|
---|
373 | <tr valign="top">
|
---|
374 | <td nowrap><a href="CoreTasks/antcall.html">AntCall</a></td>
|
---|
375 | <td><p>Runs another target within the same buildfile, optionally
|
---|
376 | passing properties (with possibly new values).</p></td>
|
---|
377 | </tr>
|
---|
378 |
|
---|
379 | <tr valign="top">
|
---|
380 | <td nowrap><a href="CoreTasks/apply.html">Apply/<i>ExecOn</i></a></td>
|
---|
381 | <td><p>Executes a system command. When the <code>os</code> attribute is
|
---|
382 | specified, the command is only executed when Ant is run on one
|
---|
383 | of the specified operating systems.</p></td>
|
---|
384 | </tr>
|
---|
385 |
|
---|
386 | <tr valign="top">
|
---|
387 | <td nowrap><a href="CoreTasks/dependset.html">Dependset</a></td>
|
---|
388 | <td><p>This task compares a set of source files with a set of target
|
---|
389 | files. If any of the source files is newer than any of
|
---|
390 | the target files, all the target files are removed. </p></td>
|
---|
391 | </tr>
|
---|
392 |
|
---|
393 | <tr valign="top">
|
---|
394 | <td nowrap><a href="CoreTasks/exec.html">Exec</a></td>
|
---|
395 | <td><p>Executes a system command. When the <code>os</code> attribute
|
---|
396 | is specified, the command is only executed when Ant is run on one of
|
---|
397 | the specified operating systems.</p></td>
|
---|
398 | </tr>
|
---|
399 |
|
---|
400 | <tr valign="top">
|
---|
401 | <td nowrap><a href="CoreTasks/java.html">Java</a></td>
|
---|
402 | <td><p>Executes a Java class within the running (Ant) VM, or in
|
---|
403 | another VM if the <code>fork</code> attribute is specified.</p></td>
|
---|
404 | </tr>
|
---|
405 |
|
---|
406 | <tr valign="top">
|
---|
407 | <td nowrap><a href="CoreTasks/parallel.html">Parallel</a></td>
|
---|
408 | <td><p>A container task that can contain other Ant tasks.
|
---|
409 | Each nested task specified within the <code><parallel></code>
|
---|
410 | tag will be executed in its own thread.</p></td>
|
---|
411 | </tr>
|
---|
412 |
|
---|
413 | <tr valign="top">
|
---|
414 | <td nowrap><a href="CoreTasks/sequential.html">Sequential</a></td>
|
---|
415 | <td><p>A container task that can contain other Ant tasks.
|
---|
416 | The nested tasks are simply executed in sequence. Its primary use is
|
---|
417 | to support the sequential execution of a subset of tasks within
|
---|
418 | the <code><parallel></code> tag.</p></td>
|
---|
419 | </tr>
|
---|
420 |
|
---|
421 | <tr valign="top">
|
---|
422 | <td nowrap><a href="CoreTasks/sleep.html">Sleep</a></td>
|
---|
423 | <td><p> A task for suspending execution for a specified period of time.
|
---|
424 | Useful when a build or deployment process requires an interval between
|
---|
425 | tasks.</p></td>
|
---|
426 | </tr>
|
---|
427 |
|
---|
428 | <tr valign="top">
|
---|
429 | <td nowrap><a href="CoreTasks/subant.html">Subant</a></td>
|
---|
430 | <td><p> Calls a given target for all defined sub-builds. This is an extension of ant for bulk project execution.</p></td>
|
---|
431 | </tr>
|
---|
432 |
|
---|
433 | <tr valign="top">
|
---|
434 | <td nowrap><a href="CoreTasks/waitfor.html">Waitfor</a></td>
|
---|
435 | <td><p>Blocks execution until a set of specified conditions become true.
|
---|
436 | This task is intended to be used with the
|
---|
437 | <a href="CoreTasks/parallel.html">Parallel</a> task to synchronize
|
---|
438 | a set of processes.</p></td>
|
---|
439 | </tr>
|
---|
440 | </table>
|
---|
441 |
|
---|
442 | <p></p>
|
---|
443 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
444 | <th align="left">
|
---|
445 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
446 | <a name="file">File Tasks</a></th>
|
---|
447 | </font>
|
---|
448 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
449 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
450 | </font>
|
---|
451 | </table>
|
---|
452 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
453 | <tr valign="top">
|
---|
454 | <th nowrap>Task Name</th>
|
---|
455 | <th>Description</th>
|
---|
456 | </tr>
|
---|
457 |
|
---|
458 | <tr valign="top">
|
---|
459 | <td nowrap><a href="OptionalTasks/attrib.html">Attrib</a></td>
|
---|
460 | <td><p>Changes the permissions and/or attributes of a file or all
|
---|
461 | files inside the specified directories. Currently, it has effect
|
---|
462 | only under Windows.</p></td>
|
---|
463 | </tr>
|
---|
464 |
|
---|
465 | <tr valign="top">
|
---|
466 | <td nowrap><a href="CoreTasks/checksum.html">Checksum</a></td>
|
---|
467 | <td><p>Generates a checksum for a file or set of files. This task can
|
---|
468 | also be used to perform checksum verifications.</p></td>
|
---|
469 | </tr>
|
---|
470 |
|
---|
471 | <tr valign="top">
|
---|
472 | <td nowrap><a href="OptionalTasks/chgrp.html">Chgrp</a></td>
|
---|
473 | <td><p>Changes the group ownership of a file or all files inside
|
---|
474 | the specified directories. Currently, it has effect only under
|
---|
475 | Unix.</p></td>
|
---|
476 | </tr>
|
---|
477 |
|
---|
478 | <tr valign="top">
|
---|
479 | <td nowrap><a href="CoreTasks/chmod.html">Chmod</a></td>
|
---|
480 | <td><p>Changes the permissions of a file or all files inside the
|
---|
481 | specified directories. Currently, it has effect only under Unix.
|
---|
482 | The permissions are also UNIX style, like the arguments for the
|
---|
483 | <i>chmod</i> command.</p></td>
|
---|
484 | </tr>
|
---|
485 |
|
---|
486 | <tr valign="top">
|
---|
487 | <td nowrap><a href="OptionalTasks/chown.html">Chown</a></td>
|
---|
488 | <td><p>Changes the owner of a file or all files inside the
|
---|
489 | specified directories. Currently, it has effect only under
|
---|
490 | Unix.</p></td>
|
---|
491 | </tr>
|
---|
492 |
|
---|
493 | <tr valign="top">
|
---|
494 | <td nowrap><a href="CoreTasks/concat.html">Concat</a></td>
|
---|
495 | <td><p>Concatenates multiple files into a single one or to Ant's
|
---|
496 | logging system.</p></td>
|
---|
497 | </tr>
|
---|
498 |
|
---|
499 | <tr valign="top">
|
---|
500 | <td nowrap><a href="CoreTasks/copy.html">Copy</a></td>
|
---|
501 | <td><p>Copies a file or Fileset to a new file or directory.</p></td>
|
---|
502 | </tr>
|
---|
503 |
|
---|
504 | <tr valign="top">
|
---|
505 | <td nowrap><a href="CoreTasks/copydir.html"><i>Copydir</i></a></td>
|
---|
506 | <td><p><i>Deprecated.</i> Use the
|
---|
507 | <a href="CoreTasks/copy.html">Copy</a> task instead.</p></td>
|
---|
508 | </tr>
|
---|
509 |
|
---|
510 | <tr valign="top">
|
---|
511 | <td nowrap><a href="CoreTasks/copyfile.html"><i>Copyfile</i></a></td>
|
---|
512 | <td><p><i>Deprecated.</i> Use the
|
---|
513 | <a href="CoreTasks/copy.html">Copy</a> task instead.</p></td>
|
---|
514 | </tr>
|
---|
515 |
|
---|
516 | <tr valign="top">
|
---|
517 | <td nowrap><a href="CoreTasks/delete.html">Delete</a></td>
|
---|
518 | <td><p>Deletes either a single file, all files and sub-directories
|
---|
519 | in a specified directory, or a set of files specified by one or more
|
---|
520 | <a href="CoreTypes/fileset.html">FileSet</a>s.</p></td>
|
---|
521 | </tr>
|
---|
522 |
|
---|
523 | <tr valign="top">
|
---|
524 | <td nowrap><a href="CoreTasks/deltree.html"><i>Deltree</i></a></td>
|
---|
525 | <td><p><i>Deprecated.</i> Use the
|
---|
526 | <a href="CoreTasks/delete.html">Delete</a> task instead.</p></td>
|
---|
527 | </tr>
|
---|
528 |
|
---|
529 | <tr valign="top">
|
---|
530 | <td nowrap><a href="CoreTasks/filter.html">Filter</a></td>
|
---|
531 | <td><p>Sets a token filter for this project, or reads multiple token
|
---|
532 | filters from a specified file and sets these as filters. Token filters
|
---|
533 | are used by all tasks that perform file-copying operations.</p></td>
|
---|
534 | </tr>
|
---|
535 |
|
---|
536 | <tr valign="top">
|
---|
537 | <td nowrap><a href="CoreTasks/fixcrlf.html">FixCRLF</a></td>
|
---|
538 | <td><p>Modifies a file to add or remove tabs, carriage returns, linefeeds,
|
---|
539 | and EOF characters.</p></td>
|
---|
540 | </tr>
|
---|
541 |
|
---|
542 | <tr valign="top">
|
---|
543 | <td nowrap><a href="CoreTasks/get.html">Get</a></td>
|
---|
544 | <td><p>Gets a file from a URL.</p></td>
|
---|
545 | </tr>
|
---|
546 |
|
---|
547 | <tr valign="top">
|
---|
548 | <td nowrap><a href="CoreTasks/mkdir.html">Mkdir</a></td>
|
---|
549 | <td><p>Creates a directory. Non-existent parent directories are created,
|
---|
550 | when necessary.</p></td>
|
---|
551 | </tr>
|
---|
552 |
|
---|
553 | <tr valign="top">
|
---|
554 | <td nowrap><a href="CoreTasks/move.html">Move</a></td>
|
---|
555 | <td><p>Moves a file to a new file or directory, or a set(s) of file(s) to
|
---|
556 | a new directory.</p></td>
|
---|
557 | </tr>
|
---|
558 |
|
---|
559 | <tr valign="top">
|
---|
560 | <td nowrap><a href="CoreTasks/patch.html">Patch</a></td>
|
---|
561 | <td><p>Applies a "diff" file to originals.</p></td>
|
---|
562 | </tr>
|
---|
563 |
|
---|
564 | <tr valign="top">
|
---|
565 | <td nowrap><a href="CoreTasks/rename.html"><i>Rename</i></a></td>
|
---|
566 | <td><p><i>Deprecated.</i> Use the <a href="CoreTasks/move.html">Move</a>
|
---|
567 | task instead.</p></td>
|
---|
568 | </tr>
|
---|
569 |
|
---|
570 | <tr valign="top">
|
---|
571 | <td nowrap><a href="OptionalTasks/renameextensions.html">
|
---|
572 | <i>RenameExtensions</i></a></td>
|
---|
573 | <td><p><i>Deprecated</i>. Use the <a href="CoreTasks/move.html">Move</a>
|
---|
574 | task with a <a href="CoreTypes/mapper.html#glob-mapper">glob mapper</a>
|
---|
575 | instead.</p></td>
|
---|
576 | </tr>
|
---|
577 |
|
---|
578 | <tr valign="top">
|
---|
579 | <td nowrap><a href="CoreTasks/replace.html">Replace</a></td>
|
---|
580 | <td><p>Replace is a directory-based task for replacing the occurrence
|
---|
581 | of a given string with another string in selected file.</p></td>
|
---|
582 | </tr>
|
---|
583 |
|
---|
584 | <tr valign="top">
|
---|
585 | <td nowrap><a href="OptionalTasks/replaceregexp.html">
|
---|
586 | ReplaceRegExp</a></td>
|
---|
587 | <td><p>Directory-based task for replacing the occurrence of a given
|
---|
588 | regular expression with a substitution pattern in a file or set of
|
---|
589 | files.</p></td>
|
---|
590 | </tr>
|
---|
591 |
|
---|
592 | <tr valign="top">
|
---|
593 | <td nowrap><a href="CoreTasks/sync.html">Sync</a></td>
|
---|
594 | <td><p>Synchronize two directory trees.</p></td>
|
---|
595 | </tr>
|
---|
596 |
|
---|
597 | <tr valign="top">
|
---|
598 | <td nowrap><a href="CoreTasks/tempfile.html">Tempfile</a></td>
|
---|
599 | <td><p>Generates a name for a new temporary file and sets the specified
|
---|
600 | property to that name.</p></td>
|
---|
601 | </tr>
|
---|
602 |
|
---|
603 | <tr valign="top">
|
---|
604 | <td nowrap><a href="CoreTasks/touch.html">Touch</a></td>
|
---|
605 | <td><p>Changes the modification time of a file and possibly creates it at
|
---|
606 | the same time.</p></td>
|
---|
607 | </tr>
|
---|
608 | </table>
|
---|
609 |
|
---|
610 | <p></p>
|
---|
611 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
612 | <th align="left">
|
---|
613 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
614 | <a name="extensions">Java2 Extensions Tasks</a></th>
|
---|
615 | </font>
|
---|
616 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
617 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
618 | </font>
|
---|
619 | </table>
|
---|
620 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
621 | <tr valign="top">
|
---|
622 | <th nowrap>Task Name</th>
|
---|
623 | <th>Description</th>
|
---|
624 | </tr>
|
---|
625 |
|
---|
626 | <tr valign="top">
|
---|
627 | <td nowrap>
|
---|
628 | <a href="OptionalTasks/jarlib-available.html">Jarlib-available</a></td>
|
---|
629 | <td><p>Check whether an extension is present in a FileSet or an
|
---|
630 | ExtensionSet. If the extension is present, the specified property is
|
---|
631 | set.</p>
|
---|
632 | </td>
|
---|
633 | </tr>
|
---|
634 |
|
---|
635 | <tr valign="top">
|
---|
636 | <td nowrap>
|
---|
637 | <a href="OptionalTasks/jarlib-display.html">Jarlib-display</a></td>
|
---|
638 | <td><p>Display the "Optional Package" and
|
---|
639 | "Package Specification" information contained within the
|
---|
640 | specified jars.</p>
|
---|
641 | </td>
|
---|
642 | </tr>
|
---|
643 |
|
---|
644 | <tr valign="top">
|
---|
645 | <td nowrap>
|
---|
646 | <a href="OptionalTasks/jarlib-manifest.html">Jarlib-manifest</a></td>
|
---|
647 | <td><p>Task to generate a manifest that declares all the dependencies
|
---|
648 | in manifest. The dependencies are determined by looking in the
|
---|
649 | specified path and searching for Extension/"Optional Package"
|
---|
650 | specifications in the manifests of the jars.</p>
|
---|
651 | </td>
|
---|
652 | </tr>
|
---|
653 |
|
---|
654 | <tr valign="top">
|
---|
655 | <td nowrap>
|
---|
656 | <a href="OptionalTasks/jarlib-resolve.html">Jarlib-resolve</a></td>
|
---|
657 | <td><p>Try to locate a jar to satisfy an extension, and place the
|
---|
658 | location of the jar into the specified property.</p>
|
---|
659 | </td>
|
---|
660 | </tr>
|
---|
661 | </table>
|
---|
662 |
|
---|
663 | <p></p>
|
---|
664 | <p></p>
|
---|
665 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
666 | <th align="left">
|
---|
667 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
668 | <a name="log">Logging Tasks</a></th>
|
---|
669 | </font>
|
---|
670 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
671 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
672 | </font>
|
---|
673 | </table>
|
---|
674 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
675 | <tr valign="top">
|
---|
676 | <th nowrap>Task Name</th>
|
---|
677 | <th>Description</th>
|
---|
678 | </tr>
|
---|
679 |
|
---|
680 | <tr valign="top">
|
---|
681 | <td nowrap><a href="CoreTasks/recorder.html">Record</a></td>
|
---|
682 | <td><p>Runs a listener that records the logging output of the
|
---|
683 | build-process events to a file. Several recorders can exist
|
---|
684 | at the same time. Each recorder is associated with a file.</p></td>
|
---|
685 | </tr>
|
---|
686 | </table>
|
---|
687 |
|
---|
688 | <p></p>
|
---|
689 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
690 | <th align="left">
|
---|
691 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
692 | <a name="mail">Mail Tasks</a></th>
|
---|
693 | </font>
|
---|
694 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
695 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
696 | </font>
|
---|
697 | </table>
|
---|
698 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
699 | <tr valign="top">
|
---|
700 | <th nowrap>Task Name</th>
|
---|
701 | <th>Description</th>
|
---|
702 | </tr>
|
---|
703 |
|
---|
704 | <tr valign="top">
|
---|
705 | <td nowrap><a href="CoreTasks/mail.html">Mail</a></td>
|
---|
706 | <td><p>A task to send SMTP email.</p></td>
|
---|
707 | </tr>
|
---|
708 |
|
---|
709 | <tr valign="top">
|
---|
710 | <td nowrap><a href="OptionalTasks/mimemail.html">MimeMail</a></td>
|
---|
711 | <td><p><i>Deprecated</i>. Use the <a href="CoreTasks/mail.html">Mail</a>
|
---|
712 | task instead.</p></td>
|
---|
713 | </tr>
|
---|
714 |
|
---|
715 | </table>
|
---|
716 |
|
---|
717 | <p></p>
|
---|
718 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
719 | <th align="left">
|
---|
720 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
721 | <a name="misc">Miscellaneous Tasks</a></th>
|
---|
722 | </font>
|
---|
723 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
724 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
725 | </font>
|
---|
726 | </table>
|
---|
727 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
728 | <tr valign="top">
|
---|
729 | <th nowrap>Task Name</th>
|
---|
730 | <th>Description</th>
|
---|
731 | </tr>
|
---|
732 |
|
---|
733 | <tr valign="top">
|
---|
734 | <td nowrap><a href="CoreTasks/defaultexcludes.html">Defaultexcludes</a></td>
|
---|
735 | <td><p>Modify the list of default exclude patterns from within
|
---|
736 | your build file.</p></td>
|
---|
737 | </tr>
|
---|
738 |
|
---|
739 | <tr valign="top">
|
---|
740 | <td nowrap><a href="CoreTasks/echo.html">Echo</a></td>
|
---|
741 | <td><p>Echoes text to <code>System.out</code> or to a file.</p></td>
|
---|
742 | </tr>
|
---|
743 |
|
---|
744 | <tr valign="top">
|
---|
745 | <td nowrap><a href="CoreTasks/fail.html">Fail</a></td>
|
---|
746 | <td><p>Exits the current build by throwing a BuildException,
|
---|
747 | optionally printing additional information.</p></td>
|
---|
748 | </tr>
|
---|
749 |
|
---|
750 | <tr valign="top">
|
---|
751 | <td nowrap><a href="CoreTasks/genkey.html">GenKey</a></td>
|
---|
752 | <td><p>Generates a key in keystore.</p></td>
|
---|
753 | </tr>
|
---|
754 |
|
---|
755 | <tr valign="top">
|
---|
756 | <td nowrap><a href="CoreTasks/input.html">Input</a></td>
|
---|
757 | <td><p>Allows user interaction during the build process by displaying a
|
---|
758 | message and reading a line of input from the console.</p></td>
|
---|
759 | </tr>
|
---|
760 |
|
---|
761 | <tr valign="top">
|
---|
762 | <td nowrap><a href="OptionalTasks/script.html">Script</a></td>
|
---|
763 | <td><p>Executes a script in a
|
---|
764 | <a href="http://jakarta.apache.org/bsf/"
|
---|
765 | target="_top">Apache BSF</a>-supported language.</p></td>
|
---|
766 | </tr>
|
---|
767 |
|
---|
768 | <tr valign="top">
|
---|
769 | <td nowrap><a href="OptionalTasks/sound.html">Sound</a></td>
|
---|
770 | <td><p>Plays a sound file at the end of the build, according to whether
|
---|
771 | the build failed or succeeded.</p></td>
|
---|
772 | </tr>
|
---|
773 |
|
---|
774 | <tr valign="top">
|
---|
775 | <td nowrap><a href="OptionalTasks/splash.html">Splash</a></td>
|
---|
776 | <td><p>Displays a splash screen.</p></td>
|
---|
777 | </tr>
|
---|
778 |
|
---|
779 | <tr valign="top">
|
---|
780 | <td nowrap><a href="CoreTasks/sql.html">Sql</a></td>
|
---|
781 | <td><p>Executes a series of SQL statements via JDBC to a database.
|
---|
782 | Statements can either be read in from a text file using the
|
---|
783 | <code>src</code> attribute, or from between the enclosing SQL
|
---|
784 | tags.</p></td>
|
---|
785 | </tr>
|
---|
786 |
|
---|
787 | <tr valign="top">
|
---|
788 | <td nowrap><a href="CoreTasks/taskdef.html">Taskdef</a></td>
|
---|
789 | <td><p>Adds a task definition to the current project, such that this
|
---|
790 | new task can be used in the current project.</p></td>
|
---|
791 | </tr>
|
---|
792 |
|
---|
793 | <tr valign="top">
|
---|
794 | <td nowrap><a href="CoreTasks/tstamp.html">TStamp</a></td>
|
---|
795 | <td><p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and
|
---|
796 | <code>TODAY</code> properties in the current project, based on
|
---|
797 | the current date and time.</p></td>
|
---|
798 | </tr>
|
---|
799 |
|
---|
800 | <tr valign="top">
|
---|
801 | <td nowrap><a href="CoreTasks/typedef.html">Typedef</a></td>
|
---|
802 | <td><p>Adds a data-type definition to the current project, such that this
|
---|
803 | new type can be used in the current project.</p></td>
|
---|
804 | </tr>
|
---|
805 |
|
---|
806 | <tr valign="top">
|
---|
807 | <td nowrap><a href="OptionalTasks/xmlvalidate.html">XmlValidate</a></td>
|
---|
808 | <td><p>Checks that XML files are valid (or only well-formed). This task
|
---|
809 | uses the XML parser that is currently used by Ant by default, but any SAX1/2
|
---|
810 | parser can be specified, if needed.</p></td>
|
---|
811 | </tr>
|
---|
812 | </table>
|
---|
813 |
|
---|
814 | <p></p>
|
---|
815 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
816 | <th align="left">
|
---|
817 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
818 | <a name="net">.NET Tasks</a></th>
|
---|
819 | </font>
|
---|
820 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
821 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
822 | </font>
|
---|
823 | </table>
|
---|
824 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
825 | <tr valign="top">
|
---|
826 | <th nowrap>Task Name</th>
|
---|
827 | <th>Description</th>
|
---|
828 | </tr>
|
---|
829 |
|
---|
830 | <tr valign="top">
|
---|
831 | <td nowrap><a href="OptionalTasks/dotnet.html">.NET Tasks</a></td>
|
---|
832 | <td><p>(See the documentation describing the .NET tasks.)</p></td>
|
---|
833 | </tr>
|
---|
834 | </table>
|
---|
835 |
|
---|
836 | <p></p>
|
---|
837 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
838 | <th align="left">
|
---|
839 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
840 | <a name="preproc">Pre-process Tasks</a></th>
|
---|
841 | </font>
|
---|
842 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
843 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
844 | </font>
|
---|
845 | </table>
|
---|
846 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
847 | <tr valign="top">
|
---|
848 | <th nowrap>Task Name</th>
|
---|
849 | <th>Description</th>
|
---|
850 | </tr>
|
---|
851 |
|
---|
852 | <tr valign="top">
|
---|
853 | <td nowrap><a href="OptionalTasks/antlr.html">ANTLR</a></td>
|
---|
854 | <td><p>Invokes the <a HREF="http://www.antlr.org/" target="_top">ANTLR</a>
|
---|
855 | Translator generator on a grammar file.</p></td>
|
---|
856 | </tr>
|
---|
857 |
|
---|
858 | <tr valign="top">
|
---|
859 | <td nowrap><a href="CoreTasks/antstructure.html">AntStructure</a></td>
|
---|
860 | <td><p>Generates a DTD for Ant buildfiles that contains information
|
---|
861 | about all tasks currently known to Ant.</p></td>
|
---|
862 | </tr>
|
---|
863 |
|
---|
864 | <tr valign="top">
|
---|
865 | <td nowrap><a href="OptionalTasks/icontract.html">IContract</a></td>
|
---|
866 | <td><p>Instruments Java classes using the
|
---|
867 | <a href="http://www.reliable-systems.com/tools/">iContract</a> DBC
|
---|
868 | preprocessor. This task can generate a properties file for
|
---|
869 | <a href="http://home.sol.no/~hellesoy/icplus.html">iControl</a>,
|
---|
870 | a graphical user interface that lets you turn on/off assertions.</p></td>
|
---|
871 | </tr>
|
---|
872 |
|
---|
873 | <tr valign="top">
|
---|
874 | <td nowrap><a href="CoreTasks/import.html">Import</a></td>
|
---|
875 | <td><p>Import another build file and potentially override targets
|
---|
876 | in it with targets of your own.</p></td>
|
---|
877 | </tr>
|
---|
878 |
|
---|
879 | <tr valign="top">
|
---|
880 | <td nowrap><a href="OptionalTasks/javacc.html">JavaCC</a></td>
|
---|
881 | <td><p>Invokes the
|
---|
882 | <a HREF="http://javacc.dev.java.net/" target="_top">
|
---|
883 | JavaCC</a> compiler-compiler on a grammar file.</p></td>
|
---|
884 | </tr>
|
---|
885 |
|
---|
886 | <tr valign="top">
|
---|
887 | <td nowrap><a href="OptionalTasks/javah.html">Javah</a></td>
|
---|
888 | <td><p>Generates JNI headers from a Java class.</p></td>
|
---|
889 | </tr>
|
---|
890 |
|
---|
891 | <tr valign="top">
|
---|
892 | <td nowrap><a href="OptionalTasks/jjdoc.html">JJDoc</a></td>
|
---|
893 | <td><p>Invokes the <a href="http://javacc.dev.java.net/">
|
---|
894 | JJDoc</a> documentation generator for the JavaCC compiler-compiler.
|
---|
895 | JJDoc takes a JavaCC parser specification and produces documentation
|
---|
896 | for the BNF grammar. It can operate in three modes, determined by
|
---|
897 | command line options. This task only invokes JJDoc if the grammar file
|
---|
898 | is newer than the generated BNF grammar documentation.</p></td>
|
---|
899 | </tr>
|
---|
900 |
|
---|
901 | <tr valign="top">
|
---|
902 | <td nowrap><a href="OptionalTasks/jjtree.html">JJTree</a></td>
|
---|
903 | <td><p>Invokes the <a href="http://javacc.dev.java.net/">
|
---|
904 | JJTree</a> preprocessor for the JavaCC compiler-compiler. It inserts
|
---|
905 | parse-tree building actions at various places in the JavaCC source that
|
---|
906 | it generates. The output of JJTree is run through JavaCC to create the
|
---|
907 | parser. This task only invokes JJTree if the grammar file is newer than
|
---|
908 | the generated JavaCC file.</p></td>
|
---|
909 | </tr>
|
---|
910 |
|
---|
911 | <tr valign="top">
|
---|
912 | <td nowrap><a href="CoreTasks/macrodef.html">Macrodef</a></td>
|
---|
913 | <td><p>Define a new task as a macro built-up upon other tasks.</p></td>
|
---|
914 | </tr>
|
---|
915 |
|
---|
916 | <tr valign="top">
|
---|
917 | <td nowrap><a href="OptionalTasks/mparse.html">MParse</a></td>
|
---|
918 | <td><p>Invokes the Metamata <a HREF="http://www.metamata.com/parse.html">
|
---|
919 | MParse</a> compiler-compiler on a grammar file.</p></td>
|
---|
920 | </tr>
|
---|
921 |
|
---|
922 | <tr valign="top">
|
---|
923 | <td nowrap><a href="OptionalTasks/native2ascii.html">
|
---|
924 | Native2Ascii</a></td>
|
---|
925 | <td><p>Converts files from native encodings to ASCII with escaped Unicode.
|
---|
926 | A common usage is to convert source files maintained in a native
|
---|
927 | operating system encoding to ASCII, prior to compilation.</p></td>
|
---|
928 | </tr>
|
---|
929 |
|
---|
930 | <tr valign="top">
|
---|
931 | <td nowrap><a href="CoreTasks/presetdef.html">Presetdef</a></td>
|
---|
932 | <td><p>Define a new task by instrumenting an existing task with
|
---|
933 | default values for attributes or child elements.</p>
|
---|
934 | </tr>
|
---|
935 |
|
---|
936 | <tr valign="top">
|
---|
937 | <td nowrap><a href="OptionalTasks/translate.html">Translate</a></td>
|
---|
938 | <td><p>Identifies keys in files, delimited by special tokens, and
|
---|
939 | translates them with values read from resource bundles.</p></td>
|
---|
940 | </tr>
|
---|
941 |
|
---|
942 | <tr valign="top">
|
---|
943 | <td nowrap><a href="CoreTasks/style.html">Xslt/Style</a></td>
|
---|
944 | <td><p>Processes a set of documents via XSLT.</p></td>
|
---|
945 | </tr>
|
---|
946 |
|
---|
947 | </table>
|
---|
948 |
|
---|
949 | <p></p>
|
---|
950 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
951 | <th align="left">
|
---|
952 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
953 | <a name="prop">Property Tasks</a></th>
|
---|
954 | </font>
|
---|
955 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
956 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
957 | </font>
|
---|
958 | </table>
|
---|
959 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
960 | <tr valign="top">
|
---|
961 | <th nowrap>Task Name</th>
|
---|
962 | <th>Description</th>
|
---|
963 | </tr>
|
---|
964 |
|
---|
965 | <tr valign="top">
|
---|
966 | <td nowrap><a href="CoreTasks/available.html">Available</a></td>
|
---|
967 | <td><p>Sets a property if a specified file, directory, class in the
|
---|
968 | classpath, or JVM system resource is available at runtime.</p></td>
|
---|
969 | </tr>
|
---|
970 |
|
---|
971 | <tr valign="top">
|
---|
972 | <td nowrap><a href="CoreTasks/basename.html">Basename</a></td>
|
---|
973 | <td><p>Sets a property to the last element of a specified path.
|
---|
974 | </tr>
|
---|
975 |
|
---|
976 | <tr valign="top">
|
---|
977 | <td nowrap><a href="CoreTasks/buildnumber.html">BuildNumber</a></td>
|
---|
978 | <td><p>Task that can be used to track build numbers.
|
---|
979 | </tr>
|
---|
980 |
|
---|
981 | <tr valign="top">
|
---|
982 | <td nowrap><a href="CoreTasks/condition.html">Condition</a></td>
|
---|
983 | <td><p>Sets a property if a certain condition holds true - this is a
|
---|
984 | generalization of <a href="CoreTasks/available.html">Available</a> and
|
---|
985 | <a href="CoreTasks/uptodate.html">Uptodate</a>.</p></td>
|
---|
986 | </tr>
|
---|
987 |
|
---|
988 | <tr valign="top">
|
---|
989 | <td nowrap><a href="CoreTasks/dirname.html">Dirname</a></td>
|
---|
990 | <td><p>Sets a property to the value of the specified file up to,
|
---|
991 | but not including, the last path element.
|
---|
992 | </tr>
|
---|
993 |
|
---|
994 | <tr valign="top">
|
---|
995 | <td nowrap>
|
---|
996 | <a href="OptionalTasks/echoproperties.html">Echoproperties</a><br>
|
---|
997 |
|
---|
998 | </td>
|
---|
999 | <td><p>Lists the current properties.</p></td>
|
---|
1000 | </tr>
|
---|
1001 |
|
---|
1002 | <tr valign="top">
|
---|
1003 | <td nowrap><a href="CoreTasks/loadfile.html">LoadFile</a></td>
|
---|
1004 | <td><p>Loads a file into a property.</p></td>
|
---|
1005 | </tr>
|
---|
1006 |
|
---|
1007 | <tr valign="top">
|
---|
1008 | <td nowrap><a href="CoreTasks/loadproperties.html">LoadProperties</a></td>
|
---|
1009 | <td><p>Load a file's contents as Ant properties. This task is
|
---|
1010 | equivalent to using <code><property file="..."/></code>
|
---|
1011 | except that it supports nested <code><filterchain></code> elements,
|
---|
1012 | and it cannot be specified outside a target.</p></td>
|
---|
1013 | </tr>
|
---|
1014 |
|
---|
1015 | <tr valign="top">
|
---|
1016 | <td nowrap><a href="CoreTasks/pathconvert.html">PathConvert</a></td>
|
---|
1017 | <td><p>Converts a nested path, path reference, filelist reference, or
|
---|
1018 | fileset reference to the form usable on a specified platform and/or
|
---|
1019 | to a list of items separated by the specified separator and stores
|
---|
1020 | the result in the specified property.</p></td>
|
---|
1021 | </tr>
|
---|
1022 |
|
---|
1023 | <tr valign="top">
|
---|
1024 | <td nowrap><a href="CoreTasks/property.html">Property</a></td>
|
---|
1025 | <td><p>Sets a property (by name and value), or set of properties
|
---|
1026 | (from a file or resource) in the project.</p></td>
|
---|
1027 | </tr>
|
---|
1028 |
|
---|
1029 | <tr valign="top">
|
---|
1030 | <td nowrap><a href="OptionalTasks/propertyfile.html">
|
---|
1031 | PropertyFile</a></td>
|
---|
1032 | <td><p>Creates or modifies property files. Useful when wanting to make
|
---|
1033 | unattended modifications to configuration files for application
|
---|
1034 | servers and applications. Typically used for things such as
|
---|
1035 | automatically generating a build number and saving it to a build
|
---|
1036 | properties file, or doing date manipulation.<p></td>
|
---|
1037 | </tr>
|
---|
1038 |
|
---|
1039 | <tr valign="top">
|
---|
1040 | <td nowrap><a href="CoreTasks/uptodate.html">Uptodate</a></td>
|
---|
1041 | <td><p>Sets a property if a given target file is newer than a set of
|
---|
1042 | source files.</p></td>
|
---|
1043 | </tr>
|
---|
1044 |
|
---|
1045 | <tr valign="top">
|
---|
1046 | <td nowrap><a href="CoreTasks/whichresource.html">Whichresource</a></td>
|
---|
1047 | <td><p>Find a class or resource.</p></td>
|
---|
1048 | </tr>
|
---|
1049 |
|
---|
1050 | <tr valign="top">
|
---|
1051 | <td nowrap><a href="CoreTasks/xmlproperty.html">XmlProperty</a></td>
|
---|
1052 | <td><p>Loads property values from a well-formed XML file.</p></td>
|
---|
1053 | </tr>
|
---|
1054 | </table>
|
---|
1055 |
|
---|
1056 | <p></p>
|
---|
1057 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
1058 | <th align="left">
|
---|
1059 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
1060 | <a name="remote">Remote Tasks</a></th>
|
---|
1061 | </font>
|
---|
1062 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
1063 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
1064 | </font>
|
---|
1065 | </table>
|
---|
1066 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
1067 | <tr valign="top">
|
---|
1068 | <th nowrap>Task Name</th>
|
---|
1069 | <th>Description</th>
|
---|
1070 | </tr>
|
---|
1071 |
|
---|
1072 | <tr valign="top">
|
---|
1073 | <td nowrap><a href="OptionalTasks/ftp.html">FTP</a></td>
|
---|
1074 | <td><p>Implements a basic FTP client that can send, receive,
|
---|
1075 | list, and delete files, and create directories.</p></td>
|
---|
1076 | </tr>
|
---|
1077 |
|
---|
1078 | <tr valign="top">
|
---|
1079 | <td nowrap><a href="OptionalTasks/rexec.html">Rexec</a></td>
|
---|
1080 | <td><p>Task to automate a remote rexec session.</p></td>
|
---|
1081 | </tr>
|
---|
1082 |
|
---|
1083 | <tr valign="top">
|
---|
1084 | <td nowrap><a href="OptionalTasks/scp.html">Scp</a></td>
|
---|
1085 | <td><p>Copy files to or from a remote server using SSH.</p></td>
|
---|
1086 | </tr>
|
---|
1087 |
|
---|
1088 | <tr valign="top">
|
---|
1089 | <td nowrap><a href="OptionalTasks/setproxy.html">setproxy</a></td>
|
---|
1090 | <td><p>Sets Java's web proxy properties, so that tasks and code run
|
---|
1091 | in the same JVM can have through-the-firewall access to remote web sites.</p></td>
|
---|
1092 | </tr>
|
---|
1093 |
|
---|
1094 | <tr valign="top">
|
---|
1095 | <td nowrap><a href="OptionalTasks/sshexec.html">Sshexec</a></td>
|
---|
1096 | <td><p>Execute a command on a remote server using SSH.</p></td>
|
---|
1097 | </tr>
|
---|
1098 |
|
---|
1099 | <tr valign="top">
|
---|
1100 | <td nowrap><a href="OptionalTasks/telnet.html">Telnet</a></td>
|
---|
1101 | <td><p>Task to automate a remote <i>telnet</i> session. This task uses
|
---|
1102 | nested <code><read></code> and <code><write></code> tags
|
---|
1103 | to indicate strings to wait for and specify text to send.</p></td>
|
---|
1104 | </tr>
|
---|
1105 |
|
---|
1106 | </table>
|
---|
1107 |
|
---|
1108 | <p></p>
|
---|
1109 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
1110 | <th align="left">
|
---|
1111 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
1112 | <a name="scm">SCM Tasks</a></th>
|
---|
1113 | </font>
|
---|
1114 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
1115 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
1116 | </font>
|
---|
1117 | </table>
|
---|
1118 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
1119 | <tr valign="top">
|
---|
1120 | <th nowrap>Task Name</th>
|
---|
1121 | <th>Description</th>
|
---|
1122 | </tr>
|
---|
1123 |
|
---|
1124 | <tr valign="top">
|
---|
1125 | <td nowrap><a href="CoreTasks/cvs.html">Cvs</a></td>
|
---|
1126 | <td><p>Handles packages/modules retrieved from a
|
---|
1127 | <a href="http://www.cvshome.org/" target="_top">CVS</a>
|
---|
1128 | repository.</p></td>
|
---|
1129 | </tr>
|
---|
1130 |
|
---|
1131 | <tr valign="top">
|
---|
1132 | <td nowrap><a href="CoreTasks/changelog.html">CvsChangeLog</a></td>
|
---|
1133 | <td><p>Generates an XML report of the changes recorded in a
|
---|
1134 | <a href="http://www.cvshome.org/" target="_top">CVS</a>
|
---|
1135 | repository.</p></td>
|
---|
1136 | </tr>
|
---|
1137 |
|
---|
1138 | <tr valign="top">
|
---|
1139 | <td nowrap><a href="CoreTasks/cvspass.html">CVSPass</a></td>
|
---|
1140 | <td><p>Adds entries to a .cvspass file. Adding entries to this file
|
---|
1141 | has the same affect as a <i>cvs login</i> command.</p></td>
|
---|
1142 | </tr>
|
---|
1143 |
|
---|
1144 | <tr valign="top">
|
---|
1145 | <td nowrap><a href="CoreTasks/cvstagdiff.html">CvsTagDiff</a></td>
|
---|
1146 | <td><p>Generates an XML-formatted report file of the changes between
|
---|
1147 | two tags or dates recorded in a <a href="http://www.cvshome.org/"
|
---|
1148 | target="_top">CVS</a> repository.</p></td>
|
---|
1149 | </tr>
|
---|
1150 |
|
---|
1151 | <tr valign="top">
|
---|
1152 | <td nowrap><a href="OptionalTasks/clearcase.html">ClearCase</a></td>
|
---|
1153 | <td><p>Tasks to perform the ClearCase cleartool <i>checkin</i>, <i>checkout</i>,
|
---|
1154 | <i>uncheckout</i>, <i>update</i>, <i>lock</i>, <i>unlock</i>, <i>mklbtype</i>, <i>rmtype</i>, <i>mklabel</i>, <i>mkattr</i>, <i>mkdir</i>, <i>mkelem</i>, and <i>mkbl</i> commands.</p></td>
|
---|
1155 | </tr>
|
---|
1156 |
|
---|
1157 | <tr valign="top">
|
---|
1158 | <td nowrap><a href="OptionalTasks/ccm.html">Continuus/Synergy</a></td>
|
---|
1159 | <td><p>Tasks to perform the Continuus <i>ccmcheckin</i>,
|
---|
1160 | <i>ccmcheckout</i>, <i>ccmcheckintask</i>, <i>ccmreconfigure</i>, and
|
---|
1161 | <i>ccmcreateTask</i> commands.</p></td>
|
---|
1162 | </tr>
|
---|
1163 |
|
---|
1164 | <tr valign="top">
|
---|
1165 | <td nowrap><a href="OptionalTasks/vss.html">
|
---|
1166 | Microsoft Visual SourceSafe</a></td>
|
---|
1167 | <td><p>Tasks to perform the Visual SourceSafe <i>vssget</i>,
|
---|
1168 | <i>vsslabel</i>, <i>vsshistory</i>, <i>vsscheckin</i>,
|
---|
1169 | <i>vsscheckout</i>, <i>vssadd</i>, <i>vsscp</i>, and <i>vsscreate</i>
|
---|
1170 | commands.</p></td>
|
---|
1171 | </tr>
|
---|
1172 |
|
---|
1173 | <tr valign="top">
|
---|
1174 | <td nowrap><a href="OptionalTasks/perforce.html">Perforce</a></td>
|
---|
1175 | <td><p>Tasks to perform the Perforce <i>p4sync</i>, <i>p4change</i>,
|
---|
1176 | <i>p4edit</i>, <i>p4submit</i>, <i>p4have</i>, <i>p4label</i>,
|
---|
1177 | <i>p4counter</i>, <i>p4reopen</i>, <i>p4revert</i>, and <i>p4add</i>
|
---|
1178 | commands.</p></td>
|
---|
1179 | </tr>
|
---|
1180 |
|
---|
1181 | <tr valign="top">
|
---|
1182 | <td nowrap><a href="OptionalTasks/pvcstask.html">Pvcs</a></td>
|
---|
1183 | <td><p>Allows the user extract the latest edition of the source code
|
---|
1184 | from a PVCS repository.</p></td>
|
---|
1185 | </tr>
|
---|
1186 |
|
---|
1187 | <tr valign="top">
|
---|
1188 | <td nowrap><a href="OptionalTasks/sos.html">SourceOffSite</a></td>
|
---|
1189 | <td><p>Tasks to perform the SourceOffSite <i>sosget</i>, <i>soslabel</i>,
|
---|
1190 | <i>soscheckin</i>, and <i>soscheckout</i> commands.</p></td>
|
---|
1191 | </tr>
|
---|
1192 |
|
---|
1193 | <tr valign="top">
|
---|
1194 | <td nowrap><a href="OptionalTasks/starteam.html">StarTeam</a></td>
|
---|
1195 | <td><p>Tasks to perform the StarTeam <i>stcheckout</i>, <i>stcheckin</i>,
|
---|
1196 | <i>stlabel</i>, and <i>stlist</i> commands. The
|
---|
1197 | <a href="OptionalTasks/starteam.html#starteam">Starteam</a> task
|
---|
1198 | is deprecated; use
|
---|
1199 | <a href="OptionalTasks/starteam.html#stcheckout">STCheckout</a>
|
---|
1200 | instead.</p></td>
|
---|
1201 | </tr>
|
---|
1202 | </table>
|
---|
1203 |
|
---|
1204 | <p></p>
|
---|
1205 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
1206 | <th align="left">
|
---|
1207 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
1208 | <a name="testing">Testing Tasks</a></th>
|
---|
1209 | </font>
|
---|
1210 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
1211 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
1212 | </font>
|
---|
1213 | </table>
|
---|
1214 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
1215 | <tr valign="top">
|
---|
1216 | <th nowrap>Task Name</th>
|
---|
1217 | <th>Description</th>
|
---|
1218 | </tr>
|
---|
1219 |
|
---|
1220 | <tr valign="top">
|
---|
1221 | <td nowrap><a href="OptionalTasks/junit.html">Junit</a></td>
|
---|
1222 | <td><p>Runs tests from the <a href="http://www.junit.org">Junit</a>
|
---|
1223 | testing framework. This task has been tested with JUnit 3.0 up to
|
---|
1224 | JUnit 3.7; it won't work with versions prior to JUnit 3.0.</p></td>
|
---|
1225 | </tr>
|
---|
1226 |
|
---|
1227 | <tr valign="top">
|
---|
1228 | <td nowrap><a href="OptionalTasks/junitreport.html">JunitReport</a></td>
|
---|
1229 | <td><p>Merges the individual XML files generated by the
|
---|
1230 | <a href="OptionalTasks/junit.html">Junit</a> task and applies a
|
---|
1231 | stylesheet on the resulting merged document to provide a browsable
|
---|
1232 | report of the testcases results.</p></td>
|
---|
1233 | </tr>
|
---|
1234 |
|
---|
1235 | <tr valign="top">
|
---|
1236 | <td nowrap><a href="OptionalTasks/test.html">Test</a></td>
|
---|
1237 | <td><p>Executes a unit test in the <code>org.apache.testlet</code>
|
---|
1238 | framework.</p></td>
|
---|
1239 | </tr>
|
---|
1240 | </table>
|
---|
1241 |
|
---|
1242 | <p></p>
|
---|
1243 | <table width="100%" border="0" cellpadding="4" cellspacing="0">
|
---|
1244 | <th align="left">
|
---|
1245 | <font size="+0" face="arial,helvetica,sanserif">
|
---|
1246 | <a name="vaj">Visual Age for Java Tasks</a></th>
|
---|
1247 | </font>
|
---|
1248 | <font size="-1" face="arial,helvetica,sanserif">
|
---|
1249 | <th align="right"><a href="#top">[Back to top]</a></th>
|
---|
1250 | </font>
|
---|
1251 | </table>
|
---|
1252 | <table width="100%" border="1" cellpadding="4" cellspacing="0">
|
---|
1253 | <tr valign="top">
|
---|
1254 | <th nowrap>Task Name</th>
|
---|
1255 | <th>Description</th>
|
---|
1256 | </tr>
|
---|
1257 |
|
---|
1258 | <tr valign="top">
|
---|
1259 | <td nowrap><a href="Integration/VAJAntTool.html">
|
---|
1260 | Visual Age for Java Tasks</a></td>
|
---|
1261 | <td><p>(See the documentation describing the Visual Age for Java
|
---|
1262 | tasks.)</p></td>
|
---|
1263 | </tr>
|
---|
1264 | </table>
|
---|
1265 |
|
---|
1266 |
|
---|
1267 | <hr>
|
---|
1268 | <p align="center">Copyright © 2001-2004 The Apache Software Foundation.
|
---|
1269 | All rights Reserved.</p>
|
---|
1270 |
|
---|
1271 | </body>
|
---|
1272 | </html>
|
---|