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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785
  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. </ul>
  47. <p><strong>Extending Ant</strong></p>
  48. <ul>
  49. <li> <a href="./task.html">Task Writers HOWTO</a>
  50. </li>
  51. <li> <a href="./classloader.html">ClassLoader HOWTO</a>
  52. </li>
  53. <li> <a href="./librarys.html">Library HOWTO</a>
  54. </li>
  55. </ul>
  56. <p><strong>Container Design</strong></p>
  57. <ul>
  58. </ul>
  59. </td>
  60. <td align="left" valign="top">
  61. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  62. <tr><td bgcolor="#525D76">
  63. <font color="#ffffff" face="arial,helvetica,sanserif">
  64. <a name="Project File"><strong>Project File</strong></a>
  65. </font>
  66. </td></tr>
  67. <tr><td>
  68. <blockquote>
  69. <p>
  70. The project file format is very similar to that of Ant 1. The root element of
  71. the project file must be a <code>&lt;project&gt;</code> element. It can
  72. take the following attributes:
  73. </p>
  74. <table>
  75. <tr>
  76. <td bgcolor="#039acc" colspan="" rowspan=""
  77. valign="top" align="left">
  78. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  79. Attribute
  80. </font>
  81. </td>
  82. <td bgcolor="#039acc" colspan="" rowspan=""
  83. valign="top" align="left">
  84. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  85. Description
  86. </font>
  87. </td>
  88. <td bgcolor="#039acc" colspan="" rowspan=""
  89. valign="top" align="left">
  90. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  91. Default Value
  92. </font>
  93. </td>
  94. </tr>
  95. <tr>
  96. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  97. valign="top" align="left">
  98. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  99. name
  100. </font>
  101. </td>
  102. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  103. valign="top" align="left">
  104. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  105. The project name.
  106. </font>
  107. </td>
  108. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  109. valign="top" align="left">
  110. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  111. The base-name of the project file, with the extension removed.
  112. </font>
  113. </td>
  114. </tr>
  115. <tr>
  116. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  117. valign="top" align="left">
  118. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  119. basedir
  120. </font>
  121. </td>
  122. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  123. valign="top" align="left">
  124. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  125. The base directory for the project. The base directory is used
  126. to resolve all relative file names used in the project file.
  127. </font>
  128. </td>
  129. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  130. valign="top" align="left">
  131. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  132. The directory containing the project file.
  133. </font>
  134. </td>
  135. </tr>
  136. <tr>
  137. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  138. valign="top" align="left">
  139. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  140. default
  141. </font>
  142. </td>
  143. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  144. valign="top" align="left">
  145. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  146. The name of the default target.
  147. </font>
  148. </td>
  149. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  150. valign="top" align="left">
  151. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  152. <code>main</code>
  153. </font>
  154. </td>
  155. </tr>
  156. <tr>
  157. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  158. valign="top" align="left">
  159. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  160. version
  161. </font>
  162. </td>
  163. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  164. valign="top" align="left">
  165. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  166. The project file version that the project is written for.
  167. </font>
  168. </td>
  169. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  170. valign="top" align="left">
  171. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  172. None, must be <code>2.0</code>
  173. </font>
  174. </td>
  175. </tr>
  176. </table>
  177. <p>
  178. A <code>&lt;project&gt;</code> element can contain the following elements,
  179. in the order given below:
  180. </p>
  181. <ul>
  182. <li><a href="#Project References"><code>&lt;projectref&gt;</code></a></li>
  183. <li><a href="#Library Imports"><code>&lt;import&gt;</code></a></li>
  184. <li><a href="#Implicit Tasks">Implicit tasks</a></li>
  185. <li><a href="#Targets"><code>&lt;target&gt;</code></a></li>
  186. </ul>
  187. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  188. <tr><td bgcolor="#828DA6">
  189. <font color="#ffffff" face="arial,helvetica,sanserif">
  190. <a name="Project References"><strong>Project References</strong></a>
  191. </font>
  192. </td></tr>
  193. <tr><td>
  194. <blockquote>
  195. <p>Project references allow the project to import, or reference, other projects.
  196. A <code>&lt;projectref&gt;</code> element takes the following attributes:</p>
  197. <table>
  198. <tr>
  199. <td bgcolor="#039acc" colspan="" rowspan=""
  200. valign="top" align="left">
  201. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  202. Attribute
  203. </font>
  204. </td>
  205. <td bgcolor="#039acc" colspan="" rowspan=""
  206. valign="top" align="left">
  207. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  208. Description
  209. </font>
  210. </td>
  211. <td bgcolor="#039acc" colspan="" rowspan=""
  212. valign="top" align="left">
  213. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  214. Default Value
  215. </font>
  216. </td>
  217. </tr>
  218. <tr>
  219. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  220. valign="top" align="left">
  221. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  222. name
  223. </font>
  224. </td>
  225. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  226. valign="top" align="left">
  227. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  228. The name to use to identify the referenced project.
  229. </font>
  230. </td>
  231. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  232. valign="top" align="left">
  233. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  234. Required
  235. </font>
  236. </td>
  237. </tr>
  238. <tr>
  239. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  240. valign="top" align="left">
  241. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  242. location
  243. </font>
  244. </td>
  245. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  246. valign="top" align="left">
  247. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  248. The path to the project file to reference.
  249. </font>
  250. </td>
  251. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  252. valign="top" align="left">
  253. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  254. Required
  255. </font>
  256. </td>
  257. </tr>
  258. </table>
  259. <p>
  260. The targets of a referenced project can be used in the <code>depends</code> list
  261. of a target in the referencing project, using the following syntax:
  262. <code><i>project-name</i>-&gt;<i>target-name</i></code>. Here is a simple example:</p>
  263. <div align="left">
  264. <table cellspacing="4" cellpadding="0" border="0">
  265. <tr>
  266. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  267. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  268. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  269. </tr>
  270. <tr>
  271. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  272. <td bgcolor="#ffffff"><pre>
  273. &lt;project version=&quot;2.0&quot;&gt;
  274. &lt;!-- Reference another project --&gt;
  275. &lt;projectref name=&quot;subproject&quot; location=&quot;subproject/build.xml&quot;/&gt;
  276. &lt;!-- Use the &quot;compile&quot; target from the referenced project --&gt;
  277. &lt;target name=&quot;main&quot; depends=&quot;subproject-&gt;compile&quot;&gt;
  278. .. do some stuff ..
  279. &lt;/target&gt;
  280. &lt;/project&gt;
  281. </pre></td>
  282. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  283. </tr>
  284. <tr>
  285. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  286. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  287. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  288. </tr>
  289. </table>
  290. </div>
  291. </blockquote>
  292. </td></tr>
  293. </table>
  294. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  295. <tr><td bgcolor="#828DA6">
  296. <font color="#ffffff" face="arial,helvetica,sanserif">
  297. <a name="Library Imports"><strong>Library Imports</strong></a>
  298. </font>
  299. </td></tr>
  300. <tr><td>
  301. <blockquote>
  302. <p>Library imports allow the project to import the tasks and data-types from an
  303. antlib. An <code>&lt;import&gt;</code> element takes the following attributes:</p>
  304. <table>
  305. <tr>
  306. <td bgcolor="#039acc" colspan="" rowspan=""
  307. valign="top" align="left">
  308. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  309. Attribute
  310. </font>
  311. </td>
  312. <td bgcolor="#039acc" colspan="" rowspan=""
  313. valign="top" align="left">
  314. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  315. Description
  316. </font>
  317. </td>
  318. <td bgcolor="#039acc" colspan="" rowspan=""
  319. valign="top" align="left">
  320. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  321. Default Value
  322. </font>
  323. </td>
  324. </tr>
  325. <tr>
  326. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  327. valign="top" align="left">
  328. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  329. library
  330. </font>
  331. </td>
  332. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  333. valign="top" align="left">
  334. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  335. The name of the library to import. The <code>ext</code> directory
  336. of the Myrmidon distribution is searched for a library file with
  337. the given name, and an <code>atl</code> extension.
  338. </font>
  339. </td>
  340. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  341. valign="top" align="left">
  342. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  343. Required
  344. </font>
  345. </td>
  346. </tr>
  347. <tr>
  348. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  349. valign="top" align="left">
  350. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  351. type
  352. </font>
  353. </td>
  354. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  355. valign="top" align="left">
  356. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  357. The type of definition to import. Values include <code>task</code>,
  358. and <code>data-type</code>.
  359. </font>
  360. </td>
  361. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  362. valign="top" align="left">
  363. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  364. None
  365. </font>
  366. </td>
  367. </tr>
  368. <tr>
  369. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  370. valign="top" align="left">
  371. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  372. name
  373. </font>
  374. </td>
  375. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  376. valign="top" align="left">
  377. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  378. The name of the type to import.
  379. </font>
  380. </td>
  381. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  382. valign="top" align="left">
  383. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  384. None
  385. </font>
  386. </td>
  387. </tr>
  388. </table>
  389. <p>
  390. If the <code>type</code> and <code>name</code> attributes are not provided,
  391. the entire contents of the antlib are imported.
  392. </p>
  393. <p>The following example import the <code>&lt;my-task&gt;</code> task from
  394. the <code>my-tasks</code> antlib.</p>
  395. <div align="left">
  396. <table cellspacing="4" cellpadding="0" border="0">
  397. <tr>
  398. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  399. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  400. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  401. </tr>
  402. <tr>
  403. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  404. <td bgcolor="#ffffff"><pre>
  405. &lt;project version=&quot;2.0&quot;&gt;
  406. &lt;!-- Import task &lt;my-task&gt; from the 'my-tasks' antlib. --&gt;
  407. &lt;import library=&quot;my-tasks&quot; type=&quot;task&quot; name=&quot;my-task&quot;/&gt;
  408. &lt;target name=&quot;main&quot;&gt;
  409. &lt;my-task some-prop=&quot;..&quot;/&gt;
  410. &lt;/target&gt;
  411. &lt;/project&gt;
  412. </pre></td>
  413. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  414. </tr>
  415. <tr>
  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. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  418. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  419. </tr>
  420. </table>
  421. </div>
  422. </blockquote>
  423. </td></tr>
  424. </table>
  425. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  426. <tr><td bgcolor="#828DA6">
  427. <font color="#ffffff" face="arial,helvetica,sanserif">
  428. <a name="Implicit Tasks"><strong>Implicit Tasks</strong></a>
  429. </font>
  430. </td></tr>
  431. <tr><td>
  432. <blockquote>
  433. <p>Implicit tasks are run before any of the project's targets are run. Any task
  434. can be used, including <code>&lt;property&gt;</code> and data-type instances.
  435. Implicit tasks can be used to initialise the project. For example:</p>
  436. <div align="left">
  437. <table cellspacing="4" cellpadding="0" border="0">
  438. <tr>
  439. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  440. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  441. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  442. </tr>
  443. <tr>
  444. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  445. <td bgcolor="#ffffff"><pre>
  446. &lt;project version=&quot;2.0&quot;&gt;
  447. &lt;property name=&quot;some-property&quot; value=&quot;some value&quot;/&gt;
  448. &lt;path id=&quot;classpath&quot;&gt;
  449. &lt;fileset dir=&quot;lib&quot;/&gt;
  450. &lt;/path&gt;
  451. &lt;log&gt;Set classpath to ${classpath}&lt;/log&gt;
  452. &lt;target name=&quot;main&quot;&gt;
  453. .. do some stuff ..
  454. &lt;/target&gt;
  455. &lt;/project&gt;
  456. </pre></td>
  457. <td bgcolor="#023264" width="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" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  461. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  462. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  463. </tr>
  464. </table>
  465. </div>
  466. </blockquote>
  467. </td></tr>
  468. </table>
  469. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  470. <tr><td bgcolor="#828DA6">
  471. <font color="#ffffff" face="arial,helvetica,sanserif">
  472. <a name="Targets"><strong>Targets</strong></a>
  473. </font>
  474. </td></tr>
  475. <tr><td>
  476. <blockquote>
  477. <p>Targets have the same format as in Ant 1.x, though some of the behaviour
  478. is different. A <code>&lt;target&gt;</code> element takes the following
  479. attributes:</p>
  480. <table>
  481. <tr>
  482. <td bgcolor="#039acc" colspan="" rowspan=""
  483. valign="top" align="left">
  484. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  485. Attribute
  486. </font>
  487. </td>
  488. <td bgcolor="#039acc" colspan="" rowspan=""
  489. valign="top" align="left">
  490. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  491. Description
  492. </font>
  493. </td>
  494. <td bgcolor="#039acc" colspan="" rowspan=""
  495. valign="top" align="left">
  496. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  497. Default Value
  498. </font>
  499. </td>
  500. </tr>
  501. <tr>
  502. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  503. valign="top" align="left">
  504. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  505. name
  506. </font>
  507. </td>
  508. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  509. valign="top" align="left">
  510. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  511. The name of the target.
  512. </font>
  513. </td>
  514. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  515. valign="top" align="left">
  516. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  517. Required
  518. </font>
  519. </td>
  520. </tr>
  521. <tr>
  522. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  523. valign="top" align="left">
  524. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  525. depends
  526. </font>
  527. </td>
  528. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  529. valign="top" align="left">
  530. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  531. A comma-separated list of targets that this target depends on.
  532. This list can contain targets from referenced projects.
  533. </font>
  534. </td>
  535. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  536. valign="top" align="left">
  537. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  538. None
  539. </font>
  540. </td>
  541. </tr>
  542. <tr>
  543. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  544. valign="top" align="left">
  545. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  546. if
  547. </font>
  548. </td>
  549. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  550. valign="top" align="left">
  551. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  552. Only execute this target if the specified property is set, and not
  553. equal to <code>false</code>.
  554. </font>
  555. </td>
  556. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  557. valign="top" align="left">
  558. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  559. None
  560. </font>
  561. </td>
  562. </tr>
  563. <tr>
  564. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  565. valign="top" align="left">
  566. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  567. unless
  568. </font>
  569. </td>
  570. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  571. valign="top" align="left">
  572. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  573. Do not execute this target if the specified property is set, and not
  574. equal to <code>false</code>.
  575. </font>
  576. </td>
  577. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  578. valign="top" align="left">
  579. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  580. None
  581. </font>
  582. </td>
  583. </tr>
  584. </table>
  585. </blockquote>
  586. </td></tr>
  587. </table>
  588. </blockquote>
  589. </td></tr>
  590. </table>
  591. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  592. <tr><td bgcolor="#525D76">
  593. <font color="#ffffff" face="arial,helvetica,sanserif">
  594. <a name="Tasks"><strong>Tasks</strong></a>
  595. </font>
  596. </td></tr>
  597. <tr><td>
  598. <blockquote>
  599. <p>
  600. The following table lists some of the current set of tasks. You can find
  601. example usages of these tasks in the sample project file
  602. <code>src/make/sample.ant</code>.
  603. </p>
  604. <table>
  605. <tr>
  606. <td bgcolor="#039acc" colspan="" rowspan=""
  607. valign="top" align="left">
  608. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  609. Task
  610. </font>
  611. </td>
  612. <td bgcolor="#039acc" colspan="" rowspan=""
  613. valign="top" align="left">
  614. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  615. Description
  616. </font>
  617. </td>
  618. </tr>
  619. <tr>
  620. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  621. valign="top" align="left">
  622. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  623. fail
  624. </font>
  625. </td>
  626. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  627. valign="top" align="left">
  628. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  629. Causes the build to fail.
  630. </font>
  631. </td>
  632. </tr>
  633. <tr>
  634. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  635. valign="top" align="left">
  636. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  637. if
  638. </font>
  639. </td>
  640. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  641. valign="top" align="left">
  642. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  643. Conditionally executes a set of tasks.
  644. </font>
  645. </td>
  646. </tr>
  647. <tr>
  648. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  649. valign="top" align="left">
  650. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  651. load-properties
  652. </font>
  653. </td>
  654. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  655. valign="top" align="left">
  656. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  657. Loads a set of properties from a file.
  658. </font>
  659. </td>
  660. </tr>
  661. <tr>
  662. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  663. valign="top" align="left">
  664. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  665. log
  666. </font>
  667. </td>
  668. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  669. valign="top" align="left">
  670. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  671. Writes a log message.
  672. </font>
  673. </td>
  674. </tr>
  675. <tr>
  676. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  677. valign="top" align="left">
  678. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  679. property
  680. </font>
  681. </td>
  682. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  683. valign="top" align="left">
  684. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  685. Sets a property.
  686. </font>
  687. </td>
  688. </tr>
  689. <tr>
  690. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  691. valign="top" align="left">
  692. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  693. try-catch
  694. </font>
  695. </td>
  696. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  697. valign="top" align="left">
  698. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  699. Runs a set of tasks, with a provided error and clean-up handler.
  700. </font>
  701. </td>
  702. </tr>
  703. <tr>
  704. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  705. valign="top" align="left">
  706. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  707. converter-def
  708. </font>
  709. </td>
  710. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  711. valign="top" align="left">
  712. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  713. Register a type converter. These are used when configuring a task
  714. or data-type from attributes.
  715. </font>
  716. </td>
  717. </tr>
  718. <tr>
  719. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  720. valign="top" align="left">
  721. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  722. type-def
  723. </font>
  724. </td>
  725. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  726. valign="top" align="left">
  727. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  728. Register a task or data-type.
  729. </font>
  730. </td>
  731. </tr>
  732. <tr>
  733. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  734. valign="top" align="left">
  735. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  736. import
  737. </font>
  738. </td>
  739. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  740. valign="top" align="left">
  741. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  742. Register the contents of an antlib.
  743. </font>
  744. </td>
  745. </tr>
  746. </table>
  747. </blockquote>
  748. </td></tr>
  749. </table>
  750. </td>
  751. </tr>
  752. <!-- FOOTER -->
  753. <tr><td colspan="2">
  754. <hr noshade="" size="1"/>
  755. </td></tr>
  756. <tr><td colspan="2">
  757. <div align="center"><font color="#525D76" size="-1"><em>
  758. Copyright &#169; 2000-2002, Apache Software Foundation
  759. </em></font></div>
  760. </td></tr>
  761. </table>
  762. </body>
  763. </html>
  764. <!-- end the processing -->