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 29 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685
  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">Project File</a>
  43. </li>
  44. <li> <a href="./vfs.html">Virtual File System</a>
  45. </li>
  46. <li> <a href="./ant1compat.html">Ant 1 Compatibility Layer</a>
  47. </li>
  48. <li> <a href="./differences.html">Differences to Ant 1</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. A project file is an XML file that describes which tasks to execute, and in
  81. which order to execute them in. A project can be broken up into several steps,
  82. or <i>targets</i>. A target is simply a list of the tasks that need to be
  83. executed to perform the step. A target may also include some dependency
  84. information. Myrmidon makes sure that targets are executed in the correct order,
  85. so that a target is executed before the targets that depend on it.</p>
  86. <p>The project file format is very similar to the format used in Ant 1. The
  87. root element of a project file must be a <code>&lt;project&gt;</code> element.
  88. It can take the following attributes:
  89. </p>
  90. <table>
  91. <tr>
  92. <td bgcolor="#039acc" colspan="" rowspan=""
  93. valign="top" align="left">
  94. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  95. Attribute
  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. Description
  102. </font>
  103. </td>
  104. <td bgcolor="#039acc" colspan="" rowspan=""
  105. valign="top" align="left">
  106. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  107. Default Value
  108. </font>
  109. </td>
  110. </tr>
  111. <tr>
  112. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  113. valign="top" align="left">
  114. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  115. 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 project name.
  122. </font>
  123. </td>
  124. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  125. valign="top" align="left">
  126. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  127. The name of the project file, with the extension removed.
  128. </font>
  129. </td>
  130. </tr>
  131. <tr>
  132. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  133. valign="top" align="left">
  134. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  135. basedir
  136. </font>
  137. </td>
  138. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  139. valign="top" align="left">
  140. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  141. The base directory for the project. The base directory is used
  142. to resolve all relative file names used in the project file.
  143. </font>
  144. </td>
  145. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  146. valign="top" align="left">
  147. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  148. The directory containing the project file.
  149. </font>
  150. </td>
  151. </tr>
  152. <tr>
  153. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  154. valign="top" align="left">
  155. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  156. default
  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. The name of the default target.
  163. </font>
  164. </td>
  165. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  166. valign="top" align="left">
  167. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  168. <code>main</code>
  169. </font>
  170. </td>
  171. </tr>
  172. <tr>
  173. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  174. valign="top" align="left">
  175. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  176. version
  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. The project file format version that the project is written for.
  183. </font>
  184. </td>
  185. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  186. valign="top" align="left">
  187. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  188. None, must be <code>2.0</code>
  189. </font>
  190. </td>
  191. </tr>
  192. </table>
  193. <p>
  194. A <code>&lt;project&gt;</code> element can contain the following elements,
  195. in the order given below:
  196. </p>
  197. <ul>
  198. <li><a href="#project-refs">Project references</a></li>
  199. <li><a href="#antlib-imports">Library imports</a></li>
  200. <li><a href="#init-tasks">Initialization tasks</a></li>
  201. <li><a href="#targets">Targets</a></li>
  202. </ul>
  203. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  204. <tr><td bgcolor="#828DA6">
  205. <font color="#ffffff" face="arial,helvetica,sanserif">
  206. <a name="project-refs"><strong>Project References</strong></a>
  207. </font>
  208. </td></tr>
  209. <tr><td>
  210. <blockquote>
  211. <p>Project references allow the project to import, or reference, other projects.
  212. A <code>&lt;projectref&gt;</code> element takes the following attributes:</p>
  213. <table>
  214. <tr>
  215. <td bgcolor="#039acc" colspan="" rowspan=""
  216. valign="top" align="left">
  217. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  218. Attribute
  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. Description
  225. </font>
  226. </td>
  227. <td bgcolor="#039acc" colspan="" rowspan=""
  228. valign="top" align="left">
  229. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  230. Default Value
  231. </font>
  232. </td>
  233. </tr>
  234. <tr>
  235. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  236. valign="top" align="left">
  237. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  238. name
  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. The name to use to identify the referenced project.
  245. </font>
  246. </td>
  247. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  248. valign="top" align="left">
  249. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  250. Required
  251. </font>
  252. </td>
  253. </tr>
  254. <tr>
  255. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  256. valign="top" align="left">
  257. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  258. location
  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. The path to the project file to reference.
  265. </font>
  266. </td>
  267. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  268. valign="top" align="left">
  269. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  270. Required
  271. </font>
  272. </td>
  273. </tr>
  274. </table>
  275. <p>
  276. The targets of a referenced project can be used in the <code>depends</code> list
  277. of a target in the referencing project, using the syntax
  278. <code><i>project-name</i>-&gt;<i>target-name</i></code>. Here is a simple example:</p>
  279. <div align="left">
  280. <table cellspacing="4" cellpadding="0" border="0">
  281. <tr>
  282. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  283. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  284. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  285. </tr>
  286. <tr>
  287. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  288. <td bgcolor="#ffffff"><pre>
  289. &lt;project version=&quot;2.0&quot;&gt;
  290. &lt;!-- Reference another project --&gt;
  291. &lt;projectref name=&quot;subproject&quot; location=&quot;subproject/build.xml&quot;/&gt;
  292. &lt;!-- Use the &quot;compile&quot; target from the referenced project --&gt;
  293. &lt;target name=&quot;main&quot; depends=&quot;subproject-&gt;compile&quot;&gt;
  294. .. do some stuff ..
  295. &lt;/target&gt;
  296. &lt;/project&gt;
  297. </pre></td>
  298. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  299. </tr>
  300. <tr>
  301. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  302. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  303. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  304. </tr>
  305. </table>
  306. </div>
  307. </blockquote>
  308. </td></tr>
  309. </table>
  310. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  311. <tr><td bgcolor="#828DA6">
  312. <font color="#ffffff" face="arial,helvetica,sanserif">
  313. <a name="antlib-imports"><strong>Library Imports</strong></a>
  314. </font>
  315. </td></tr>
  316. <tr><td>
  317. <blockquote>
  318. <p>Library imports allow the project to import the tasks and data-types from an
  319. antlib. An <code>&lt;import&gt;</code> element takes the following attributes:</p>
  320. <table>
  321. <tr>
  322. <td bgcolor="#039acc" colspan="" rowspan=""
  323. valign="top" align="left">
  324. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  325. Attribute
  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. Description
  332. </font>
  333. </td>
  334. <td bgcolor="#039acc" colspan="" rowspan=""
  335. valign="top" align="left">
  336. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  337. Default Value
  338. </font>
  339. </td>
  340. </tr>
  341. <tr>
  342. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  343. valign="top" align="left">
  344. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  345. library
  346. </font>
  347. </td>
  348. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  349. valign="top" align="left">
  350. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  351. The name of the library to import. The <code>ext</code> directory
  352. of the Myrmidon distribution is searched for a library file with
  353. the given name, and an <code>atl</code> extension.
  354. </font>
  355. </td>
  356. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  357. valign="top" align="left">
  358. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  359. Required
  360. </font>
  361. </td>
  362. </tr>
  363. <tr>
  364. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  365. valign="top" align="left">
  366. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  367. type
  368. </font>
  369. </td>
  370. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  371. valign="top" align="left">
  372. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  373. The type of definition to import. Values include <code>task</code>,
  374. and <code>data-type</code>.
  375. </font>
  376. </td>
  377. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  378. valign="top" align="left">
  379. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  380. None
  381. </font>
  382. </td>
  383. </tr>
  384. <tr>
  385. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  386. valign="top" align="left">
  387. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  388. name
  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. The name of the type to import.
  395. </font>
  396. </td>
  397. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  398. valign="top" align="left">
  399. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  400. None
  401. </font>
  402. </td>
  403. </tr>
  404. </table>
  405. <p>
  406. If the <code>type</code> and <code>name</code> attributes are not provided,
  407. the entire contents of the antlib are imported.
  408. </p>
  409. <p>The following example import the <code>&lt;my-task&gt;</code> task from
  410. the <code>my-tasks</code> antlib.</p>
  411. <div align="left">
  412. <table cellspacing="4" cellpadding="0" border="0">
  413. <tr>
  414. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  415. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  416. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  417. </tr>
  418. <tr>
  419. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  420. <td bgcolor="#ffffff"><pre>
  421. &lt;project version=&quot;2.0&quot;&gt;
  422. &lt;!-- Import task &lt;my-task&gt; from the 'my-tasks' antlib. --&gt;
  423. &lt;import library=&quot;my-tasks&quot; type=&quot;task&quot; name=&quot;my-task&quot;/&gt;
  424. &lt;target name=&quot;main&quot;&gt;
  425. &lt;my-task some-prop=&quot;..&quot;/&gt;
  426. &lt;/target&gt;
  427. &lt;/project&gt;
  428. </pre></td>
  429. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  430. </tr>
  431. <tr>
  432. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  433. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  434. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  435. </tr>
  436. </table>
  437. </div>
  438. </blockquote>
  439. </td></tr>
  440. </table>
  441. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  442. <tr><td bgcolor="#828DA6">
  443. <font color="#ffffff" face="arial,helvetica,sanserif">
  444. <a name="init-tasks"><strong>Initialization Tasks</strong></a>
  445. </font>
  446. </td></tr>
  447. <tr><td>
  448. <blockquote>
  449. <p>Initialisation tasks are run before any of the project's targets are run, and
  450. are used to initialise the project. Any task can be used as an initialization
  451. task, including <code>&lt;property&gt;</code> and data-type instances. An example:</p>
  452. <div align="left">
  453. <table cellspacing="4" cellpadding="0" border="0">
  454. <tr>
  455. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  456. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  457. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  458. </tr>
  459. <tr>
  460. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  461. <td bgcolor="#ffffff"><pre>
  462. &lt;project version=&quot;2.0&quot;&gt;
  463. &lt;property name=&quot;some-property&quot; value=&quot;some value&quot;/&gt;
  464. &lt;path id=&quot;classpath&quot;&gt;
  465. &lt;fileset dir=&quot;lib&quot;/&gt;
  466. &lt;/path&gt;
  467. &lt;log&gt;Set classpath to ${classpath}&lt;/log&gt;
  468. &lt;target name=&quot;main&quot;&gt;
  469. .. do some stuff ..
  470. &lt;/target&gt;
  471. &lt;/project&gt;
  472. </pre></td>
  473. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  474. </tr>
  475. <tr>
  476. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  477. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  478. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  479. </tr>
  480. </table>
  481. </div>
  482. </blockquote>
  483. </td></tr>
  484. </table>
  485. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  486. <tr><td bgcolor="#828DA6">
  487. <font color="#ffffff" face="arial,helvetica,sanserif">
  488. <a name="targets"><strong>Targets</strong></a>
  489. </font>
  490. </td></tr>
  491. <tr><td>
  492. <blockquote>
  493. <p>Targets have a similar format to targets in Ant 1.x, though some of the
  494. behaviour is different. A <code>&lt;target&gt;</code> element takes the
  495. following attributes:</p>
  496. <table>
  497. <tr>
  498. <td bgcolor="#039acc" colspan="" rowspan=""
  499. valign="top" align="left">
  500. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  501. Attribute
  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. Description
  508. </font>
  509. </td>
  510. <td bgcolor="#039acc" colspan="" rowspan=""
  511. valign="top" align="left">
  512. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  513. Default Value
  514. </font>
  515. </td>
  516. </tr>
  517. <tr>
  518. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  519. valign="top" align="left">
  520. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  521. name
  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. The name of the target.
  528. </font>
  529. </td>
  530. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  531. valign="top" align="left">
  532. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  533. Required
  534. </font>
  535. </td>
  536. </tr>
  537. <tr>
  538. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  539. valign="top" align="left">
  540. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  541. depends
  542. </font>
  543. </td>
  544. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  545. valign="top" align="left">
  546. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  547. A comma-separated list of targets that this target depends on.
  548. This list can contain targets from referenced projects.
  549. </font>
  550. </td>
  551. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  552. valign="top" align="left">
  553. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  554. None
  555. </font>
  556. </td>
  557. </tr>
  558. </table>
  559. </blockquote>
  560. </td></tr>
  561. </table>
  562. </blockquote>
  563. </td></tr>
  564. </table>
  565. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  566. <tr><td bgcolor="#525D76">
  567. <font color="#ffffff" face="arial,helvetica,sanserif">
  568. <a name="Tasks"><strong>Tasks</strong></a>
  569. </font>
  570. </td></tr>
  571. <tr><td>
  572. <blockquote>
  573. <p>
  574. Listed below are some of the current set of tasks. You can find example
  575. usages of these tasks in the sample project file <code>src/make/sample.ant</code>.
  576. </p>
  577. <h3><code>&lt;condition&gt;</code></h3>
  578. <p>Sets a property if a particular condition is true. See
  579. <a href="#Conditions">Conditions</a> for a list of available conditions.</p>
  580. <h3><code>&lt;fail&gt;</code></h3>
  581. <p>Causes the build to fail.</p>
  582. <h3><code>&lt;if&gt;</code></h3>
  583. <p>Conditionally executes a set of tasks.</p>
  584. <h3><code>&lt;load-properties&gt;</code></h3>
  585. <p>Loads a set of properties from a file.</p>
  586. <h3><code>&lt;log&gt;</code></h3>
  587. <p>Writes a log message.</p>
  588. <h3><code>&lt;property&gt;</code></h3>
  589. <p>Sets a property.</p>
  590. <h3><code>&lt;try-catch&gt;</code></h3>
  591. <p>Runs a set of tasks, with a provided error and clean-up handler.</p>
  592. <h3><code>&lt;converter-def&gt;</code></h3>
  593. <p>Register a type converter. These are used when configuring a task
  594. or data-type from attributes.</p>
  595. <h3><code>&lt;type-def&gt;</code></h3>
  596. <p>Register a task or data-type.</p>
  597. <h3><code>&lt;import&gt;</code></h3>
  598. <p>Register the contents of an antlib.</p>
  599. </blockquote>
  600. </td></tr>
  601. </table>
  602. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  603. <tr><td bgcolor="#525D76">
  604. <font color="#ffffff" face="arial,helvetica,sanserif">
  605. <a name="Conditions"><strong>Conditions</strong></a>
  606. </font>
  607. </td></tr>
  608. <tr><td>
  609. <blockquote>
  610. <p>The following conditions are available </p>
  611. <h3><code>&lt;and&gt;</code></h3>
  612. <p>Evaluates a set of nested conditions, and AND them together. Evaluation is
  613. lazy. An empty <code>&lt;and&gt;</code> condition evaluates to true.</p>
  614. <h3><code>&lt;available&gt;</code></h3>
  615. <p>Tests if a particular class or resource is available.</p>
  616. <h3><code>&lt;file-test&gt;</code></h3>
  617. <p>Tests a file against a set of <a href="vfs.html#File Selectors">file selectors</a>.</p>
  618. <h3><code>&lt;is-set&gt;</code></h3>
  619. <p>Tests whether a proeprty is set, and not set to 'false'.</p>
  620. <h3><code>&lt;or&gt;</code></h3>
  621. <p>Evaluates a set of nested conditions, and OR them together. Evaluation is
  622. lazy. An empty <code>&lt;or&gt;</code> evaluates to true.</p>
  623. <h3><code>&lt;os&gt;</code></h3>
  624. <p>Tests which operating system the build is running on.</p>
  625. <h3><code>&lt;not&gt;</code></h3>
  626. <p>Negates a nested condition.</p>
  627. </blockquote>
  628. </td></tr>
  629. </table>
  630. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  631. <tr><td bgcolor="#525D76">
  632. <font color="#ffffff" face="arial,helvetica,sanserif">
  633. <a name="File Name Mappers"><strong>File Name Mappers</strong></a>
  634. </font>
  635. </td></tr>
  636. <tr><td>
  637. <blockquote>
  638. <p>The following file name mappers are available:</p>
  639. <h3><code>&lt;chain&gt;</code></h3>
  640. <p>Applies a set of nested file name mappers to file names.</p>
  641. <h3><code>&lt;flatten&gt;</code></h3>
  642. <p>Maps all file names to a single directory.</p>
  643. <h3><code>&lt;prefix&gt;</code></h3>
  644. <p>Adds a prefix to the front of each file name.</p>
  645. <h3><code>&lt;map-extension&gt;</code></h3>
  646. <p>Changes the extension of file names.</p>
  647. </blockquote>
  648. </td></tr>
  649. </table>
  650. </td>
  651. </tr>
  652. <!-- FOOTER -->
  653. <tr><td colspan="2">
  654. <hr noshade="" size="1"/>
  655. </td></tr>
  656. <tr><td colspan="2">
  657. <div align="center"><font color="#525D76" size="-1"><em>
  658. Copyright &#169; 2000-2002, Apache Software Foundation
  659. </em></font></div>
  660. </td></tr>
  661. </table>
  662. </body>
  663. </html>
  664. <!-- end the processing -->