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.

tasksoverview.html 37 KiB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090
  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. </head>
  7. <body>
  8. <a name="top"></a>
  9. <h2>Overview of Ant Tasks</h2>
  10. <p>Given the large number of tasks available with Ant, it may be
  11. difficult to get an overall view of what each task can do. The following
  12. tables provide a short description of each task and a link to the complete
  13. documentation.</p>
  14. <a href="#archive">Archive Tasks</a><br>
  15. <a href="#audit">Audit/Coverage Tasks</a><br>
  16. <a href="#compile">Compile Tasks</a><br>
  17. <a href="#doc">Documentation Tasks</a><br>
  18. <a href="#ejb">EJB Tasks</a><br>
  19. <a href="#exec">Execution Tasks</a><br>
  20. <a href="#file">File Tasks</a><br>
  21. <a href="#log">Logging Tasks</a><br>
  22. <a href="#mail">Mail Tasks</a><br>
  23. <a href="#misc">Miscellaneous Tasks</a><br>
  24. <a href="#net">.NET Tasks</a><br>
  25. <a href="#preproc">Pre-process Tasks</a><br>
  26. <a href="#prop">Property Tasks</a><br>
  27. <a href="#remote">Remote Tasks</a><br>
  28. <a href="#scm">SCM Tasks</a><br>
  29. <a href="#testing">Testing Tasks</a><br>
  30. <a href="#vaj">Visual Age for Java Tasks</a><br>
  31. <p></p>
  32. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  33. <th align="left">
  34. <font size="+0" face="arial,helvetica,sanserif">
  35. <a name="archive">Archive Tasks</a></th>
  36. </font>
  37. <font size="-1" face="arial,helvetica,sanserif">
  38. <th align="right"><a href="#top">[Back to top]</a></th>
  39. </font>
  40. </table>
  41. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  42. <tr valign="top">
  43. <th nowrap>Task Name</th>
  44. <th nowrap>Description</th>
  45. </tr>
  46. <tr valign="top">
  47. <td nowrap><a href="CoreTasks/unpack.html">BUnzip2</a></td>
  48. <td><p>Expands a file packed using GZip or BZip2.</p></td>
  49. </tr>
  50. <tr valign="top">
  51. <td nowrap><a href="CoreTasks/pack.html">BZip2</a></td>
  52. <td><p>Packs a file using the GZip or BZip2 algorithm. This task
  53. does not do any dependency checking; the output file is always
  54. generated</p></td>
  55. </tr>
  56. <tr valign="top">
  57. <td nowrap><a href="OptionalTasks/cab.html">Cab</a></td>
  58. <td><p>Creates Microsoft CAB archive files. It is invoked
  59. similar to the <a href="CoreTasks/jar.html">Jar</a> or
  60. <a href="CoreTasks/zip.html">Zip</a> tasks. This task will work on
  61. Windows using the external <i>cabarc</i> tool (provided by Microsoft),
  62. which must be located in your executable path.</p></td>
  63. </tr>
  64. <tr valign="top">
  65. <td nowrap><a href="CoreTasks/ear.html">Ear</a></td>
  66. <td><p>An extension of the <a href="CoreTasks/jar.html">Jar</a> task with
  67. special treatment for files that should end up in an
  68. Enterprise Application archive.</p></td>
  69. </tr>
  70. <tr valign="top">
  71. <td nowrap><a href="CoreTasks/gunzip.html">GUnzip</a></td>
  72. <td><p>Expands a GZip file.</p></td>
  73. </tr>
  74. <tr valign="top">
  75. <td nowrap><a href="CoreTasks/gzip.html">GZip</a></td>
  76. <td><p>GZips a set of files.</p></td>
  77. </tr>
  78. <tr valign="top">
  79. <td nowrap><a href="CoreTasks/jar.html">Jar</a></td>
  80. <td><p>Jars a set of files.</p></td>
  81. </tr>
  82. <tr valign="top">
  83. <td nowrap><a href="OptionalTasks/jlink.html">Jlink</a></td>
  84. <td><p>This task can be used to build jar and zip files,
  85. similar to the <a href="CoreTasks/jar.html">Jar</a> task.
  86. However, Jlink provides options for controlling the way entries from
  87. input files are added to the output file. Specifically, capabilities
  88. for merging entries from multiple zip or jar files are available.</p></td>
  89. </tr>
  90. <tr valign="top">
  91. <td nowrap><a href="CoreTasks/manifest.html">Manifest</a></td>
  92. <td><p>Creates a manifest file.</p></td>
  93. </tr>
  94. <tr valign="top">
  95. <td nowrap><a href="OptionalTasks/rpm.html">Rpm</a></td>
  96. <td><p>Invokes the <i>rpm</i> executable to build a Linux installation
  97. file. This task currently only works on Linux or other Unix platforms
  98. with RPM support.</p></td>
  99. </tr>
  100. <tr valign="top">
  101. <td nowrap><a href="CoreTasks/signjar.html">SignJar</a></td>
  102. <td><p>Signs a jar or zip file with the <i>javasign</i>
  103. command-line tool.</p></td>
  104. </tr>
  105. <tr valign="top">
  106. <td nowrap><a href="CoreTasks/tar.html">Tar</a></td>
  107. <td><p>Creates a tar archive.</p></td>
  108. </tr>
  109. <tr valign="top">
  110. <td nowrap><a href="CoreTasks/unzip.html">Unjar</a></td>
  111. <td><p>Unzips a jarfile.</p></td>
  112. </tr>
  113. <tr valign="top">
  114. <td nowrap><a href="CoreTasks/untar.html">Untar</a></td>
  115. <td><p>Untars a tarfile.</p></td>
  116. </tr>
  117. <tr valign="top">
  118. <td nowrap><a href="CoreTasks/unzip.html">Unwar</a></td>
  119. <td><p>Unzips a warfile.</p></td>
  120. </tr>
  121. <tr valign="top">
  122. <td nowrap><a href="CoreTasks/unzip.html">Unzip</a></td>
  123. <td><p>Unzips a zipfile.</p></td>
  124. </tr>
  125. <tr valign="top">
  126. <td nowrap><a href="CoreTasks/war.html">War</a></td>
  127. <td><p>An extension of the <a href="CoreTasks/jar.html">Jar</a> task
  128. with special treatment for files that should end up in the
  129. <code>WEB-INF/lib</code>, <code>WEB-INF/classes</code>, or
  130. <code>WEB-INF</code> directories of the Web Application Archive.</p></td>
  131. </tr>
  132. <tr valign="top">
  133. <td nowrap><a href="CoreTasks/zip.html">Zip</a></td>
  134. <td><p>Creates a zipfile.</p></td>
  135. </tr>
  136. </table>
  137. <p></p>
  138. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  139. <th align="left">
  140. <font size="+0" face="arial,helvetica,sanserif">
  141. <a name="audit">Audit/Coverage Tasks</a></th>
  142. </font>
  143. <font size="-1" face="arial,helvetica,sanserif">
  144. <th align="right"><a href="#top">[Back to top]</a></th>
  145. </font>
  146. </table>
  147. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  148. <tr valign="top">
  149. <th nowrap>Task Name</th>
  150. <th>Description</th>
  151. </tr>
  152. <tr valign="top">
  153. <td nowrap><a href="OptionalTasks/jdepend.html">JDepend</a></td>
  154. <td><p>Invokes the <a href="http://www.clarkware.com/software/JDepend.html">
  155. JDepend</a> parser. This parser &quot;traverses a set of Java source-file
  156. directories and generates design-quality metrics for each Java
  157. package&quot;.</p></td>
  158. </tr>
  159. <tr valign="top">
  160. <td nowrap><a href="OptionalTasks/jpcoverage.html">JProbe</a></td>
  161. <td><p>These tasks run the tools from the
  162. <a href="http://www.sitraka.com">JProbe</a> suite. This task was written
  163. using JProbe Suite Server Side 3.0.</p></td>
  164. </tr>
  165. <tr valign="top">
  166. <td nowrap><a href="OptionalTasks/mmetrics.html">MMetrics</a></td>
  167. <td><p>Computes the metrics of a set of Java source files, using the
  168. <a href="http://www.webgain.com/products/quality_analyzer/">
  169. Metamata Metrics/WebGain Quality Analyzer</a> source-code analyzer,
  170. and writes the results to an XML file.</p></td>
  171. </tr>
  172. <tr valign="top">
  173. <td nowrap><a href="OptionalTasks/maudit.html">Maudit</a></td>
  174. <td><p>Performs static analysis on a set of Java source-code and
  175. byte-code files, using the
  176. <a href="http://www.webgain.com/products/quality_analyzer/">
  177. Metamata Metrics/WebGain Quality Analyzer</a> source-code
  178. analyzer.</p></td>
  179. </tr>
  180. </table>
  181. <p></p>
  182. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  183. <th align="left">
  184. <font size="+0" face="arial,helvetica,sanserif">
  185. <a name="compile">Compile Tasks</a></th>
  186. </font>
  187. <font size="-1" face="arial,helvetica,sanserif">
  188. <th align="right"><a href="#top">[Back to top]</a></th>
  189. </font>
  190. </table>
  191. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  192. <tr valign="top">
  193. <th nowrap>Task Name</th>
  194. <th>Description</th>
  195. </tr>
  196. <tr valign="top">
  197. <td nowrap><a href="OptionalTasks/depend.html">Depend</a></td>
  198. <td><p>Determines which classfiles are out-of-date with respect to their
  199. source, removing the classfiles of any other classes that depend on the
  200. out-of-date classes, forcing the re-compile of the removed classfiles.
  201. Typically used in conjunction with the
  202. <a href="CoreTasks/javac.html">Javac</a> task.</p></td>
  203. <tr valign="top">
  204. <td nowrap><a href="CoreTasks/javac.html">Javac</a></td>
  205. <td><p>Compiles the specified source file(s) within the running
  206. (Ant) VM, or in another VM if the <code>fork</code> attribute is
  207. specified.</p></td>
  208. </tr>
  209. <tr valign="top">
  210. <td nowrap><a href="OptionalTasks/jspc.html">JspC</a></td>
  211. <td><p>Runs the JSP compiler. It can be used to precompile JSP pages
  212. for fast initial invocation of JSP pages, deployment on a server without
  213. the full JDK installed, or simply to syntax-check the pages without
  214. deploying them. The <a href="CoreTasks/javac.html">Javac</a> task
  215. can be used to compile the generated Java source.
  216. (For Weblogic JSP compiles,
  217. see the <a href="OptionalTasks/wljspc.html">Wljspc</a> task.)</p></td>
  218. </tr>
  219. <tr valign="top">
  220. <td nowrap><a href="OptionalTasks/netrexxc.html">NetRexxC</a></td>
  221. <td><p>Compiles a
  222. <a href="http://www2.hursley.ibm.com/netrexx" target="_top">NetRexx</a>
  223. source tree within the running (Ant) VM.</p></td>
  224. </tr>
  225. <tr valign="top">
  226. <td nowrap><a href="CoreTasks/rmic.html">Rmic</a></td>
  227. <td><p>Runs the <i>rmic</i> compiler on the specified file(s).</p></td>
  228. </tr>
  229. <tr valign="top">
  230. <td nowrap><a href="OptionalTasks/wljspc.html">Wljspc</a></td>
  231. <td><p>Compiles JSP pages using Weblogic's JSP compiler,
  232. <i>weblogic.jspc</i>. (For non-Weblogic JSP compiles, see the
  233. <a href="OptionalTasks/jspc.html">JspC</a> task.</p></td>
  234. </tr>
  235. </table>
  236. <p></p>
  237. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  238. <th align="left">
  239. <font size="+0" face="arial,helvetica,sanserif">
  240. <a name="ejb">EJB Tasks</a></th>
  241. </font>
  242. <font size="-1" face="arial,helvetica,sanserif">
  243. <th align="right"><a href="#top">[Back to top]</a></th>
  244. </font>
  245. </table>
  246. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  247. <tr valign="top">
  248. <th nowrap>Task Name</th>
  249. <th>Description</th>
  250. </tr>
  251. <tr valign="top">
  252. <td nowrap><a href="OptionalTasks/ejb.html">EJB Tasks</a></td>
  253. <td><p>(See the documentation describing the EJB tasks.)</p></td>
  254. </tr>
  255. </table>
  256. <p></p>
  257. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  258. <th align="left">
  259. <font size="+0" face="arial,helvetica,sanserif">
  260. <a name="doc">Documentation Tasks</a></th>
  261. </font>
  262. <font size="-1" face="arial,helvetica,sanserif">
  263. <th align="right"><a href="#top">[Back to top]</a></th>
  264. </font>
  265. </table>
  266. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  267. <tr valign="top">
  268. <th nowrap>Task Name</th>
  269. <th>Description</th>
  270. </tr>
  271. <tr valign="top">
  272. <td nowrap><a href="CoreTasks/javadoc.html">Javadoc/<i>Javadoc2</i></a></td>
  273. <td><p>Generates code documentation using the <i>javadoc</i> tool.
  274. The Javadoc2 task is deprecated; use the Javadoc task instead.</p></td>
  275. </tr>
  276. <tr valign="top">
  277. <td nowrap><a href="OptionalTasks/stylebook.html">Stylebook</a></td>
  278. <td><p>Executes the Apache Stylebook documentation generator.
  279. Unlike the command-line version of this tool, all three arguments
  280. are required to run the Stylebook task.</p></td>
  281. </tr>
  282. </table>
  283. <p></p>
  284. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  285. <th align="left">
  286. <font size="+0" face="arial,helvetica,sanserif">
  287. <a name="exec">Execution Tasks</a></th>
  288. </font>
  289. <font size="-1" face="arial,helvetica,sanserif">
  290. <th align="right"><a href="#top">[Back to top]</a></th>
  291. </font>
  292. </table>
  293. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  294. <tr valign="top">
  295. <th nowrap>Task Name</th>
  296. <th>Description</th>
  297. </tr>
  298. <tr valign="top">
  299. <td nowrap><a href="CoreTasks/ant.html">Ant</a></td>
  300. <td><p>Runs Ant on a supplied buildfile, optionally
  301. passing properties (with possibly new values).
  302. This task can be used to build sub-projects.</p></td>
  303. </tr>
  304. <tr valign="top">
  305. <td nowrap><a href="CoreTasks/antcall.html">AntCall</a></td>
  306. <td><p>Runs another target within the same buildfile, optionally
  307. passing properties (with possibly new values).</p></td>
  308. </tr>
  309. <tr valign="top">
  310. <td nowrap><a href="CoreTasks/apply.html">Apply/<i>ExecOn</i></a></td>
  311. <td><p>Executes a system command. When the <code>os</code> attribute is
  312. specified, the command is only executed when Ant is run on one
  313. of the specified operating systems.</p></td>
  314. </tr>
  315. <tr valign="top">
  316. <td nowrap><a href="CoreTasks/dependset.html">Dependset</a></td>
  317. <td><p>This task compares a set of source files with a set of target
  318. files. If any of the source files is newer than any of
  319. the target files, all the target files are removed. </p></td>
  320. </tr>
  321. <tr valign="top">
  322. <td nowrap><a href="CoreTasks/exec.html">Exec</a></td>
  323. <td><p>Executes a system command. When the <code>os</code> attribute
  324. is specified, the command is only executed when Ant is run on one of
  325. the specified operating systems.</p></td>
  326. </tr>
  327. <tr valign="top">
  328. <td nowrap><a href="CoreTasks/java.html">Java</a></td>
  329. <td><p>Executes a Java class within the running (Ant) VM, or in
  330. another VM if the <code>fork</code> attribute is specified.</p></td>
  331. </tr>
  332. <tr valign="top">
  333. <td nowrap><a href="CoreTasks/parallel.html">Parallel</a></td>
  334. <td><p>A container task that can contain other Ant tasks.
  335. Each nested task specified within the <code>&lt;parallel&gt;</code>
  336. tag will be executed in its own thread.</p></td>
  337. </tr>
  338. <tr valign="top">
  339. <td nowrap><a href="CoreTasks/sequential.html">Sequential</a></td>
  340. <td><p>A container task that can contain other Ant tasks.
  341. The nested tasks are simply executed in sequence. Its primary use is
  342. to support the sequential execution of a subset of tasks within
  343. the <code>&lt;parallel&gt;</code> tag.</p></td>
  344. </tr>
  345. <tr valign="top">
  346. <td nowrap><a href="CoreTasks/sleep.html">Sleep</a></td>
  347. <td><p> A task for suspending execution for a specified period of time.
  348. Useful when a build or deployment process requires an interval between
  349. tasks.</p></td>
  350. </tr>
  351. <tr valign="top">
  352. <td nowrap><a href="CoreTasks/waitfor.html">Waitfor</a></td>
  353. <td><p>Blocks execution until a set of specified conditions become true.
  354. This task is intended to be used with the
  355. <a href="CoreTasks/parallel.html">Parallel</a> task to synchronize
  356. a set of processes.</p></td>
  357. </tr>
  358. </table>
  359. <p></p>
  360. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  361. <th align="left">
  362. <font size="+0" face="arial,helvetica,sanserif">
  363. <a name="file">File Tasks</a></th>
  364. </font>
  365. <font size="-1" face="arial,helvetica,sanserif">
  366. <th align="right"><a href="#top">[Back to top]</a></th>
  367. </font>
  368. </table>
  369. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  370. <tr valign="top">
  371. <th nowrap>Task Name</th>
  372. <th>Description</th>
  373. </tr>
  374. <tr valign="top">
  375. <td nowrap><a href="CoreTasks/checksum.html">Checksum</a></td>
  376. <td><p>Generates a checksum for a file or set of files. This task can
  377. also be used to perform checksum verifications.</p></td>
  378. </tr>
  379. <tr valign="top">
  380. <td nowrap><a href="CoreTasks/chmod.html">Chmod</a></td>
  381. <td><p>Changes the permissions of a file or all files inside the
  382. specified directories. Currently, it has effect only under Unix.
  383. The permissions are also UNIX style, like the arguments for the
  384. <i>chmod</i> command.</p></td>
  385. </tr>
  386. <tr valign="top">
  387. <td nowrap><a href="CoreTasks/concat.html">Concat</a></td>
  388. <td><p>Concatenates multiple files into a single one or to Ant's
  389. logging system.</p></td>
  390. </tr>
  391. <tr valign="top">
  392. <td nowrap><a href="CoreTasks/copy.html">Copy</a></td>
  393. <td><p>Copies a file or Fileset to a new file or directory.</p></td>
  394. </tr>
  395. <tr valign="top">
  396. <td nowrap><a href="CoreTasks/copydir.html"><i>Copydir</i></a></td>
  397. <td><p><i>Deprecated.</i> Use the
  398. <a href="CoreTasks/copy.html">Copy</a> task instead.</p></td>
  399. </tr>
  400. <tr valign="top">
  401. <td nowrap><a href="CoreTasks/copyfile.html"><i>Copyfile</i></a></td>
  402. <td><p><i>Deprecated.</i> Use the
  403. <a href="CoreTasks/copy.html">Copy</a> task instead.</p></td>
  404. </tr>
  405. <tr valign="top">
  406. <td nowrap><a href="CoreTasks/delete.html">Delete</a></td>
  407. <td><p>Deletes either a single file, all files and sub-directories
  408. in a specified directory, or a set of files specified by one or more
  409. <a href="CoreTypes/fileset.html">FileSet</a>s.</p></td>
  410. </tr>
  411. <tr valign="top">
  412. <td nowrap><a href="CoreTasks/deltree.html"><i>Deltree</i></a></td>
  413. <td><p><i>Deprecated.</i> Use the
  414. <a href="CoreTasks/delete.html">Delete</a> task instead.</p></td>
  415. </tr>
  416. <tr valign="top">
  417. <td nowrap><a href="CoreTasks/filter.html">Filter</a></td>
  418. <td><p>Sets a token filter for this project, or reads multiple token
  419. filters from a specified file and sets these as filters. Token filters
  420. are used by all tasks that perform file-copying operations.</p></td>
  421. </tr>
  422. <tr valign="top">
  423. <td nowrap><a href="CoreTasks/fixcrlf.html">FixCRLF</a></td>
  424. <td><p>Modifies a file to add or remove tabs, carriage returns, linefeeds,
  425. and EOF characters.</p></td>
  426. </tr>
  427. <tr valign="top">
  428. <td nowrap><a href="CoreTasks/get.html">Get</a></td>
  429. <td><p>Gets a file from a URL.</p></td>
  430. </tr>
  431. <tr valign="top">
  432. <td nowrap><a href="CoreTasks/mkdir.html">Mkdir</a></td>
  433. <td><p>Creates a directory. Non-existent parent directories are created,
  434. when necessary.</p></td>
  435. </tr>
  436. <tr valign="top">
  437. <td nowrap><a href="CoreTasks/move.html">Move</a></td>
  438. <td><p>Moves a file to a new file or directory, or a set(s) of file(s) to
  439. a new directory.</p></td>
  440. </tr>
  441. <tr valign="top">
  442. <td nowrap><a href="CoreTasks/patch.html">Patch</a></td>
  443. <td><p>Applies a &quot;diff&quot; file to originals.</p></td>
  444. </tr>
  445. <tr valign="top">
  446. <td nowrap><a href="CoreTasks/rename.html"><i>Rename</i></a></td>
  447. <td><p><i>Deprecated.</i> Use the <a href="CoreTasks/move.html">Move</a>
  448. task instead.</p></td>
  449. </tr>
  450. <tr valign="top">
  451. <td nowrap><a href="OptionalTasks/renameextensions.html">
  452. <i>RenameExtensions</i></a></td>
  453. <td><p><i>Deprecated</i>. Use the <a href="CoreTasks/move.html">Move</a>
  454. task with a <a href="CoreTypes/mapper.html#glob-mapper">glob mapper</a>
  455. instead.</p></td>
  456. </tr>
  457. <tr valign="top">
  458. <td nowrap><a href="CoreTasks/replace.html">Replace</a></td>
  459. <td><p>Replace is a directory-based task for replacing the occurrence
  460. of a given string with another string in selected file.</p></td>
  461. </tr>
  462. <tr valign="top">
  463. <td nowrap><a href="OptionalTasks/replaceregexp.html">
  464. ReplaceRegExp</a></td>
  465. <td><p>Directory-based task for replacing the occurrence of a given
  466. regular expression with a substitution pattern in a file or set of
  467. files.</p></td>
  468. </tr>
  469. <tr valign="top">
  470. <td nowrap><a href="CoreTasks/touch.html">Touch</a></td>
  471. <td><p>Changes the modification time of a file and possibly creates it at
  472. the same time.</p></td>
  473. </tr>
  474. </table>
  475. <p></p>
  476. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  477. <th align="left">
  478. <font size="+0" face="arial,helvetica,sanserif">
  479. <a name="log">Logging Tasks</a></th>
  480. </font>
  481. <font size="-1" face="arial,helvetica,sanserif">
  482. <th align="right"><a href="#top">[Back to top]</a></th>
  483. </font>
  484. </table>
  485. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  486. <tr valign="top">
  487. <th nowrap>Task Name</th>
  488. <th>Description</th>
  489. </tr>
  490. <tr valign="top">
  491. <td nowrap><a href="CoreTasks/recorder.html">Record</a></td>
  492. <td><p>Runs a listener that records the logging output of the
  493. build-process events to a file. Several recorders can exist
  494. at the same time. Each recorder is associated with a file.</p></td>
  495. </tr>
  496. </table>
  497. <p></p>
  498. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  499. <th align="left">
  500. <font size="+0" face="arial,helvetica,sanserif">
  501. <a name="mail">Mail Tasks</a></th>
  502. </font>
  503. <font size="-1" face="arial,helvetica,sanserif">
  504. <th align="right"><a href="#top">[Back to top]</a></th>
  505. </font>
  506. </table>
  507. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  508. <tr valign="top">
  509. <th nowrap>Task Name</th>
  510. <th>Description</th>
  511. </tr>
  512. <tr valign="top">
  513. <td nowrap><a href="CoreTasks/mail.html">Mail</a></td>
  514. <td><p>A task to send SMTP email.</p></td>
  515. </tr>
  516. <tr valign="top">
  517. <td nowrap><a href="OptionalTasks/mimemail.html">MimeMail</a></td>
  518. <td><p><i>Deprecated</i>. Use the <a href="CoreTasks/mail.html">Mail</a>
  519. task instead.</p></td>
  520. </tr>
  521. </table>
  522. <p></p>
  523. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  524. <th align="left">
  525. <font size="+0" face="arial,helvetica,sanserif">
  526. <a name="misc">Miscellaneous Tasks</a></th>
  527. </font>
  528. <font size="-1" face="arial,helvetica,sanserif">
  529. <th align="right"><a href="#top">[Back to top]</a></th>
  530. </font>
  531. </table>
  532. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  533. <tr valign="top">
  534. <th nowrap>Task Name</th>
  535. <th>Description</th>
  536. </tr>
  537. <tr valign="top">
  538. <td nowrap><a href="CoreTasks/echo.html">Echo</a></td>
  539. <td><p>Echoes text to <code>System.out</code> or to a file.</p></td>
  540. </tr>
  541. <tr valign="top">
  542. <td nowrap><a href="CoreTasks/fail.html">Fail</a></td>
  543. <td><p>Exits the current build by throwing a BuildException,
  544. optionally printing additional information.</p></td>
  545. </tr>
  546. <tr valign="top">
  547. <td nowrap><a href="CoreTasks/genkey.html">GenKey</a></td>
  548. <td><p>Generates a key in keystore.</p></td>
  549. </tr>
  550. <tr valign="top">
  551. <td nowrap><a href="CoreTasks/input.html">Input</a></td>
  552. <td><p>Allows user interaction during the build process by displaying a
  553. message and reading a line of input from the console.</p></td>
  554. </tr>
  555. <tr valign="top">
  556. <td nowrap><a href="CoreTasks/pathconvert.html">PathConvert</a></td>
  557. <td><p>Converts a nested path, path reference, or fileset reference
  558. to the form usable on a specified platform and stores the result in
  559. a given property.</p></td>
  560. </tr>
  561. <tr valign="top">
  562. <td nowrap><a href="OptionalTasks/script.html">Script</a></td>
  563. <td><p>Executes a script in a
  564. <a href="http://oss.software.ibm.com/developerworks/opensource/bsf/"
  565. target="_top">BSF</a>-supported language.</p></td>
  566. </tr>
  567. <tr valign="top">
  568. <td nowrap><a href="OptionalTasks/sound.html">Sound</a></td>
  569. <td><p>Plays a sound file at the end of the build, according to whether
  570. the build failed or succeeded.</p></td>
  571. </tr>
  572. <tr valign="top">
  573. <td nowrap><a href="OptionalTasks/splash.html">Splash</a></td>
  574. <td><p>Displays a splash screen.</p></td>
  575. </tr>
  576. <tr valign="top">
  577. <td nowrap><a href="CoreTasks/sql.html">Sql</a></td>
  578. <td><p>Executes a series of SQL statements via JDBC to a database.
  579. Statements can either be read in from a text file using the
  580. <code>src</code> attribute, or from between the enclosing SQL
  581. tags.</p></td>
  582. </tr>
  583. <tr valign="top">
  584. <td nowrap><a href="CoreTasks/taskdef.html">Taskdef</a></td>
  585. <td><p>Adds a task definition to the current project, such that this
  586. new task can be used in the current project.</p></td>
  587. </tr>
  588. <tr valign="top">
  589. <td nowrap><a href="CoreTasks/tstamp.html">TStamp</a></td>
  590. <td><p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and
  591. <code>TODAY</code> properties in the current project, based on
  592. the current date and time.</p></td>
  593. </tr>
  594. <tr valign="top">
  595. <td nowrap><a href="CoreTasks/typedef.html">Typedef</a></td>
  596. <td><p>Adds a data-type definition to the current project, such that this
  597. new type can be used in the current project.</p></td>
  598. </tr>
  599. <tr valign="top">
  600. <td nowrap><a href="OptionalTasks/xmlvalidate.html">XmlValidate</a></td>
  601. <td><p>Checks that XML files are valid (or only well-formed). This task
  602. uses the Crimson SAX2 parser implementation by default, but any SAX1/2
  603. parser can be specified, if needed.</p></td>
  604. </tr>
  605. </table>
  606. <p></p>
  607. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  608. <th align="left">
  609. <font size="+0" face="arial,helvetica,sanserif">
  610. <a name="net">.NET Tasks</a></th>
  611. </font>
  612. <font size="-1" face="arial,helvetica,sanserif">
  613. <th align="right"><a href="#top">[Back to top]</a></th>
  614. </font>
  615. </table>
  616. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  617. <tr valign="top">
  618. <th nowrap>Task Name</th>
  619. <th>Description</th>
  620. </tr>
  621. <tr valign="top">
  622. <td nowrap><a href="OptionalTasks/dotnet.html">.NET Tasks</a></td>
  623. <td><p>(See the documentation describing the .NET tasks.)</p></td>
  624. </tr>
  625. </table>
  626. <p></p>
  627. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  628. <th align="left">
  629. <font size="+0" face="arial,helvetica,sanserif">
  630. <a name="preproc">Pre-process Tasks</a></th>
  631. </font>
  632. <font size="-1" face="arial,helvetica,sanserif">
  633. <th align="right"><a href="#top">[Back to top]</a></th>
  634. </font>
  635. </table>
  636. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  637. <tr valign="top">
  638. <th nowrap>Task Name</th>
  639. <th>Description</th>
  640. </tr>
  641. <tr valign="top">
  642. <td nowrap><a href="OptionalTasks/antlr.html">ANTLR</a></td>
  643. <td><p>Invokes the <a HREF="http://www.antlr.org/" target="_top">ANTLR</a>
  644. Translator generator on a grammar file.</p></td>
  645. </tr>
  646. <tr valign="top">
  647. <td nowrap><a href="CoreTasks/antstructure.html">AntStructure</a></td>
  648. <td><p>Generates a DTD for Ant buildfiles that contains information
  649. about all tasks currently known to Ant.</p></td>
  650. </tr>
  651. <tr valign="top">
  652. <td nowrap><a href="OptionalTasks/icontract.html">IContract</a></td>
  653. <td><p>Instruments Java classes using the
  654. <a href="http://www.reliable-systems.com/tools/">iContract</a> DBC
  655. preprocessor. This task can generate a properties file for
  656. <a href="http://home.sol.no/~hellesoy/icplus.html">iControl</a>,
  657. a graphical user interface that lets you turn on/off assertions.</p></td>
  658. </tr>
  659. <tr valign="top">
  660. <td nowrap><a href="OptionalTasks/javacc.html">JavaCC</a></td>
  661. <td><p>Invokes the
  662. <a HREF="http://www.webgain.com/products/java_cc/" target="_top">
  663. JavaCC</a> compiler-compiler on a grammar file.</p></td>
  664. </tr>
  665. <tr valign="top">
  666. <td nowrap><a href="OptionalTasks/javah.html">Javah</a></td>
  667. <td><p>Generates JNI headers from a Java class.</p></td>
  668. </tr>
  669. <tr valign="top">
  670. <td nowrap><a href="OptionalTasks/jjtree.html">JJTree</a></td>
  671. <td><p>Invokes the <a href="http://www.webgain.com/products/java_cc/">
  672. JJTree</a> preprocessor for the JavaCC compiler-compiler. It inserts
  673. parse-tree building actions at various places in the JavaCC source that
  674. it generates. The output of JJTree is run through JavaCC to create the
  675. parser. This task only invokes JJTree if the grammar file is newer than
  676. the generated JavaCC file.</p></td>
  677. </tr>
  678. <tr valign="top">
  679. <td nowrap><a href="OptionalTasks/mparse.html">MParse</a></td>
  680. <td><p>Invokes the Metamata <a HREF="http://www.metamata.com/parse.html">
  681. MParse</a> compiler-compiler on a grammar file.</p></td>
  682. </tr>
  683. <tr valign="top">
  684. <td nowrap><a href="OptionalTasks/native2ascii.html">
  685. Native2Ascii</a></td>
  686. <td><p>Converts files from native encodings to ASCII with escaped Unicode.
  687. A common usage is to convert source files maintained in a native
  688. operating system encoding to ASCII, prior to compilation.</p></td>
  689. </tr>
  690. <tr valign="top">
  691. <td nowrap><a href="OptionalTasks/translate.html">Translate</a></td>
  692. <td><p>Identifies keys in files, delimited by special tokens, and
  693. translates them with values read from resource bundles.</p></td>
  694. </tr>
  695. <tr valign="top">
  696. <td nowrap><a href="CoreTasks/style.html">Xslt/Style</a></td>
  697. <td><p>Processes a set of documents via XSLT.</p></td>
  698. </tr>
  699. </table>
  700. <p></p>
  701. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  702. <th align="left">
  703. <font size="+0" face="arial,helvetica,sanserif">
  704. <a name="prop">Property Tasks</a></th>
  705. </font>
  706. <font size="-1" face="arial,helvetica,sanserif">
  707. <th align="right"><a href="#top">[Back to top]</a></th>
  708. </font>
  709. </table>
  710. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  711. <tr valign="top">
  712. <th nowrap>Task Name</th>
  713. <th>Description</th>
  714. </tr>
  715. <tr valign="top">
  716. <td nowrap><a href="CoreTasks/available.html">Available</a></td>
  717. <td><p>Sets a property if a specified file, directory, class in the
  718. classpath, or JVM system resource is available at runtime.</p></td>
  719. </tr>
  720. <tr valign="top">
  721. <td nowrap><a href="CoreTasks/basename.html">Basename</a></td>
  722. <td><p>Sets a property to the last element of a specified path.
  723. </tr>
  724. <tr valign="top">
  725. <td nowrap><a href="CoreTasks/buildnumber.html">BuildNumber</a></td>
  726. <td><p>Task that can be used to track build numbers.
  727. </tr>
  728. <tr valign="top">
  729. <td nowrap><a href="CoreTasks/condition.html">Condition</a></td>
  730. <td><p>Sets a property if a certain condition holds true - this is a
  731. generalization of <a href="CoreTasks/available.html">Available</a> and
  732. <a href="CoreTasks/uptodate.html">Uptodate</a>.</p></td>
  733. </tr>
  734. <tr valign="top">
  735. <td nowrap><a href="CoreTasks/dirname.html">Dirname</a></td>
  736. <td><p>Sets a property to the value of the specified file up to,
  737. but not including, the last path element.
  738. </tr>
  739. <tr valign="top">
  740. <td nowrap>
  741. <a href="OptionalTasks/echoproperties.html">Echoproperties</a><br>
  742. </td>
  743. <td><p>Lists the current properties</p></td>
  744. </tr>
  745. <tr valign="top">
  746. <td nowrap><a href="CoreTasks/loadfile.html">LoadFile</a></td>
  747. <td><p>Loads a file into a property</p></td>
  748. </tr>
  749. <tr valign="top">
  750. <td nowrap><a href="CoreTasks/loadproperties.html">LoadProperties</a></td>
  751. <td><p>Load a file's contents as Ant properties. This task is
  752. equivalent to using <code>&lt;property file=&quot;...&quot;/&gt;</code>
  753. except that it supports nested <code>&lt;filterchain&gt;</code> elements,
  754. and it cannot be specified outside a target.</p></td>
  755. </tr>
  756. <tr valign="top">
  757. <td nowrap><a href="CoreTasks/property.html">Property</a></td>
  758. <td><p>Sets a property (by name and value), or set of properties
  759. (from a file or resource) in the project.</p></td>
  760. </tr>
  761. <tr valign="top">
  762. <td nowrap><a href="OptionalTasks/propertyfile.html">
  763. PropertyFile</a></td>
  764. <td><p>Creates or modifies property files. Useful when wanting to make
  765. unattended modifications to configuration files for application
  766. servers and applications. Typically used for things such as
  767. automatically generating a build number and saving it to a build
  768. properties file, or doing date manipulation.<p></td>
  769. </tr>
  770. <tr valign="top">
  771. <td nowrap><a href="CoreTasks/uptodate.html">Uptodate</a></td>
  772. <td><p>Sets a property if a given target file is newer than a set of
  773. source files.</p></td>
  774. </tr>
  775. </table>
  776. <p></p>
  777. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  778. <th align="left">
  779. <font size="+0" face="arial,helvetica,sanserif">
  780. <a name="remote">Remote Tasks</a></th>
  781. </font>
  782. <font size="-1" face="arial,helvetica,sanserif">
  783. <th align="right"><a href="#top">[Back to top]</a></th>
  784. </font>
  785. </table>
  786. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  787. <tr valign="top">
  788. <th nowrap>Task Name</th>
  789. <th>Description</th>
  790. </tr>
  791. <tr valign="top">
  792. <td nowrap><a href="OptionalTasks/ftp.html">FTP</a></td>
  793. <td><p>Implements a basic FTP client that can send, receive,
  794. list, and delete files, and create directories.</p></td>
  795. </tr>
  796. <tr valign="top">
  797. <td nowrap><a href="OptionalTasks/telnet.html">Telnet</a></td>
  798. <td><p>Task to automate a remote <i>telnet</i> session. This task uses
  799. nested <code>&lt;read&gt;</code> and <code>&lt;write&gt;</code> tags
  800. to indicate strings to wait for and specify text to send.</p></td>
  801. </tr>
  802. </table>
  803. <p></p>
  804. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  805. <th align="left">
  806. <font size="+0" face="arial,helvetica,sanserif">
  807. <a name="scm">SCM Tasks</a></th>
  808. </font>
  809. <font size="-1" face="arial,helvetica,sanserif">
  810. <th align="right"><a href="#top">[Back to top]</a></th>
  811. </font>
  812. </table>
  813. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  814. <tr valign="top">
  815. <th nowrap>Task Name</th>
  816. <th>Description</th>
  817. </tr>
  818. <tr valign="top">
  819. <td nowrap><a href="CoreTasks/cvs.html">Cvs</a></td>
  820. <td><p>Handles packages/modules retrieved from a
  821. <a href="http://www.cvshome.org/" target="_top">CVS</a>
  822. repository.</p></td>
  823. </tr>
  824. <tr valign="top">
  825. <td nowrap><a href="CoreTasks/changelog.html">CvsChangeLog</a></td>
  826. <td><p>Generates an XML report of the changes recorded in a
  827. <a href="http://www.cvshome.org/" target="_top">CVS</a>
  828. repository.</p></td>
  829. </tr>
  830. <tr valign="top">
  831. <td nowrap><a href="CoreTasks/cvspass.html">CVSPass</a></td>
  832. <td><p>Adds entries to a .cvspass file. Adding entries to this file
  833. has the same affect as a <i>cvs login</i> command.</p></td>
  834. </tr>
  835. <tr valign="top">
  836. <td nowrap><a href="CoreTasks/cvstagdiff.html">CvsTagDiff</a></td>
  837. <td><p>Generates an XML-formatted report file of the changes between
  838. two tags or dates recorded in a <a href="http://www.cvshome.org/"
  839. target="_top">CVS</a> repository.</p></td>
  840. </tr>
  841. <tr valign="top">
  842. <td nowrap><a href="OptionalTasks/clearcase.html">ClearCase</a></td>
  843. <td><p>Tasks to perform the ClearCase <i>cccheckin</i>, <i>cccheckout</i>,
  844. <i>ccuncheckout</i>, and <i>ccupdate</i> commands.</p></td>
  845. </tr>
  846. <tr valign="top">
  847. <td nowrap><a href="OptionalTasks/ccm.html">Continuus/Synergy</a></td>
  848. <td><p>Tasks to perform the Continuus <i>ccmcheckin</i>,
  849. <i>ccmcheckout</i>, <i>ccmcheckintask</i>, <i>ccmreconfigure</i>, and
  850. <i>ccmcreateTask</i> commands.</p></td>
  851. </tr>
  852. <tr valign="top">
  853. <td nowrap><a href="OptionalTasks/vss.html">
  854. Microsoft Visual SourceSafe</a></td>
  855. <td><p>Tasks to perform the Visual SourceSafe <i>vssget</i>,
  856. <i>vsslabel</i>, <i>vsshistory</i>, <i>vsscheckin</i>,
  857. <i>vsscheckout</i>, <i>vssadd</i>, <i>vsscp</i>, and <i>vsscreate</i>
  858. commands.</p></td>
  859. </tr>
  860. <tr valign="top">
  861. <td nowrap><a href="OptionalTasks/perforce.html">Perforce</a></td>
  862. <td><p>Tasks to perform the Perforce <i>p4sync</i>, <i>p4change</i>,
  863. <i>p4edit</i>, <i>p4submit</i>, <i>p4have</i>, <i>p4label</i>,
  864. <i>p4counter</i>, <i>p4reopen</i>, <i>p4revert</i>, and <i>p4add</i>
  865. commands.</p></td>
  866. </tr>
  867. <tr valign="top">
  868. <td nowrap><a href="OptionalTasks/pvcstask.html">Pvcs</a></td>
  869. <td><p>Allows the user extract the latest edition of the source code
  870. from a PVCS repository.</p></td>
  871. </tr>
  872. <tr valign="top">
  873. <td nowrap><a href="OptionalTasks/sos.html">SourceOffSite</a></td>
  874. <td><p>Tasks to perform the SourceOffSite <i>sosget</i>, <i>soslabel</i>,
  875. <i>soscheckin</i>, and <i>soscheckout</i> commands.</p></td>
  876. </tr>
  877. <tr valign="top">
  878. <td nowrap><a href="OptionalTasks/starteam.html">StarTeam</a></td>
  879. <td><p>Tasks to perform the StarTeam <i>stcheckout</i>, <i>stcheckin</i>,
  880. <i>stlabel</i>, and <i>stlist</i> commands. The
  881. <a href="OptionalTasks/starteam.html#starteam">Starteam</a> task
  882. is deprecated; use
  883. <a href="OptionalTasks/starteam.html#stcheckout">STCheckout</a>
  884. instead.</p></td>
  885. </tr>
  886. </table>
  887. <p></p>
  888. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  889. <th align="left">
  890. <font size="+0" face="arial,helvetica,sanserif">
  891. <a name="testing">Testing Tasks</a></th>
  892. </font>
  893. <font size="-1" face="arial,helvetica,sanserif">
  894. <th align="right"><a href="#top">[Back to top]</a></th>
  895. </font>
  896. </table>
  897. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  898. <tr valign="top">
  899. <th nowrap>Task Name</th>
  900. <th>Description</th>
  901. </tr>
  902. <tr valign="top">
  903. <td nowrap><a href="OptionalTasks/junit.html">Junit</a></td>
  904. <td><p>Runs tests from the <a href="http://www.junit.org">Junit</a>
  905. testing framework. This task has been tested with JUnit 3.0 up to
  906. JUnit 3.7; it won't work with versions prior to JUnit 3.0.</p></td>
  907. </tr>
  908. <tr valign="top">
  909. <td nowrap><a href="OptionalTasks/junitreport.html">JunitReport</a></td>
  910. <td><p>Merges the individual XML files generated by the
  911. <a href="OptionalTasks/junit.html">Junit</a> task and applies a
  912. stylesheet on the resulting merged document to provide a browsable
  913. report of the testcases results.</p></td>
  914. </tr>
  915. <tr valign="top">
  916. <td nowrap><a href="OptionalTasks/test.html">Test</a></td>
  917. <td><p>Executes a unit test in the <code>org.apache.testlet</code>
  918. framework.</p></td>
  919. </tr>
  920. </table>
  921. <p></p>
  922. <table width="100%" border="0" cellpadding="4" cellspacing="0">
  923. <th align="left">
  924. <font size="+0" face="arial,helvetica,sanserif">
  925. <a name="vaj">Visual Age for Java Tasks</a></th>
  926. </font>
  927. <font size="-1" face="arial,helvetica,sanserif">
  928. <th align="right"><a href="#top">[Back to top]</a></th>
  929. </font>
  930. </table>
  931. <table width="100%" border="1" cellpadding="4" cellspacing="0">
  932. <tr valign="top">
  933. <th nowrap>Task Name</th>
  934. <th>Description</th>
  935. </tr>
  936. <tr valign="top">
  937. <td nowrap><a href="Integration/VAJAntTool.html">
  938. Visual Age for Java Tasks</a></td>
  939. <td><p>(See the documentation describing the Visual Age for Java
  940. tasks.)</p></td>
  941. </tr>
  942. </table>
  943. <hr>
  944. <p align="center">Copyright &copy; 2001-2002 Apache Software Foundation.
  945. All rights Reserved.</p>
  946. </body>
  947. </html>