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.

user.html 53 kB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303
  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 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. </tr>
  19. </table>
  20. <table border="0" width="100%" cellspacing="4">
  21. <tr><td colspan="2">
  22. <hr noshade="" size="1"/>
  23. </td></tr>
  24. <tr>
  25. <!-- LEFT SIDE NAVIGATION -->
  26. <td valign="top" nowrap="true">
  27. <p><strong>Myrmidon</strong></p>
  28. <ul>
  29. <li> <a href="./index.html">Introduction</a>
  30. </li>
  31. <li> <a href="./user.html">User Guide</a>
  32. </li>
  33. <li> <a href="./todo.html">Get Involved</a>
  34. </li>
  35. <li> <a href="./todo.html#Todo List">Todo List</a>
  36. </li>
  37. </ul>
  38. </td>
  39. <td align="left" valign="top">
  40. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  41. <tr><td bgcolor="#525D76">
  42. <font color="#ffffff" face="arial,helvetica,sanserif">
  43. <a name="Building Myrmidon"><strong>Building Myrmidon</strong></a>
  44. </font>
  45. </td></tr>
  46. <tr><td>
  47. <blockquote>
  48. <p>
  49. First, you will need to fetch the Myrmidon source from CVS. The source
  50. can be source in the <code>proposal/myrmidon</code> directory of the
  51. Ant source tree. You should check out the <code>jakarta-ant</code> CVS
  52. module, as described
  53. <a href="http://jakarta.apache.org/site/cvsindex.html">here</a>.
  54. </p>
  55. <p>
  56. To build Myrmidon, use the <code>build.xml</code> build script. You will need
  57. to use Ant 1.4.1 or later. The default target builds the Myrmidon distribution
  58. into the <code>dist</code> directory. The distribution is a ready-to-run
  59. installation of Myrmidon.
  60. </p>
  61. <p>There are a number features that are not built unless the appropriate optional Jar
  62. files are found in the <code>lib</code> directory:</p>
  63. <table>
  64. <tr>
  65. <td bgcolor="#039acc" colspan="" rowspan=""
  66. valign="top" align="left">
  67. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  68. Feature
  69. </font>
  70. </td>
  71. <td bgcolor="#039acc" colspan="" rowspan=""
  72. valign="top" align="left">
  73. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  74. Jar File
  75. </font>
  76. </td>
  77. <td bgcolor="#039acc" colspan="" rowspan=""
  78. valign="top" align="left">
  79. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  80. Download From
  81. </font>
  82. </td>
  83. </tr>
  84. <tr>
  85. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  86. valign="top" align="left">
  87. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  88. SMB VFS support (Samba, Windows shares)
  89. </font>
  90. </td>
  91. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  92. valign="top" align="left">
  93. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  94. jcifs.jar
  95. </font>
  96. </td>
  97. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  98. valign="top" align="left">
  99. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  100. <a href="http://jcifs.samba.org">jcifs.samba.org</a>
  101. </font>
  102. </td>
  103. </tr>
  104. <tr>
  105. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  106. valign="top" align="left">
  107. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  108. FTP VFS support
  109. </font>
  110. </td>
  111. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  112. valign="top" align="left">
  113. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  114. netcomponents.jar
  115. </font>
  116. </td>
  117. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  118. valign="top" align="left">
  119. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  120. <a href="http://www.savarese.org/oro/software/NetComponents.html">www.savarese.org</a>
  121. </font>
  122. </td>
  123. </tr>
  124. </table>
  125. </blockquote>
  126. </td></tr>
  127. </table>
  128. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  129. <tr><td bgcolor="#525D76">
  130. <font color="#ffffff" face="arial,helvetica,sanserif">
  131. <a name="Running Myrmidon"><strong>Running Myrmidon</strong></a>
  132. </font>
  133. </td></tr>
  134. <tr><td>
  135. <blockquote>
  136. <p>
  137. To run Myrmidon, use one of the following methods:
  138. </p>
  139. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  140. <tr><td bgcolor="#828DA6">
  141. <font color="#ffffff" face="arial,helvetica,sanserif">
  142. <a name="Launcher Script"><strong>Launcher Script</strong></a>
  143. </font>
  144. </td></tr>
  145. <tr><td>
  146. <blockquote>
  147. <p>
  148. On Windows and Unix platforms, you can use the <code>ant</code> script
  149. in the distribution's <code>bin</code> directory. The following environment
  150. variables can be used, but are not required (except on Windows 9x - see below).
  151. </p>
  152. <p>
  153. </p>
  154. <table>
  155. <tr>
  156. <td bgcolor="#039acc" colspan="" rowspan=""
  157. valign="top" align="left">
  158. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  159. Variable
  160. </font>
  161. </td>
  162. <td bgcolor="#039acc" colspan="" rowspan=""
  163. valign="top" align="left">
  164. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  165. Description
  166. </font>
  167. </td>
  168. </tr>
  169. <tr>
  170. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  171. valign="top" align="left">
  172. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  173. JAVA_HOME
  174. </font>
  175. </td>
  176. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  177. valign="top" align="left">
  178. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  179. The directory that the JDK is installed in.
  180. </font>
  181. </td>
  182. </tr>
  183. <tr>
  184. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  185. valign="top" align="left">
  186. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  187. JAVACMD
  188. </font>
  189. </td>
  190. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  191. valign="top" align="left">
  192. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  193. The command to use to start the JVM. Defaults to <code>java</code>.
  194. </font>
  195. </td>
  196. </tr>
  197. <tr>
  198. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  199. valign="top" align="left">
  200. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  201. ANT_HOME
  202. </font>
  203. </td>
  204. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  205. valign="top" align="left">
  206. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  207. The directory containing the Myrmidon distribution. This must be
  208. set when running on Windows 95, 98 or Me.
  209. </font>
  210. </td>
  211. </tr>
  212. </table>
  213. </blockquote>
  214. </td></tr>
  215. </table>
  216. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  217. <tr><td bgcolor="#828DA6">
  218. <font color="#ffffff" face="arial,helvetica,sanserif">
  219. <a name="Executable Jar File"><strong>Executable Jar File</strong></a>
  220. </font>
  221. </td></tr>
  222. <tr><td>
  223. <blockquote>
  224. <p>
  225. The Myrmidon distribution includes an executable Jar file, which can be used
  226. to run Myrmidon. Use the following command:
  227. </p>
  228. <pre>
  229. prompt&gt; <i>java</i> -jar <i>ant-home</i>/bin/myrmidon-launcher.jar <i>options</i>
  230. </pre>
  231. </blockquote>
  232. </td></tr>
  233. </table>
  234. <p>When started, Myrmidon looks for a project file called <code>build.ant</code>
  235. in the current directory. A different project file can be specified using the
  236. <code>-f</code> command-line option. Myrmidon executes the targets given on
  237. the command-line, or the default target if none is given. For example, the
  238. following executes the targets <code>clean</code> and <code>build</code> from
  239. the project file <code>my-project.xml</code>:</p>
  240. <pre>
  241. prompt&gt; ant -f my-project.xml clean build
  242. </pre>
  243. <p>
  244. Run Myrmidon with the <code>-h</code> command-line option for a list of
  245. the command-line options that are available.
  246. </p>
  247. </blockquote>
  248. </td></tr>
  249. </table>
  250. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  251. <tr><td bgcolor="#525D76">
  252. <font color="#ffffff" face="arial,helvetica,sanserif">
  253. <a name="Project File"><strong>Project File</strong></a>
  254. </font>
  255. </td></tr>
  256. <tr><td>
  257. <blockquote>
  258. <p>
  259. The project file format is very similar to that of Ant 1. The root element of
  260. the project file must be a <code>&lt;project&gt;</code> element. It can
  261. take the following attributes:
  262. </p>
  263. <table>
  264. <tr>
  265. <td bgcolor="#039acc" colspan="" rowspan=""
  266. valign="top" align="left">
  267. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  268. Attribute
  269. </font>
  270. </td>
  271. <td bgcolor="#039acc" colspan="" rowspan=""
  272. valign="top" align="left">
  273. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  274. Description
  275. </font>
  276. </td>
  277. <td bgcolor="#039acc" colspan="" rowspan=""
  278. valign="top" align="left">
  279. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  280. Default Value
  281. </font>
  282. </td>
  283. </tr>
  284. <tr>
  285. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  286. valign="top" align="left">
  287. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  288. name
  289. </font>
  290. </td>
  291. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  292. valign="top" align="left">
  293. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  294. The project name.
  295. </font>
  296. </td>
  297. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  298. valign="top" align="left">
  299. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  300. The base-name of the project file, with the extension removed.
  301. </font>
  302. </td>
  303. </tr>
  304. <tr>
  305. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  306. valign="top" align="left">
  307. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  308. basedir
  309. </font>
  310. </td>
  311. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  312. valign="top" align="left">
  313. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  314. The base directory for the project. The base directory is used
  315. to resolve all relative file names used in the project file.
  316. </font>
  317. </td>
  318. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  319. valign="top" align="left">
  320. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  321. The directory containing the project file.
  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. default
  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 default target.
  336. </font>
  337. </td>
  338. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  339. valign="top" align="left">
  340. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  341. <code>main</code>
  342. </font>
  343. </td>
  344. </tr>
  345. <tr>
  346. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  347. valign="top" align="left">
  348. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  349. version
  350. </font>
  351. </td>
  352. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  353. valign="top" align="left">
  354. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  355. The project file version that the project is written for.
  356. </font>
  357. </td>
  358. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  359. valign="top" align="left">
  360. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  361. None, must be <code>2.0</code>
  362. </font>
  363. </td>
  364. </tr>
  365. </table>
  366. <p>
  367. A <code>&lt;project&gt;</code> element can contain the following elements,
  368. in the order given below:
  369. </p>
  370. <ul>
  371. <li><a href="#Project References"><code>&lt;projectref&gt;</code></a></li>
  372. <li><a href="#Library Imports"><code>&lt;import&gt;</code></a></li>
  373. <li><a href="#Implicit Tasks">Implicit tasks</a></li>
  374. <li><a href="#Targets"><code>&lt;target&gt;</code></a></li>
  375. </ul>
  376. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  377. <tr><td bgcolor="#828DA6">
  378. <font color="#ffffff" face="arial,helvetica,sanserif">
  379. <a name="Project References"><strong>Project References</strong></a>
  380. </font>
  381. </td></tr>
  382. <tr><td>
  383. <blockquote>
  384. <p>Project references allow the project to import, or reference, other projects.
  385. A <code>&lt;projectref&gt;</code> element takes the following attributes:</p>
  386. <table>
  387. <tr>
  388. <td bgcolor="#039acc" colspan="" rowspan=""
  389. valign="top" align="left">
  390. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  391. Attribute
  392. </font>
  393. </td>
  394. <td bgcolor="#039acc" colspan="" rowspan=""
  395. valign="top" align="left">
  396. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  397. Description
  398. </font>
  399. </td>
  400. <td bgcolor="#039acc" colspan="" rowspan=""
  401. valign="top" align="left">
  402. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  403. Default Value
  404. </font>
  405. </td>
  406. </tr>
  407. <tr>
  408. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  409. valign="top" align="left">
  410. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  411. name
  412. </font>
  413. </td>
  414. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  415. valign="top" align="left">
  416. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  417. The name to use to identify the referenced project.
  418. </font>
  419. </td>
  420. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  421. valign="top" align="left">
  422. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  423. Required
  424. </font>
  425. </td>
  426. </tr>
  427. <tr>
  428. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  429. valign="top" align="left">
  430. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  431. location
  432. </font>
  433. </td>
  434. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  435. valign="top" align="left">
  436. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  437. The path to the project file to reference.
  438. </font>
  439. </td>
  440. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  441. valign="top" align="left">
  442. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  443. Required
  444. </font>
  445. </td>
  446. </tr>
  447. </table>
  448. <p>
  449. The targets of a referenced project can be used in the <code>depends</code> list
  450. of a target in the referencing project, using the following syntax:
  451. <code><i>project-name</i>-&gt;<i>target-name</i></code>. Here is a simple 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;!-- Reference another project --&gt;
  464. &lt;projectref name=&quot;subproject&quot; location=&quot;subproject/build.xml&quot;/&gt;
  465. &lt;!-- Use the &quot;compile&quot; target from the referenced project --&gt;
  466. &lt;target name=&quot;main&quot; depends=&quot;subproject-&gt;compile&quot;&gt;
  467. .. do some stuff ..
  468. &lt;/target&gt;
  469. &lt;/project&gt;
  470. </pre></td>
  471. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  472. </tr>
  473. <tr>
  474. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  475. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  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. </tr>
  478. </table>
  479. </div>
  480. </blockquote>
  481. </td></tr>
  482. </table>
  483. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  484. <tr><td bgcolor="#828DA6">
  485. <font color="#ffffff" face="arial,helvetica,sanserif">
  486. <a name="Library Imports"><strong>Library Imports</strong></a>
  487. </font>
  488. </td></tr>
  489. <tr><td>
  490. <blockquote>
  491. <p>Library imports allow the project to import the tasks and data-types from an
  492. antlib. An <code>&lt;import&gt;</code> element takes the following attributes:</p>
  493. <table>
  494. <tr>
  495. <td bgcolor="#039acc" colspan="" rowspan=""
  496. valign="top" align="left">
  497. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  498. Attribute
  499. </font>
  500. </td>
  501. <td bgcolor="#039acc" colspan="" rowspan=""
  502. valign="top" align="left">
  503. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  504. Description
  505. </font>
  506. </td>
  507. <td bgcolor="#039acc" colspan="" rowspan=""
  508. valign="top" align="left">
  509. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  510. Default Value
  511. </font>
  512. </td>
  513. </tr>
  514. <tr>
  515. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  516. valign="top" align="left">
  517. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  518. library
  519. </font>
  520. </td>
  521. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  522. valign="top" align="left">
  523. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  524. The name of the library to import. The <code>ext</code> directory
  525. of the Myrmidon distribution is searched for a library file with
  526. the given name, and an <code>atl</code> extension.
  527. </font>
  528. </td>
  529. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  530. valign="top" align="left">
  531. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  532. Required
  533. </font>
  534. </td>
  535. </tr>
  536. <tr>
  537. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  538. valign="top" align="left">
  539. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  540. type
  541. </font>
  542. </td>
  543. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  544. valign="top" align="left">
  545. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  546. The type of definition to import. Values include <code>task</code>,
  547. and <code>data-type</code>.
  548. </font>
  549. </td>
  550. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  551. valign="top" align="left">
  552. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  553. None
  554. </font>
  555. </td>
  556. </tr>
  557. <tr>
  558. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  559. valign="top" align="left">
  560. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  561. name
  562. </font>
  563. </td>
  564. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  565. valign="top" align="left">
  566. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  567. The name of the type to import.
  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. None
  574. </font>
  575. </td>
  576. </tr>
  577. </table>
  578. <p>
  579. If the <code>type</code> and <code>name</code> attributes are not provided,
  580. the entire contents of the antlib are imported.
  581. </p>
  582. <p>The following example import the <code>&lt;my-task&gt;</code> task from
  583. the <code>my-tasks</code> antlib.</p>
  584. <div align="left">
  585. <table cellspacing="4" cellpadding="0" border="0">
  586. <tr>
  587. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  588. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  589. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  590. </tr>
  591. <tr>
  592. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  593. <td bgcolor="#ffffff"><pre>
  594. &lt;project version=&quot;2.0&quot;&gt;
  595. &lt;!-- Import task &lt;my-task&gt; from the 'my-tasks' antlib. --&gt;
  596. &lt;import library=&quot;my-tasks&quot; type=&quot;task&quot; name=&quot;my-task&quot;/&gt;
  597. &lt;target name=&quot;main&quot;&gt;
  598. &lt;my-task some-prop=&quot;..&quot;/&gt;
  599. &lt;/target&gt;
  600. &lt;/project&gt;
  601. </pre></td>
  602. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  603. </tr>
  604. <tr>
  605. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  606. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  607. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  608. </tr>
  609. </table>
  610. </div>
  611. </blockquote>
  612. </td></tr>
  613. </table>
  614. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  615. <tr><td bgcolor="#828DA6">
  616. <font color="#ffffff" face="arial,helvetica,sanserif">
  617. <a name="Implicit Tasks"><strong>Implicit Tasks</strong></a>
  618. </font>
  619. </td></tr>
  620. <tr><td>
  621. <blockquote>
  622. <p>Implicit tasks are run before any of the project's targets are run. Any task
  623. can be used, including <code>&lt;property&gt;</code> and data-type instances.
  624. Implicit tasks can be used to initialise the project. For example:</p>
  625. <div align="left">
  626. <table cellspacing="4" cellpadding="0" border="0">
  627. <tr>
  628. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  629. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  630. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  631. </tr>
  632. <tr>
  633. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  634. <td bgcolor="#ffffff"><pre>
  635. &lt;project version=&quot;2.0&quot;&gt;
  636. &lt;property name=&quot;some-property&quot; value=&quot;some value&quot;/&gt;
  637. &lt;path id=&quot;classpath&quot;&gt;
  638. &lt;fileset dir=&quot;lib&quot;/&gt;
  639. &lt;/path&gt;
  640. &lt;log&gt;Set classpath to ${classpath}&lt;/log&gt;
  641. &lt;target name=&quot;main&quot;&gt;
  642. .. do some stuff ..
  643. &lt;/target&gt;
  644. &lt;/project&gt;
  645. </pre></td>
  646. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  647. </tr>
  648. <tr>
  649. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  650. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  651. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  652. </tr>
  653. </table>
  654. </div>
  655. </blockquote>
  656. </td></tr>
  657. </table>
  658. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  659. <tr><td bgcolor="#828DA6">
  660. <font color="#ffffff" face="arial,helvetica,sanserif">
  661. <a name="Targets"><strong>Targets</strong></a>
  662. </font>
  663. </td></tr>
  664. <tr><td>
  665. <blockquote>
  666. <p>Targets have the same format as in Ant 1.x, though some of the behaviour
  667. is different. A <code>&lt;target&gt;</code> element takes the following
  668. attributes:</p>
  669. <table>
  670. <tr>
  671. <td bgcolor="#039acc" colspan="" rowspan=""
  672. valign="top" align="left">
  673. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  674. Attribute
  675. </font>
  676. </td>
  677. <td bgcolor="#039acc" colspan="" rowspan=""
  678. valign="top" align="left">
  679. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  680. Description
  681. </font>
  682. </td>
  683. <td bgcolor="#039acc" colspan="" rowspan=""
  684. valign="top" align="left">
  685. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  686. Default Value
  687. </font>
  688. </td>
  689. </tr>
  690. <tr>
  691. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  692. valign="top" align="left">
  693. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  694. name
  695. </font>
  696. </td>
  697. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  698. valign="top" align="left">
  699. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  700. The name of the target.
  701. </font>
  702. </td>
  703. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  704. valign="top" align="left">
  705. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  706. Required
  707. </font>
  708. </td>
  709. </tr>
  710. <tr>
  711. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  712. valign="top" align="left">
  713. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  714. depends
  715. </font>
  716. </td>
  717. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  718. valign="top" align="left">
  719. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  720. A comma-separated list of targets that this target depends on.
  721. This list can contain targets from referenced projects.
  722. </font>
  723. </td>
  724. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  725. valign="top" align="left">
  726. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  727. None
  728. </font>
  729. </td>
  730. </tr>
  731. <tr>
  732. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  733. valign="top" align="left">
  734. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  735. if
  736. </font>
  737. </td>
  738. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  739. valign="top" align="left">
  740. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  741. Only execute this target if the specified property is set, and not
  742. equal to <code>false</code>.
  743. </font>
  744. </td>
  745. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  746. valign="top" align="left">
  747. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  748. None
  749. </font>
  750. </td>
  751. </tr>
  752. <tr>
  753. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  754. valign="top" align="left">
  755. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  756. unless
  757. </font>
  758. </td>
  759. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  760. valign="top" align="left">
  761. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  762. Do not execute this target if the specified property is set, and not
  763. equal to <code>false</code>.
  764. </font>
  765. </td>
  766. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  767. valign="top" align="left">
  768. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  769. None
  770. </font>
  771. </td>
  772. </tr>
  773. </table>
  774. </blockquote>
  775. </td></tr>
  776. </table>
  777. </blockquote>
  778. </td></tr>
  779. </table>
  780. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  781. <tr><td bgcolor="#525D76">
  782. <font color="#ffffff" face="arial,helvetica,sanserif">
  783. <a name="Handling Files"><strong>Handling Files</strong></a>
  784. </font>
  785. </td></tr>
  786. <tr><td>
  787. <blockquote>
  788. <p>Myrmidon includes a Virtual File System (VFS), which allows files from
  789. different sources to be treated identically. The VFS currently supports
  790. the following file types:</p>
  791. <table>
  792. <tr>
  793. <td bgcolor="#039acc" colspan="" rowspan=""
  794. valign="top" align="left">
  795. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  796. File System
  797. </font>
  798. </td>
  799. <td bgcolor="#039acc" colspan="" rowspan=""
  800. valign="top" align="left">
  801. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  802. Description
  803. </font>
  804. </td>
  805. <td bgcolor="#039acc" colspan="" rowspan=""
  806. valign="top" align="left">
  807. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  808. URL Format
  809. </font>
  810. </td>
  811. </tr>
  812. <tr>
  813. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  814. valign="top" align="left">
  815. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  816. Local Files
  817. </font>
  818. </td>
  819. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  820. valign="top" align="left">
  821. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  822. Files on the local file system.
  823. </font>
  824. </td>
  825. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  826. valign="top" align="left">
  827. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  828. Three different formats are currently supported for local file names:
  829. <ul>
  830. <li><code>file://</code> <i>absolute-file-name</i></li>
  831. <li>Absolute file names</li>
  832. <li>Relative file names. These are resolved relative to the
  833. project's base directory.
  834. </li>
  835. </ul>
  836. </font>
  837. </td>
  838. </tr>
  839. <tr>
  840. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  841. valign="top" align="left">
  842. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  843. Zip Files
  844. </font>
  845. </td>
  846. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  847. valign="top" align="left">
  848. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  849. The contents of Zip files (and Jar, War, and Ear files).
  850. Currently, the VFS supports read-only access to Zip file contents,
  851. and only for local Zip files.
  852. </font>
  853. </td>
  854. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  855. valign="top" align="left">
  856. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  857. <code>zip://</code> <i>zip-file-path</i> [<code>!</code><i>absolute-path</i>]
  858. </font>
  859. </td>
  860. </tr>
  861. <tr>
  862. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  863. valign="top" align="left">
  864. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  865. FTP
  866. </font>
  867. </td>
  868. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  869. valign="top" align="left">
  870. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  871. Files on an FTP server.
  872. </font>
  873. </td>
  874. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  875. valign="top" align="left">
  876. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  877. <code>ftp://</code> [[<i>password</i><code>:</code>] <i>username</i><code>@</code>] <i>hostname</i> [<code>:</code><i>port</i>] [<i>absolute-path</i>]
  878. </font>
  879. </td>
  880. </tr>
  881. <tr>
  882. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  883. valign="top" align="left">
  884. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  885. SMB
  886. </font>
  887. </td>
  888. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  889. valign="top" align="left">
  890. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  891. Files on a CFIS server, such as Samba or Windows shares.
  892. </font>
  893. </td>
  894. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  895. valign="top" align="left">
  896. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  897. <code>smb://</code> [[<i>password</i><code>:</code>] <i>username</i><code>@</code>] <i>hostname</i> [<code>:</code><i>port</i>] [<i>absolute-path</i>]
  898. </font>
  899. </td>
  900. </tr>
  901. </table>
  902. <p>Here are some example URLs:</p>
  903. <ul>
  904. <li><code>build/classes</code></li>
  905. <li><code>c:\program files\ant\bin</code></li>
  906. <li><code>file://C:/program files/ant</code></li>
  907. <li><code>zip://build/lib/ant.jar!/org/apache/tools</code></li>
  908. <li><code>ftp://adam@somehost/pub/downloads</code></li>
  909. <li><code>smb://password:adam@somehost/home/adam</code></li>
  910. </ul>
  911. <p>Currently, there are only a handful of VFS aware tasks. This will grow
  912. as more tasks are ported to the new API, and data types.</p>
  913. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  914. <tr><td bgcolor="#828DA6">
  915. <font color="#ffffff" face="arial,helvetica,sanserif">
  916. <a name="File Sets"><strong>File Sets</strong></a>
  917. </font>
  918. </td></tr>
  919. <tr><td>
  920. <blockquote>
  921. <p>A file set in Myrmidon is more general than Ant 1's concept of a file set.
  922. Firstly, there is more than one type of file set. Secondly, they are VFS enabled.
  923. File sets are automatically converted to a <a href="#Paths">path</a>, and so
  924. can be used anywhere that a path can.</p>
  925. <h3><code>&lt;v-fileset&gt;</code></h3>
  926. <p>This is the equivalent of Ant 1's <code>&lt;fileset&gt;</code> (The name
  927. is temporary, it will be changed to <code>&lt;fileset&gt;</code> once more
  928. porting work as been completed).</p>
  929. <p>Rather than use a set of include and exclude patterns to choose the files
  930. that make up the file set, <code>&lt;v-fileset&gt;</code> takes zero or more
  931. <a href="#File Selectors">file selectors</a>. File selectors can be used to
  932. select files based on any attribute of the file, rather than just the name.
  933. You can use <code>&lt;name&gt;</code> selectors to achieve the same result
  934. as using includes or excludes.</p>
  935. <p>A <code>&lt;v-fileset&gt;</code> element takes the following attributes:</p>
  936. <table>
  937. <tr>
  938. <td bgcolor="#039acc" colspan="" rowspan=""
  939. valign="top" align="left">
  940. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  941. Attribute
  942. </font>
  943. </td>
  944. <td bgcolor="#039acc" colspan="" rowspan=""
  945. valign="top" align="left">
  946. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  947. Description
  948. </font>
  949. </td>
  950. <td bgcolor="#039acc" colspan="" rowspan=""
  951. valign="top" align="left">
  952. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  953. Default Value
  954. </font>
  955. </td>
  956. </tr>
  957. <tr>
  958. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  959. valign="top" align="left">
  960. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  961. dir
  962. </font>
  963. </td>
  964. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  965. valign="top" align="left">
  966. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  967. The base directory for the file set. This can be any URL that the
  968. VFS supports.
  969. </font>
  970. </td>
  971. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  972. valign="top" align="left">
  973. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  974. Required
  975. </font>
  976. </td>
  977. </tr>
  978. </table>
  979. <p>A <code>&lt;v-fileset&gt;</code> element takes any number of nested
  980. <a href="#File Selectors">file selector</a> elements. To be included in the
  981. file set, a file must be selected by all the file selectors. That is, the
  982. file selectors are implicitly AND-ed together. If no file selector is provided,
  983. all the files and directories are included in the set.</p>
  984. <p>An example:</p>
  985. <div align="left">
  986. <table cellspacing="4" cellpadding="0" border="0">
  987. <tr>
  988. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  989. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  990. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  991. </tr>
  992. <tr>
  993. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  994. <td bgcolor="#ffffff"><pre>
  995. &lt;v-fileset dir=&quot;src&quot;&gt;
  996. &lt;name pattern=&quot;org/apache/tools/ant/**&quot;/&gt;
  997. &lt;is-file/&gt;
  998. &lt;/v-fileset&gt;
  999. </pre></td>
  1000. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1001. </tr>
  1002. <tr>
  1003. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1004. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1005. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1006. </tr>
  1007. </table>
  1008. </div>
  1009. <h3><code>&lt;flat-fileset&gt;</code></h3>
  1010. <p>This file set takes a set of nested file sets and paths, and flattens them
  1011. into a single directory. It can be used as a way of converting a path into a
  1012. file set. It can also be used as a replacement for the <code>flatten</code>
  1013. attribute for the copy and move tasks.</p>
  1014. <p>A <code>&lt;flat-fileset&gt;</code> element takes no attributes, and a set
  1015. of nested paths or file sets.</p>
  1016. <p>An example:</p>
  1017. <div align="left">
  1018. <table cellspacing="4" cellpadding="0" border="0">
  1019. <tr>
  1020. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1021. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1022. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1023. </tr>
  1024. <tr>
  1025. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1026. <td bgcolor="#ffffff"><pre>
  1027. &lt;v-copy todir=&quot;dist/lib&quot;&gt;
  1028. &lt;flat-fileset&gt;
  1029. &lt;v-fileset dir=&quot;build/lib&quot;&gt;
  1030. &lt;basename pattern=&quot;*.jar&quot;/&gt;
  1031. &lt;v-fileset&gt;
  1032. &lt;v-path path=&quot;${classpath}&quot;/&gt;
  1033. &lt;/flat-fileset&gt;
  1034. &lt;/v-copy&gt;
  1035. </pre></td>
  1036. <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1037. </tr>
  1038. <tr>
  1039. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1040. <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1041. <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  1042. </tr>
  1043. </table>
  1044. </div>
  1045. </blockquote>
  1046. </td></tr>
  1047. </table>
  1048. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  1049. <tr><td bgcolor="#828DA6">
  1050. <font color="#ffffff" face="arial,helvetica,sanserif">
  1051. <a name="Paths"><strong>Paths</strong></a>
  1052. </font>
  1053. </td></tr>
  1054. <tr><td>
  1055. <blockquote>
  1056. <p>Paths are an ordered list of files.</p>
  1057. <h3><code>&lt;v-path&gt;</code></h3>
  1058. <p>This is the equivalent of Ant 1's <code>&lt;path&gt;</code>.</p>
  1059. <h3><code>&lt;filtered-path&gt;</code></h3>
  1060. <p>A path that applies file selectors to a set of nested file sets and paths.</p>
  1061. </blockquote>
  1062. </td></tr>
  1063. </table>
  1064. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  1065. <tr><td bgcolor="#828DA6">
  1066. <font color="#ffffff" face="arial,helvetica,sanserif">
  1067. <a name="File Selectors"><strong>File Selectors</strong></a>
  1068. </font>
  1069. </td></tr>
  1070. <tr><td>
  1071. <blockquote>
  1072. <p>File selectors are used to select files from file sets and paths.</p>
  1073. <h3><code>&lt;and&gt;</code></h3>
  1074. <p>Combines zero or more file selectors, using AND. An empty <code>&lt;and&gt;</code>
  1075. selector accepts all files.</p>
  1076. <h3><code>&lt;basename&gt;</code></h3>
  1077. <p>Selects files whose base name matches an Ant 1 style pattern, or a regular
  1078. expression.</p>
  1079. <h3><code>&lt;exists&gt;</code></h3>
  1080. <p>Selects files that exist.</p>
  1081. <h3><code>&lt;is-empty&gt;</code></h3>
  1082. <p>Selects empty folders, that is, folders that have no children.</p>
  1083. <h3><code>&lt;is-folder&gt;</code></h3>
  1084. <p>Selects folders, does not select regular files.</p>
  1085. <h3><code>&lt;is-file&gt;</code></h3>
  1086. <p>Selects regular files, does not select folders.</p>
  1087. <h3><code>&lt;name&gt;</code></h3>
  1088. <p>Selects files whose path in a file set matches an Ant 1 style pattern, or
  1089. a regular expression.</p>
  1090. <h3><code>&lt;not&gt;</code></h3>
  1091. <p>Selects files that are not selected by a nested file selector.</p>
  1092. <h3><code>&lt;or&gt;</code></h3>
  1093. <p>Combines zero or more file selectors, using OR. An empty <code>&lt;or&gt;</code>
  1094. selector accepts all files.</p>
  1095. <h3><code>&lt;url&gt;</code></h3>
  1096. <p>Selects files whose URL matches an Ant 1 style pattern, or a regular expression.</p>
  1097. </blockquote>
  1098. </td></tr>
  1099. </table>
  1100. </blockquote>
  1101. </td></tr>
  1102. </table>
  1103. <table border="0" cellspacing="0" cellpadding="2" width="100%">
  1104. <tr><td bgcolor="#525D76">
  1105. <font color="#ffffff" face="arial,helvetica,sanserif">
  1106. <a name="Tasks"><strong>Tasks</strong></a>
  1107. </font>
  1108. </td></tr>
  1109. <tr><td>
  1110. <blockquote>
  1111. <p>
  1112. The following table lists some of the current set of tasks. You can find
  1113. example usages of these tasks in the sample project file
  1114. <code>src/make/sample.ant</code>.
  1115. </p>
  1116. <table>
  1117. <tr>
  1118. <td bgcolor="#039acc" colspan="" rowspan=""
  1119. valign="top" align="left">
  1120. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1121. Task
  1122. </font>
  1123. </td>
  1124. <td bgcolor="#039acc" colspan="" rowspan=""
  1125. valign="top" align="left">
  1126. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1127. Description
  1128. </font>
  1129. </td>
  1130. </tr>
  1131. <tr>
  1132. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1133. valign="top" align="left">
  1134. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1135. fail
  1136. </font>
  1137. </td>
  1138. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1139. valign="top" align="left">
  1140. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1141. Causes the build to fail.
  1142. </font>
  1143. </td>
  1144. </tr>
  1145. <tr>
  1146. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1147. valign="top" align="left">
  1148. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1149. if
  1150. </font>
  1151. </td>
  1152. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1153. valign="top" align="left">
  1154. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1155. Conditionally executes a set of tasks.
  1156. </font>
  1157. </td>
  1158. </tr>
  1159. <tr>
  1160. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1161. valign="top" align="left">
  1162. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1163. load-properties
  1164. </font>
  1165. </td>
  1166. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1167. valign="top" align="left">
  1168. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1169. Loads a set of properties from a file.
  1170. </font>
  1171. </td>
  1172. </tr>
  1173. <tr>
  1174. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1175. valign="top" align="left">
  1176. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1177. log
  1178. </font>
  1179. </td>
  1180. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1181. valign="top" align="left">
  1182. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1183. Writes a log message.
  1184. </font>
  1185. </td>
  1186. </tr>
  1187. <tr>
  1188. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1189. valign="top" align="left">
  1190. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1191. property
  1192. </font>
  1193. </td>
  1194. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1195. valign="top" align="left">
  1196. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1197. Sets a property.
  1198. </font>
  1199. </td>
  1200. </tr>
  1201. <tr>
  1202. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1203. valign="top" align="left">
  1204. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1205. try-catch
  1206. </font>
  1207. </td>
  1208. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1209. valign="top" align="left">
  1210. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1211. Runs a set of tasks, with a provided error and clean-up handler.
  1212. </font>
  1213. </td>
  1214. </tr>
  1215. <tr>
  1216. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1217. valign="top" align="left">
  1218. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1219. converter-def
  1220. </font>
  1221. </td>
  1222. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1223. valign="top" align="left">
  1224. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1225. Register a type converter. These are used when configuring a task
  1226. or data-type from attributes.
  1227. </font>
  1228. </td>
  1229. </tr>
  1230. <tr>
  1231. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1232. valign="top" align="left">
  1233. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1234. type-def
  1235. </font>
  1236. </td>
  1237. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1238. valign="top" align="left">
  1239. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1240. Register a task or data-type.
  1241. </font>
  1242. </td>
  1243. </tr>
  1244. <tr>
  1245. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1246. valign="top" align="left">
  1247. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1248. import
  1249. </font>
  1250. </td>
  1251. <td bgcolor="#a0ddf0" colspan="" rowspan=""
  1252. valign="top" align="left">
  1253. <font color="#000000" size="-1" face="arial,helvetica,sanserif">
  1254. Register the contents of an antlib.
  1255. </font>
  1256. </td>
  1257. </tr>
  1258. </table>
  1259. </blockquote>
  1260. </td></tr>
  1261. </table>
  1262. </td>
  1263. </tr>
  1264. <!-- FOOTER -->
  1265. <tr><td colspan="2">
  1266. <hr noshade="" size="1"/>
  1267. </td></tr>
  1268. <tr><td colspan="2">
  1269. <div align="center"><font color="#525D76" size="-1"><em>
  1270. Copyright &#169; 2000-2002, Apache Software Foundation
  1271. </em></font></div>
  1272. </td></tr>
  1273. </table>
  1274. </body>
  1275. </html>
  1276. <!-- end the processing -->