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 34 KiB

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