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.

buildfile.html 28 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- Content Stylesheet for Site -->
  3. <!-- start the processing -->
  4. <html>
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
  7. <meta name="author" value="Adam Murdoch">
  8. <meta name="email" value="adammurdoch@apache.org">
  9. <title>Apache Myrmidon - User Guide</title>
  10. </head>
  11. <body bgcolor="#ffffff" text="#000000" link="#525D76">
  12. <table border="0" width="100%" cellspacing="0">
  13. <!-- TOP IMAGE -->
  14. <tr>
  15. <td> <td colspan="2">
  16. <a href="http://jakarta.apache.org"><img src="http://jakarta.apache.org/images/jakarta-logo.gif" align="left" border="0"/></a>
  17. </td>
  18. </td>
  19. <td valign="bottom"><div align="right"><b><font size="+3" color="#525D76">Apache Myrmidon</font></b></div></td>
  20. </tr>
  21. </table>
  22. <table border="0" width="100%" cellspacing="4">
  23. <tr><td colspan="2">
  24. <hr noshade="" size="1"/>
  25. </td></tr>
  26. <tr>
  27. <!-- LEFT SIDE NAVIGATION -->
  28. <td valign="top" nowrap="true">
  29. <p><strong>Myrmidon</strong></p>
  30. <ul>
  31. <li> <a href="./index.html">Introduction</a>
  32. </li>
  33. <li> <a href="./getinvolved.html">Get Involved</a>
  34. </li>
  35. <li> <a href="./user.html">Building Myrmidon</a>
  36. </li>
  37. <li> <a href="./todo.html">Todo List</a>
  38. </li>
  39. </ul>
  40. <p><strong>User Guide</strong></p>
  41. <ul>
  42. <li> <a href="./buildfile.html">Build file</a>
  43. </li>
  44. <li> <a href="./vfs.html">Virtual File System</a>
  45. </li>
  46. <li> <a href="./ant1compat.html">Ant1 Compatibility Layer</a>
  47. </li>
  48. <li> <a href="./differences.html">Differences to Ant1</a>
  49. </li>
  50. <li> <a href="./task.html">My First Task</a>
  51. </li>
  52. </ul>
  53. <p><strong>Extending Ant</strong></p>
  54. <ul>
  55. <li> <a href="./configuring.html">Configuration HOWTO</a>
  56. </li>
  57. <li> <a href="./converter.html">Converter HOWTO</a>
  58. </li>
  59. <li> <a href="./type.html">Type HOWTO</a>
  60. </li>
  61. <li> <a href="./classloader.html">ClassLoader HOWTO</a>
  62. </li>
  63. <li> <a href="./librarys.html">Library HOWTO</a>
  64. </li>
  65. </ul>
  66. <p><strong>Container Design</strong></p>
  67. <ul>
  68. </ul>
  69. </td>
  70. <td align="left" valign="top">
  71. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  72. <tr><td bgcolor="#525D76">
  73. <font color="#ffffff" face="arial,helvetica,sanserif">
  74. <a name="Project File"><strong>Project File</strong></a>
  75. </font>
  76. </td></tr>
  77. <tr><td>
  78. <blockquote>
  79. <p>
  80. The project file format is very similar to that of Ant 1. The root element of
  81. the project file must be a <code>&lt;project&gt;</code> element. It can
  82. take the following attributes:
  83. </p>
  84. <table>
  85. <tr>
  86. <td bgcolor="#039acc" colspan="" rowspan=""
  87. valign="top" align="left">
  88. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  89. Attribute
  90. </font>
  91. </td>
  92. <td bgcolor="#039acc" colspan="" rowspan=""
  93. valign="top" align="left">
  94. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  95. Description
  96. </font>
  97. </td>
  98. <td bgcolor="#039acc" colspan="" rowspan=""
  99. valign="top" align="left">
  100. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  101. Default Value
  102. </font>
  103. </td>
  104. </tr>
  105. <tr>
  106. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  107. valign="top" align="left">
  108. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  109. name
  110. </font>
  111. </td>
  112. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  113. valign="top" align="left">
  114. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  115. The project name.
  116. </font>
  117. </td>
  118. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  119. valign="top" align="left">
  120. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  121. The base-name of the project file, with the extension removed.
  122. </font>
  123. </td>
  124. </tr>
  125. <tr>
  126. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  127. valign="top" align="left">
  128. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  129. basedir
  130. </font>
  131. </td>
  132. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  133. valign="top" align="left">
  134. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  135. The base directory for the project. The base directory is used
  136. to resolve all relative file names used in the project file.
  137. </font>
  138. </td>
  139. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  140. valign="top" align="left">
  141. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  142. The directory containing the project file.
  143. </font>
  144. </td>
  145. </tr>
  146. <tr>
  147. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  148. valign="top" align="left">
  149. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  150. default
  151. </font>
  152. </td>
  153. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  154. valign="top" align="left">
  155. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  156. The name of the default target.
  157. </font>
  158. </td>
  159. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  160. valign="top" align="left">
  161. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  162. <code>main</code>
  163. </font>
  164. </td>
  165. </tr>
  166. <tr>
  167. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  168. valign="top" align="left">
  169. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  170. version
  171. </font>
  172. </td>
  173. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  174. valign="top" align="left">
  175. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  176. The project file version that the project is written for.
  177. </font>
  178. </td>
  179. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  180. valign="top" align="left">
  181. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  182. None, must be <code>2.0</code>
  183. </font>
  184. </td>
  185. </tr>
  186. </table>
  187. <p>
  188. A <code>&lt;project&gt;</code> element can contain the following elements,
  189. in the order given below:
  190. </p>
  191. <ul>
  192. <li><a href="#Project References"><code>&lt;projectref&gt;</code></a></li>
  193. <li><a href="#Library Imports"><code>&lt;import&gt;</code></a></li>
  194. <li><a href="#Implicit Tasks">Implicit tasks</a></li>
  195. <li><a href="#Targets"><code>&lt;target&gt;</code></a></li>
  196. </ul>
  197. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  198. <tr><td bgcolor="#828DA6">
  199. <font color="#ffffff" face="arial,helvetica,sanserif">
  200. <a name="Project References"><strong>Project References</strong></a>
  201. </font>
  202. </td></tr>
  203. <tr><td>
  204. <blockquote>
  205. <p>Project references allow the project to import, or reference, other projects.
  206. A <code>&lt;projectref&gt;</code> element takes the following attributes:</p>
  207. <table>
  208. <tr>
  209. <td bgcolor="#039acc" colspan="" rowspan=""
  210. valign="top" align="left">
  211. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  212. Attribute
  213. </font>
  214. </td>
  215. <td bgcolor="#039acc" colspan="" rowspan=""
  216. valign="top" align="left">
  217. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  218. Description
  219. </font>
  220. </td>
  221. <td bgcolor="#039acc" colspan="" rowspan=""
  222. valign="top" align="left">
  223. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  224. Default Value
  225. </font>
  226. </td>
  227. </tr>
  228. <tr>
  229. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  230. valign="top" align="left">
  231. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  232. name
  233. </font>
  234. </td>
  235. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  236. valign="top" align="left">
  237. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  238. The name to use to identify the referenced project.
  239. </font>
  240. </td>
  241. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  242. valign="top" align="left">
  243. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  244. Required
  245. </font>
  246. </td>
  247. </tr>
  248. <tr>
  249. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  250. valign="top" align="left">
  251. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  252. location
  253. </font>
  254. </td>
  255. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  256. valign="top" align="left">
  257. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  258. The path to the project file to reference.
  259. </font>
  260. </td>
  261. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  262. valign="top" align="left">
  263. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  264. Required
  265. </font>
  266. </td>
  267. </tr>
  268. </table>
  269. <p>
  270. The targets of a referenced project can be used in the <code>depends</code> list
  271. of a target in the referencing project, using the following syntax:
  272. <code><i>project-name</i>-&gt;<i>target-name</i></code>. Here is a simple example:</p>
  273. <div align="left">
  274. <table cellspacing="4" cellpadding="0" border="0">
  275. <tr>
  276. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  277. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  278. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  279. </tr>
  280. <tr>
  281. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  282. <td bgcolor="#ffffff"><pre>
  283. &lt;project version=&quot;2.0&quot;&gt;
  284. &lt;!-- Reference another project --&gt;
  285. &lt;projectref name=&quot;subproject&quot; location=&quot;subproject/build.xml&quot;/&gt;
  286. &lt;!-- Use the &quot;compile&quot; target from the referenced project --&gt;
  287. &lt;target name=&quot;main&quot; depends=&quot;subproject-&gt;compile&quot;&gt;
  288. .. do some stuff ..
  289. &lt;/target&gt;
  290. &lt;/project&gt;
  291. </pre></td>
  292. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  293. </tr>
  294. <tr>
  295. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  296. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  297. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  298. </tr>
  299. </table>
  300. </div>
  301. </blockquote>
  302. </td></tr>
  303. </table>
  304. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  305. <tr><td bgcolor="#828DA6">
  306. <font color="#ffffff" face="arial,helvetica,sanserif">
  307. <a name="Library Imports"><strong>Library Imports</strong></a>
  308. </font>
  309. </td></tr>
  310. <tr><td>
  311. <blockquote>
  312. <p>Library imports allow the project to import the tasks and data-types from an
  313. antlib. An <code>&lt;import&gt;</code> element takes the following attributes:</p>
  314. <table>
  315. <tr>
  316. <td bgcolor="#039acc" colspan="" rowspan=""
  317. valign="top" align="left">
  318. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  319. Attribute
  320. </font>
  321. </td>
  322. <td bgcolor="#039acc" colspan="" rowspan=""
  323. valign="top" align="left">
  324. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  325. Description
  326. </font>
  327. </td>
  328. <td bgcolor="#039acc" colspan="" rowspan=""
  329. valign="top" align="left">
  330. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  331. Default Value
  332. </font>
  333. </td>
  334. </tr>
  335. <tr>
  336. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  337. valign="top" align="left">
  338. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  339. library
  340. </font>
  341. </td>
  342. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  343. valign="top" align="left">
  344. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  345. The name of the library to import. The <code>ext</code> directory
  346. of the Myrmidon distribution is searched for a library file with
  347. the given name, and an <code>atl</code> extension.
  348. </font>
  349. </td>
  350. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  351. valign="top" align="left">
  352. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  353. Required
  354. </font>
  355. </td>
  356. </tr>
  357. <tr>
  358. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  359. valign="top" align="left">
  360. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  361. type
  362. </font>
  363. </td>
  364. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  365. valign="top" align="left">
  366. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  367. The type of definition to import. Values include <code>task</code>,
  368. and <code>data-type</code>.
  369. </font>
  370. </td>
  371. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  372. valign="top" align="left">
  373. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  374. None
  375. </font>
  376. </td>
  377. </tr>
  378. <tr>
  379. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  380. valign="top" align="left">
  381. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  382. name
  383. </font>
  384. </td>
  385. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  386. valign="top" align="left">
  387. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  388. The name of the type to import.
  389. </font>
  390. </td>
  391. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  392. valign="top" align="left">
  393. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  394. None
  395. </font>
  396. </td>
  397. </tr>
  398. </table>
  399. <p>
  400. If the <code>type</code> and <code>name</code> attributes are not provided,
  401. the entire contents of the antlib are imported.
  402. </p>
  403. <p>The following example import the <code>&lt;my-task&gt;</code> task from
  404. the <code>my-tasks</code> antlib.</p>
  405. <div align="left">
  406. <table cellspacing="4" cellpadding="0" border="0">
  407. <tr>
  408. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  409. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  410. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  411. </tr>
  412. <tr>
  413. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  414. <td bgcolor="#ffffff"><pre>
  415. &lt;project version=&quot;2.0&quot;&gt;
  416. &lt;!-- Import task &lt;my-task&gt; from the 'my-tasks' antlib. --&gt;
  417. &lt;import library=&quot;my-tasks&quot; type=&quot;task&quot; name=&quot;my-task&quot;/&gt;
  418. &lt;target name=&quot;main&quot;&gt;
  419. &lt;my-task some-prop=&quot;..&quot;/&gt;
  420. &lt;/target&gt;
  421. &lt;/project&gt;
  422. </pre></td>
  423. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  424. </tr>
  425. <tr>
  426. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  427. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  428. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  429. </tr>
  430. </table>
  431. </div>
  432. </blockquote>
  433. </td></tr>
  434. </table>
  435. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  436. <tr><td bgcolor="#828DA6">
  437. <font color="#ffffff" face="arial,helvetica,sanserif">
  438. <a name="Implicit Tasks"><strong>Implicit Tasks</strong></a>
  439. </font>
  440. </td></tr>
  441. <tr><td>
  442. <blockquote>
  443. <p>Implicit tasks are run before any of the project's targets are run. Any task
  444. can be used, including <code>&lt;property&gt;</code> and data-type instances.
  445. Implicit tasks can be used to initialise the project. For example:</p>
  446. <div align="left">
  447. <table cellspacing="4" cellpadding="0" border="0">
  448. <tr>
  449. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  450. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  451. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  452. </tr>
  453. <tr>
  454. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  455. <td bgcolor="#ffffff"><pre>
  456. &lt;project version=&quot;2.0&quot;&gt;
  457. &lt;property name=&quot;some-property&quot; value=&quot;some value&quot;/&gt;
  458. &lt;path id=&quot;classpath&quot;&gt;
  459. &lt;fileset dir=&quot;lib&quot;/&gt;
  460. &lt;/path&gt;
  461. &lt;log&gt;Set classpath to ${classpath}&lt;/log&gt;
  462. &lt;target name=&quot;main&quot;&gt;
  463. .. do some stuff ..
  464. &lt;/target&gt;
  465. &lt;/project&gt;
  466. </pre></td>
  467. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  468. </tr>
  469. <tr>
  470. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  471. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  472. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  473. </tr>
  474. </table>
  475. </div>
  476. </blockquote>
  477. </td></tr>
  478. </table>
  479. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  480. <tr><td bgcolor="#828DA6">
  481. <font color="#ffffff" face="arial,helvetica,sanserif">
  482. <a name="Targets"><strong>Targets</strong></a>
  483. </font>
  484. </td></tr>
  485. <tr><td>
  486. <blockquote>
  487. <p>Targets have a similar format to targets in Ant 1.x, though some of the
  488. behaviour is different. A <code>&lt;target&gt;</code> element takes the
  489. following attributes:</p>
  490. <table>
  491. <tr>
  492. <td bgcolor="#039acc" colspan="" rowspan=""
  493. valign="top" align="left">
  494. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  495. Attribute
  496. </font>
  497. </td>
  498. <td bgcolor="#039acc" colspan="" rowspan=""
  499. valign="top" align="left">
  500. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  501. Description
  502. </font>
  503. </td>
  504. <td bgcolor="#039acc" colspan="" rowspan=""
  505. valign="top" align="left">
  506. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  507. Default Value
  508. </font>
  509. </td>
  510. </tr>
  511. <tr>
  512. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  513. valign="top" align="left">
  514. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  515. name
  516. </font>
  517. </td>
  518. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  519. valign="top" align="left">
  520. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  521. The name of the target.
  522. </font>
  523. </td>
  524. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  525. valign="top" align="left">
  526. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  527. Required
  528. </font>
  529. </td>
  530. </tr>
  531. <tr>
  532. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  533. valign="top" align="left">
  534. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  535. depends
  536. </font>
  537. </td>
  538. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  539. valign="top" align="left">
  540. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  541. A comma-separated list of targets that this target depends on.
  542. This list can contain targets from referenced projects.
  543. </font>
  544. </td>
  545. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  546. valign="top" align="left">
  547. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  548. None
  549. </font>
  550. </td>
  551. </tr>
  552. </table>
  553. </blockquote>
  554. </td></tr>
  555. </table>
  556. </blockquote>
  557. </td></tr>
  558. </table>
  559. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  560. <tr><td bgcolor="#525D76">
  561. <font color="#ffffff" face="arial,helvetica,sanserif">
  562. <a name="Tasks"><strong>Tasks</strong></a>
  563. </font>
  564. </td></tr>
  565. <tr><td>
  566. <blockquote>
  567. <p>
  568. Listed below are some of the current set of tasks. You can find example
  569. usages of these tasks in the sample project file <code>src/make/sample.ant</code>.
  570. </p>
  571. <h3><code>&lt;condition&gt;</code></h3>
  572. <p>Sets a property if a particular condition is true. See
  573. <a href="#Conditions">Conditions</a> for a list of available conditions.</p>
  574. <h3><code>&lt;fail&gt;</code></h3>
  575. <p>Causes the build to fail.</p>
  576. <h3><code>&lt;if&gt;</code></h3>
  577. <p>Conditionally executes a set of tasks.</p>
  578. <h3><code>&lt;load-properties&gt;</code></h3>
  579. <p>Loads a set of properties from a file.</p>
  580. <h3><code>&lt;log&gt;</code></h3>
  581. <p>Writes a log message.</p>
  582. <h3><code>&lt;property&gt;</code></h3>
  583. <p>Sets a property.</p>
  584. <h3><code>&lt;try-catch&gt;</code></h3>
  585. <p>Runs a set of tasks, with a provided error and clean-up handler.</p>
  586. <h3><code>&lt;converter-def&gt;</code></h3>
  587. <p>Register a type converter. These are used when configuring a task
  588. or data-type from attributes.</p>
  589. <h3><code>&lt;type-def&gt;</code></h3>
  590. <p>Register a task or data-type.</p>
  591. <h3><code>&lt;import&gt;</code></h3>
  592. <p>Register the contents of an antlib.</p>
  593. </blockquote>
  594. </td></tr>
  595. </table>
  596. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  597. <tr><td bgcolor="#525D76">
  598. <font color="#ffffff" face="arial,helvetica,sanserif">
  599. <a name="Conditions"><strong>Conditions</strong></a>
  600. </font>
  601. </td></tr>
  602. <tr><td>
  603. <blockquote>
  604. <p>The following conditions are available </p>
  605. <h3><code>&lt;and&gt;</code></h3>
  606. <p>Evaluates a set of nested conditions, and AND them together. Evaluation is
  607. lazy. An empty <code>&lt;and&gt;</code> condition evaluates to true.</p>
  608. <h3><code>&lt;available&gt;</code></h3>
  609. <p>Tests if a particular class or resource is available.</p>
  610. <h3><code>&lt;file-test&gt;</code></h3>
  611. <p>Tests a file against a set of <a href="vfs.html#File Selectors">file selectors</a>.</p>
  612. <h3><code>&lt;is-set&gt;</code></h3>
  613. <p>Tests whether a proeprty is set, and not set to 'false'.</p>
  614. <h3><code>&lt;or&gt;</code></h3>
  615. <p>Evaluates a set of nested conditions, and OR them together. Evaluation is
  616. lazy. An empty <code>&lt;or&gt;</code> evaluates to true.</p>
  617. <h3><code>&lt;os&gt;</code></h3>
  618. <p>Tests which operating system the build is running on.</p>
  619. <h3><code>&lt;not&gt;</code></h3>
  620. <p>Negates a nested condition.</p>
  621. </blockquote>
  622. </td></tr>
  623. </table>
  624. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  625. <tr><td bgcolor="#525D76">
  626. <font color="#ffffff" face="arial,helvetica,sanserif">
  627. <a name="File Name Mappers"><strong>File Name Mappers</strong></a>
  628. </font>
  629. </td></tr>
  630. <tr><td>
  631. <blockquote>
  632. <p>The following file name mappers are available:</p>
  633. <h3><code>&lt;chain&gt;</code></h3>
  634. <p>Applies a set of nested file name mappers to file names.</p>
  635. <h3><code>&lt;flatten&gt;</code></h3>
  636. <p>Maps all file names to a single directory.</p>
  637. <h3><code>&lt;prefix&gt;</code></h3>
  638. <p>Adds a prefix to the front of each file name.</p>
  639. <h3><code>&lt;map-extension&gt;</code></h3>
  640. <p>Changes the extension of file names.</p>
  641. </blockquote>
  642. </td></tr>
  643. </table>
  644. </td>
  645. </tr>
  646. <!-- FOOTER -->
  647. <tr><td colspan="2">
  648. <hr noshade="" size="1"/>
  649. </td></tr>
  650. <tr><td colspan="2">
  651. <div align="center"><font color="#525D76" size="-1"><em>
  652. Copyright &#169; 2000-2002, Apache Software Foundation
  653. </em></font></div>
  654. </td></tr>
  655. </table>
  656. </body>
  657. </html>
  658. <!-- end the processing -->