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.

faq.html 63 KiB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html lang="en">
  3. <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
  4. <head>
  5. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  6. <title>Apache Ant - Frequently Asked Questions</title>
  7. <link type="text/css" href="./page.css" rel="stylesheet">
  8. <meta name="author" content="Stefan Bodewig">
  9. <meta name="email" content="bodewig@apache.org">
  10. </head>
  11. <body>
  12. <p class="navpath">
  13. <script src="./breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
  14. </p>
  15. <div class="logobar">
  16. <table width="100%" border="0" cellspacing="0" cellpadding="0">
  17. <tr>
  18. <td align="left"><img border="0" alt="Apache Ant site" src="./images/group-logo.gif"></td>
  19. <td align="center" width="100%"><img alt="Apache Ant logo" border="0" src="./images/project-logo.gif"></td>
  20. <td align="right">
  21. <form target="_blank" onsubmit="q.value = query.value + ' site:ant.apache.org'" action="http://www.google.com/search" method="get">
  22. <table summary="search" border="0" cellspacing="0" cellpadding="0" bgcolor="#4C6C8F">
  23. <tr>
  24. <td colspan="3"><img height="10" width="1" alt="" src="./images/spacer.gif"></td>
  25. </tr>
  26. <tr>
  27. <td><img height="1" width="1" alt="" src="./images/spacer.gif"></td>
  28. <td nowrap="nowrap" class="searchcaption">
  29. <input name="q" type="hidden">
  30. <input size="15" id="query" type="text">
  31. <img height="1" width="5" alt="" src="./images/spacer.gif">
  32. <input name="Search" value="Search" type="submit">
  33. <br>
  34. the Apache Ant site
  35. </td>
  36. <td><img height="1" width="1" alt="" src="./images/spacer.gif"></td>
  37. </tr>
  38. <tr>
  39. <td><img alt="" border="0" height="10" width="9" src="./images/search-left.gif"></td>
  40. <td><img height="1" width="1" alt="" src="./images/spacer.gif"></td>
  41. <td><img alt="" border="0" height="10" width="9" src="./images/search-right.gif"></td>
  42. </tr>
  43. </table>
  44. </form>
  45. </td>
  46. </tr>
  47. </table>
  48. </div>
  49. <div class="tab">
  50. <table summary="tab bar" border="0" cellpadding="0" cellspacing="0">
  51. <tr>
  52. <td width="8"><img alt="" height="5" width="8" src="./images/spacer.gif"></td><td valign="bottom">
  53. <table summary="selected tab" style="height: 1.5em" border="0" cellpadding="0" cellspacing="0">
  54. <tr>
  55. <td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="./images/tabSel-left.gif"></td><td valign="middle" bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica, Sans-serif"><b>Home</b></font></td><td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="./images/tabSel-right.gif"></td>
  56. </tr>
  57. </table>
  58. </td>
  59. <td width="5"><img alt="" height="8" width="8" src="./images/spacer.gif"></td><td valign="bottom">
  60. <table summary="non selected tab" style="height: 1.4em" border="0" cellpadding="0" cellspacing="0">
  61. <tr>
  62. <td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="./images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a href="./projects/index.html"><font size="2" face="Arial, Helvetica, Sans-serif">Projects</font></a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="./images/tab-right.gif"></td>
  63. </tr>
  64. </table>
  65. </td>
  66. </tr>
  67. </table>
  68. </div>
  69. <div class="bluebar"></div>
  70. <div class="menucontainer">
  71. <div class="menu">
  72. <ul>
  73. <li class="menuheader">Apache Ant
  74. <ul>
  75. <li>
  76. <a href="./index.html">Welcome</a>
  77. </li>
  78. <li>
  79. <a href="./license.html">License</a>
  80. </li>
  81. <li>
  82. <a href="./antnews.html">News</a>
  83. </li>
  84. </ul>
  85. </li>
  86. <li class="menuheader">Documentation
  87. <ul>
  88. <li>
  89. <a href="./manual/index.html">Manual</a>
  90. </li>
  91. <li>
  92. <a href="./projects.html">Related Projects</a>
  93. </li>
  94. <li>
  95. <a href="./external.html">External Tools and Tasks</a>
  96. </li>
  97. <li>
  98. <a href="./resources.html">Resources</a>
  99. </li>
  100. <li>
  101. <span class="sel">Frequently Asked Questions</span>
  102. </li>
  103. <li>
  104. <a href="./problems.html">Having Problems?</a>
  105. </li>
  106. </ul>
  107. </li>
  108. <li class="menuheader">Download
  109. <ul>
  110. <li>
  111. <a href="http://ant.apache.org/bindownload.cgi">Binary Distributions</a>
  112. </li>
  113. <li>
  114. <a href="http://ant.apache.org/srcdownload.cgi">Source Distributions</a>
  115. </li>
  116. </ul>
  117. </li>
  118. <li class="menuheader">Contributing
  119. <ul>
  120. <li>
  121. <a href="./mail.html">Mailing Lists</a>
  122. </li>
  123. <li>
  124. <a href="./cvs.html">CVS Repositories</a>
  125. </li>
  126. <li>
  127. <a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Ant">Bug Database</a>
  128. </li>
  129. <li>
  130. <a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Ant&amp;bug_severity=Enhancement">Enhancement Requests</a>
  131. </li>
  132. <li>
  133. <a href="http://www.apache.org/foundation/contributing.html">Donations</a>
  134. </li>
  135. </ul>
  136. </li>
  137. <li class="menuheader">Project Management
  138. <ul>
  139. <li>
  140. <a href="./contributors.html">Contributors</a>
  141. </li>
  142. <li>
  143. <a href="./mission.html">Apache Ant Mission</a>
  144. </li>
  145. <li>
  146. <a href="./bylaws.html">Project Bylaws</a>
  147. </li>
  148. <li>
  149. <a href="./legal.html">Legal</a>
  150. </li>
  151. </ul>
  152. </li>
  153. </ul>
  154. </div>
  155. <img style="float: left" height="10" width="10" border="0" alt="" src="./images/menu-left.gif">
  156. <img style="float: right" height="10" width="10" border="0" alt="" src="./images/menu-right.gif">
  157. </div>
  158. <div class="lightbluebar">&nbsp;</div>
  159. <div class="main">
  160. <div class="content">
  161. <h1 class="title">Frequently Asked Questions</h1>
  162. <h3 class="section">Questions</h3>
  163. <h4 class="toc">About this FAQ</h4>
  164. <ul>
  165. <li><a href="#latest-version">
  166. Where do I find the latest version of this
  167. document?
  168. </a></li>
  169. <li><a href="#adding-faqs">
  170. How can I contribute to this FAQ?
  171. </a></li>
  172. <li><a href="#creating-faq">
  173. How do you create the HTML version of this
  174. FAQ?
  175. </a></li>
  176. </ul>
  177. <h4 class="toc">General</h4>
  178. <ul>
  179. <li><a href="#what-is-ant">
  180. What is Apache Ant?
  181. </a></li>
  182. <li><a href="#ant-name">
  183. Why do you call it Ant?
  184. </a></li>
  185. <li><a href="#history">
  186. Tell us a little bit about Ant's history.
  187. </a></li>
  188. </ul>
  189. <h4 class="toc">Installation</h4>
  190. <ul>
  191. <li><a href="#no-gnu-tar">
  192. I get checksum errors when I try to extract the
  193. <code>tar.gz</code> distribution file. Why?
  194. </a></li>
  195. </ul>
  196. <h4 class="toc">How do I ...</h4>
  197. <ul>
  198. <li><a href="#adding-external-tasks">
  199. How do I add an external task that I've written to the
  200. page "External Tools and Task"?
  201. </a></li>
  202. <li><a href="#passing-cli-args">
  203. How do I pass parameters from the command line to my
  204. build file?
  205. </a></li>
  206. <li><a href="#jikes-switches">
  207. How can I use Jikes-specific command-line
  208. switches?
  209. </a></li>
  210. <li><a href="#shell-redirect-1">
  211. How do I include a &lt; character in my command-line arguments?
  212. </a></li>
  213. <li><a href="#shell-redirect-2">
  214. How do I redirect standard input or standard output
  215. in the <code>&lt;exec&gt;</code> task?
  216. </a></li>
  217. <li><a href="#batch-shell-execute">
  218. How do I execute a batch file or shell script from Ant?
  219. </a></li>
  220. <li><a href="#multi-conditions">
  221. I want to execute a particular target only if
  222. multiple conditions are true.
  223. </a></li>
  224. <li><a href="#encoding">
  225. How can I include national characters like German
  226. umlauts in my build file?
  227. </a></li>
  228. </ul>
  229. <h4 class="toc">It doesn't work (as expected)</h4>
  230. <ul>
  231. <li><a href="#always-recompiles">
  232. Why does Ant always recompile all my Java files?
  233. </a></li>
  234. <li><a href="#defaultexcludes">
  235. I've used a <code>&lt;delete&gt;</code> task to
  236. delete unwanted SourceSafe control files (CVS files, editor
  237. backup files, etc.), but it doesn't seem to work; the files
  238. never get deleted. What's wrong?
  239. </a></li>
  240. <li><a href="#stop-dependency">
  241. I have a target I want to skip if a property is set,
  242. so I have <code>unless="property"</code> as an attribute
  243. of the target, but all the targets this target
  244. depends on are still executed. Why?
  245. </a></li>
  246. <li><a href="#include-order">
  247. In my <code>&lt;fileset&gt;</code>, I've put in an
  248. <code>&lt;exclude&gt;</code> of all files followed by an
  249. <code>&lt;include&gt;</code> of just the files I want, but it
  250. isn't giving me any files at all. What's wrong?
  251. </a></li>
  252. <li><a href="#properties-not-trimmed">
  253. <code>ant</code> failed to build my program via javac
  254. even when I put the needed jars in an external
  255. <code>build.properties</code> file and reference them by
  256. <code>pathelement</code> or <code>classpath refid</code>.
  257. </a></li>
  258. <li><a href="#winzip-lies">
  259. Ant creates WAR files with a lower-case
  260. <code>web-inf</code> or JAR files with a lower-case
  261. <code>meta-inf</code> directory.
  262. </a></li>
  263. </ul>
  264. <h4 class="toc">Ant and IDEs/Editors</h4>
  265. <ul>
  266. <li><a href="#integration">
  267. Is Ant supported by my IDE/Editor?
  268. </a></li>
  269. <li><a href="#emacs-mode">
  270. Why doesn't (X)Emacs/vi/MacOS X's project builder
  271. correctly parse the error messages generated by Ant?
  272. </a></li>
  273. </ul>
  274. <h4 class="toc">Advanced Issues</h4>
  275. <ul>
  276. <li><a href="#dtd">
  277. Is there a DTD that I can use to validate my build
  278. files?
  279. </a></li>
  280. <li><a href="#xml-entity-include">
  281. How do I include an XML snippet in my build file?
  282. </a></li>
  283. <li><a href="#mail-logger">
  284. How do I send an email with the result of my build
  285. process?
  286. </a></li>
  287. <li><a href="#listener-properties">
  288. How do I get at the properties that Ant was running
  289. with from inside BuildListener?
  290. </a></li>
  291. </ul>
  292. <h4 class="toc">Known Problems</h4>
  293. <ul>
  294. <li><a href="#remove-cr">
  295. &lt;chmod&gt; or &lt;exec&gt; doesn't work in Ant
  296. 1.3 on Unix
  297. </a></li>
  298. <li><a href="#javadoc-cannot-execute">
  299. JavaDoc failed: java.io.IOException: javadoc: cannot execute
  300. </a></li>
  301. <li><a href="#delegating-classloader">
  302. &lt;style&gt; or &lt;junit&gt; ignores my
  303. &lt;classpath&gt;
  304. </a></li>
  305. <li><a href="#winxp-jdk14-ant14">
  306. When running Ant 1.4 on Windows XP and JDK 1.4, I get
  307. various errors when trying to <code>&lt;exec&gt;</code>, fork
  308. <code>&lt;java&gt;</code> or access environment
  309. variables.
  310. </a></li>
  311. <li><a href="#1.5-cygwin-sh">
  312. The <code>ant</code> wrapper script of Ant 1.5 fails
  313. for Cygwin if <code>ANT_HOME</code> is set to a Windows style
  314. path.
  315. </a></li>
  316. <li><a href="#1.5.2-zip-broken">
  317. <code>&lt;zip&gt;</code> is broken in Ant 1.5.2.
  318. </a></li>
  319. </ul>
  320. <h3 class="section">Answers</h3>
  321. <p class="faq">
  322. <a name="latest-version"></a>
  323. Where do I find the latest version of this
  324. document?
  325. </p>
  326. <p>The latest version can always be found at Ant's homepage
  327. <a href="http://ant.apache.org/faq.html">http://ant.apache.org/faq.html</a>.</p>
  328. <p class="faq">
  329. <a name="adding-faqs"></a>
  330. How can I contribute to this FAQ?
  331. </p>
  332. <p>The page you are looking it is generated from
  333. <a href="http://cvs.apache.org/viewcvs.cgi/~checkout~/ant/xdocs/faq.xml">this</a>
  334. document. If you want to add a new question, please submit
  335. a patch against this document to one of Ant's mailing lists;
  336. hopefully, the structure is self-explanatory.</p>
  337. <p>If you don't know how to create a patch, see the patches
  338. section of <a href="http://jakarta.apache.org/site/source.html">this
  339. page</a>.</p>
  340. <p class="faq">
  341. <a name="creating-faq"></a>
  342. How do you create the HTML version of this
  343. FAQ?
  344. </p>
  345. <p>We use
  346. <a href="http://jakarta.apache.org/velocity/anakia.html">Anakia</a>
  347. to render the HTML version from the original XML file.</p>
  348. <p>The Velocity stylesheets used to process the XML files can
  349. be found in the <code>xdocs/stylesheets</code> subdirectory of
  350. Ant's CVS repository - the build file
  351. <code>docs.xml</code> at the top level of the ant CVS
  352. module is used to drive Anakia.</p>
  353. <p>This file assumes that you have the
  354. <code>jakarta-site2</code> CVS module checked out as well, but
  355. if you follow the instruction from Anakia's homepage, you
  356. should get it to work without that. Just make sure all
  357. required jars are in the task's classpath.</p>
  358. <p class="faq">
  359. <a name="what-is-ant"></a>
  360. What is Apache Ant?
  361. </p>
  362. <p> Ant is a Java-based build tool. In theory, it is kind of
  363. like Make, without Make's wrinkles and with the full
  364. portability of pure Java code.</p>
  365. <p class="faq">
  366. <a name="ant-name"></a>
  367. Why do you call it Ant?
  368. </p>
  369. <p>According to Ant's original author, James Duncan
  370. Davidson, the name is an acronym for "Another Neat
  371. Tool".</p>
  372. <p>Later explanations go along the lines of "ants
  373. do an extremely good job at building things", or
  374. "ants are very small and can carry a weight dozens of times
  375. their own" - describing what Ant is intended to
  376. be.</p>
  377. <p class="faq">
  378. <a name="history"></a>
  379. Tell us a little bit about Ant's history.
  380. </p>
  381. <p>Initially, Ant was part of the Tomcat code base, when it was
  382. donated to the Apache Software Foundation. It was
  383. created by James Duncan Davidson, who is also the original
  384. author of Tomcat. Ant was there to build Tomcat, nothing
  385. else.</p>
  386. <p>Soon thereafter, several open source Java projects realized
  387. that Ant could solve the problems they had with Makefiles.
  388. Starting with the projects hosted at Jakarta and the old Java
  389. Apache project, Ant spread like a virus and is now the build
  390. tool of choice for a lot of projects.</p>
  391. <p>In January 2000, Ant was moved to a separate CVS module and
  392. was promoted to a project of its own, independent of
  393. Tomcat, and became Apache Ant.</p>
  394. <p>The first version of Ant that was exposed to a larger audience
  395. was the one that shipped with Tomcat's 3.1 release on 19 April
  396. 2000. This version has later been referred to as Ant
  397. 0.3.1.</p>
  398. <p>The first official release of Ant as a stand-alone product was
  399. Ant 1.1, released on 19 July 2000. The complete release
  400. history:</p>
  401. <table class="ForrestTable" cellspacing="1" cellpadding="4">
  402. <tr>
  403. <th colspan="1" rowspan="1"
  404. valign="top" align="left">
  405. Ant Version
  406. </th>
  407. <th colspan="1" rowspan="1"
  408. valign="top" align="left">
  409. Release Date
  410. </th>
  411. </tr>
  412. <tr>
  413. <td colspan="1" rowspan="1"
  414. valign="top" align="left">
  415. 1.1
  416. </td>
  417. <td colspan="1" rowspan="1"
  418. valign="top" align="left">
  419. 19 July 2000
  420. </td>
  421. </tr>
  422. <tr>
  423. <td colspan="1" rowspan="1"
  424. valign="top" align="left">
  425. 1.2
  426. </td>
  427. <td colspan="1" rowspan="1"
  428. valign="top" align="left">
  429. 24 October 2000
  430. </td>
  431. </tr>
  432. <tr>
  433. <td colspan="1" rowspan="1"
  434. valign="top" align="left">
  435. 1.3
  436. </td>
  437. <td colspan="1" rowspan="1"
  438. valign="top" align="left">
  439. 3 March 2001
  440. </td>
  441. </tr>
  442. <tr>
  443. <td colspan="1" rowspan="1"
  444. valign="top" align="left">
  445. 1.4
  446. </td>
  447. <td colspan="1" rowspan="1"
  448. valign="top" align="left">
  449. 3 September 2001
  450. </td>
  451. </tr>
  452. <tr>
  453. <td colspan="1" rowspan="1"
  454. valign="top" align="left">
  455. 1.4.1
  456. </td>
  457. <td colspan="1" rowspan="1"
  458. valign="top" align="left">
  459. 11 October 2001
  460. </td>
  461. </tr>
  462. <tr>
  463. <td colspan="1" rowspan="1"
  464. valign="top" align="left">
  465. 1.5
  466. </td>
  467. <td colspan="1" rowspan="1"
  468. valign="top" align="left">
  469. 10 July 2002
  470. </td>
  471. </tr>
  472. <tr>
  473. <td colspan="1" rowspan="1"
  474. valign="top" align="left">
  475. 1.5.1
  476. </td>
  477. <td colspan="1" rowspan="1"
  478. valign="top" align="left">
  479. 3 October 2002
  480. </td>
  481. </tr>
  482. <tr>
  483. <td colspan="1" rowspan="1"
  484. valign="top" align="left">
  485. 1.5.2
  486. </td>
  487. <td colspan="1" rowspan="1"
  488. valign="top" align="left">
  489. 3 March 2003
  490. </td>
  491. </tr>
  492. <tr>
  493. <td colspan="1" rowspan="1"
  494. valign="top" align="left">
  495. 1.5.3
  496. </td>
  497. <td colspan="1" rowspan="1"
  498. valign="top" align="left">
  499. 9 April 2003
  500. </td>
  501. </tr>
  502. <tr>
  503. <td colspan="1" rowspan="1"
  504. valign="top" align="left">
  505. 1.5.4
  506. </td>
  507. <td colspan="1" rowspan="1"
  508. valign="top" align="left">
  509. 12 August 2003
  510. </td>
  511. </tr>
  512. </table>
  513. <p class="faq">
  514. <a name="no-gnu-tar"></a>
  515. I get checksum errors when I try to extract the
  516. <code>tar.gz</code> distribution file. Why?
  517. </p>
  518. <p>Ant's distribution contains file names that are longer
  519. than 100 characters, which is not supported by the standard
  520. tar file format. Several different implementations of tar use
  521. different and incompatible ways to work around this
  522. restriction.</p>
  523. <p>Ant's &lt;tar&gt; task can create tar archives that use
  524. the GNU tar extension, and this has been used when putting
  525. together the distribution. If you are using a different
  526. version of tar (for example, the one shipping with Solaris),
  527. you cannot use it to extract the archive.</p>
  528. <p>The solution is to either install GNU tar, which can be
  529. found <a href="http://www.gnu.org/software/tar/tar.html">here</a>,
  530. or use the zip archive instead (you can extract it using
  531. <code>jar xf</code>).</p>
  532. <p class="faq">
  533. <a name="adding-external-tasks"></a>
  534. How do I add an external task that I've written to the
  535. page "External Tools and Task"?
  536. </p>
  537. <p>Join and post a message to the dev or user mailing
  538. list (one list is enough), including the following
  539. information:</p>
  540. <ul>
  541. <li>the name of the task/tool</li>
  542. <li>a short description of the task/tool</li>
  543. <li>a Compatibility: entry stating with which version(s) of
  544. Ant the tool/task is compatible to</li>
  545. <li>a URL: entry linking to the main page of the tool/task</li>
  546. <li>a Contact: entry containing the email address or the URL
  547. of a webpage for the person or list to contact for issues
  548. related to the tool/task. <strong>Note that we'll add a
  549. link on the page, so any email address added there is not
  550. obfuscated and can (and probably will) be abused by robots
  551. harvesting websites for addresses to spam.</strong></li>
  552. <li>a License: entry containing the type of license for the
  553. tool/task</li>
  554. </ul>
  555. <p>The preferred format for this information is a patch to <a href="http://cvs.apache.org/viewcvs.cgi/~checkout~/ant/xdocs/external.xml">this</a>
  556. document.</p>
  557. <p class="faq">
  558. <a name="passing-cli-args"></a>
  559. How do I pass parameters from the command line to my
  560. build file?
  561. </p>
  562. <p>Use properties. Using <code>ant
  563. -D<em>name</em>=<em>value</em></code> lets you define values for
  564. properties on the Ant command line. These properties can then be
  565. used within your build file as
  566. any normal property: <code>${<em>name</em>}</code> will put in
  567. <code><em>value</em></code>.</p>
  568. <p class="faq">
  569. <a name="jikes-switches"></a>
  570. How can I use Jikes-specific command-line
  571. switches?
  572. </p>
  573. <p>A couple of switches are supported via "magic"
  574. properties:</p>
  575. <table class="ForrestTable" cellspacing="1" cellpadding="4">
  576. <tr>
  577. <th colspan="1" rowspan="1"
  578. valign="top" align="left">
  579. switch
  580. </th>
  581. <th colspan="1" rowspan="1"
  582. valign="top" align="left">
  583. property
  584. </th>
  585. <th colspan="1" rowspan="1"
  586. valign="top" align="left">
  587. default
  588. </th>
  589. </tr>
  590. <tr>
  591. <td colspan="1" rowspan="1"
  592. valign="top" align="left">
  593. +E
  594. </td>
  595. <td colspan="1" rowspan="1"
  596. valign="top" align="left">
  597. build.compiler.emacs
  598. </td>
  599. <td colspan="1" rowspan="1"
  600. valign="top" align="left">
  601. false == not set
  602. </td>
  603. </tr>
  604. <tr>
  605. <td colspan="1" rowspan="1"
  606. valign="top" align="left">
  607. +P
  608. </td>
  609. <td colspan="1" rowspan="1"
  610. valign="top" align="left">
  611. build.compiler.pedantic
  612. </td>
  613. <td colspan="1" rowspan="1"
  614. valign="top" align="left">
  615. false == not set
  616. </td>
  617. </tr>
  618. <tr>
  619. <td colspan="1" rowspan="1"
  620. valign="top" align="left">
  621. +F
  622. </td>
  623. <td colspan="1" rowspan="1"
  624. valign="top" align="left">
  625. build.compiler.fulldepend
  626. </td>
  627. <td colspan="1" rowspan="1"
  628. valign="top" align="left">
  629. false == not set
  630. </td>
  631. </tr>
  632. <tr>
  633. <td colspan="1" rowspan="1"
  634. valign="top" align="left">
  635. <strong>(Only for Ant &lt; 1.4; replaced by the
  636. <code><strong>nowarn</strong></code>
  637. attribute of the <code><strong>&lt;javac&gt;</strong></code>
  638. task after that.)</strong><br />-nowarn
  639. </td>
  640. <td colspan="1" rowspan="1"
  641. valign="top" align="left">
  642. build.compiler.warnings
  643. </td>
  644. <td colspan="1" rowspan="1"
  645. valign="top" align="left">
  646. true == not set
  647. </td>
  648. </tr>
  649. </table>
  650. <p>With Ant &gt;= 1.5, you can also use nested
  651. <code>&lt;compilerarg&gt;</code> elements with the
  652. <code>&lt;javac&gt;</code> task.</p>
  653. <p class="faq">
  654. <a name="shell-redirect-1"></a>
  655. How do I include a &lt; character in my command-line arguments?
  656. </p>
  657. <p>The short answer is "Use: <code>&amp;lt;</code>".</p>
  658. <p>The long answer is that this probably won't do what you
  659. want anyway (see <a href="#shell-redirect-2">the next
  660. section</a>).</p>
  661. <p class="faq">
  662. <a name="shell-redirect-2"></a>
  663. How do I redirect standard input or standard output
  664. in the <code>&lt;exec&gt;</code> task?
  665. </p>
  666. <p>Say you want to redirect the standard output stream of the
  667. <code>m4</code> command to write to a file, something
  668. like:</p>
  669. <pre class="code">
  670. shell-prompt&gt; m4 foo.m4 &gt; foo
  671. </pre>
  672. <p>and try to translate it into</p>
  673. <pre class="code">
  674. &lt;exec executable=&quot;m4&quot;&gt;
  675. &lt;arg value=&quot;foo.m4&quot;/&gt;
  676. &lt;arg value=&quot;&amp;gt;&quot;/&gt;
  677. &lt;arg value=&quot;foo&quot;/&gt;
  678. &lt;/exec&gt;
  679. </pre>
  680. <p>This will not do what you expect. The output redirection is
  681. performed by your shell, not the command itself, so this
  682. should read:</p>
  683. <pre class="code">
  684. &lt;exec executable=&quot;/bin/sh&quot;&gt;
  685. &lt;arg value=&quot;-c&quot; /&gt;
  686. &lt;arg value=&quot;m4 foo.m4 &amp;gt; foo&quot; /&gt;
  687. &lt;/exec&gt;
  688. </pre>
  689. <p>Note that you must use the <code>value</code> attribute of
  690. <code>&lt;arg&gt;</code> in the last element, in order to have
  691. the command passed as a single, quoted argument. Alternatively,
  692. you can use:</p>
  693. <pre class="code">
  694. &lt;exec executable=&quot;/bin/sh&quot;&gt;
  695. &lt;arg line='-c &quot;m4 foo.m4 &amp;gt; foo&quot;'/&gt;
  696. &lt;/exec&gt;
  697. </pre>
  698. <p>Note the double-quotes nested inside the single-quotes.</p>
  699. <p class="faq">
  700. <a name="batch-shell-execute"></a>
  701. How do I execute a batch file or shell script from Ant?
  702. </p>
  703. <p>On native Unix systems, you should be able to run shell scripts
  704. directly. On systems running a Unix-type shell (for example, Cygwin
  705. on Windows) execute the (command) shell instead - <code>cmd</code>
  706. for batch files, <code>sh</code> for shell scripts - then pass the
  707. batch file or shell script (plus any arguments to the script)
  708. as a single command, using the <code>/c</code> or
  709. <code>-c</code> switch, respectively. See
  710. <a href="#shell-redirect-2">the above section</a>
  711. for example <code>&lt;exec&gt;</code> tasks
  712. executing <code>sh</code>. For batch files, use something like:</p>
  713. <pre class="code">
  714. &lt;exec dir=&quot;.&quot; executable=&quot;cmd&quot; os=&quot;Windows NT&quot;&gt;
  715. &lt;arg line=&quot;/c test.bat&quot;/&gt;
  716. &lt;/exec&gt;
  717. </pre>
  718. <p class="faq">
  719. <a name="multi-conditions"></a>
  720. I want to execute a particular target only if
  721. multiple conditions are true.
  722. </p>
  723. <p>There are actually several answers to this question.</p>
  724. <p>If you have only one set and one unset property to test,
  725. you can specify both an <code>if</code> and an <code>unless</code>
  726. attribute for the target, and they will act as if they
  727. are "anded" together.</p>
  728. <p>If you are using a version of Ant 1.3 or earlier, the
  729. way to work with all other cases is to chain targets together
  730. to determine the specific state you want to test for.</p>
  731. <p>To see how this works, assume you have three properties:
  732. <code>prop1</code>, <code>prop2</code>, and <code>prop3</code>.
  733. You want to test that <code>prop1</code> and <code>prop2</code>
  734. are set, and that <code>prop3</code> is not. If the condition
  735. holds true you want to echo "yes".</p>
  736. <p>Here is the implementation in Ant 1.3 and earlier:</p>
  737. <pre class="code">
  738. &lt;target name=&quot;cond&quot; depends=&quot;cond-if&quot;/&gt;
  739. &lt;target name=&quot;cond-if&quot; if=&quot;prop1&quot;&gt;
  740. &lt;antcall target=&quot;cond-if-2&quot;/&gt;
  741. &lt;/target&gt;
  742. &lt;target name=&quot;cond-if-2&quot; if=&quot;prop2&quot;&gt;
  743. &lt;antcall target=&quot;cond-if-3&quot;/&gt;
  744. &lt;/target&gt;
  745. &lt;target name=&quot;cond-if-3&quot; unless=&quot;prop3&quot;&gt;
  746. &lt;echo message=&quot;yes&quot;/&gt;
  747. &lt;/target&gt;
  748. </pre>
  749. <p>Note: <code>&lt;antcall&gt;</code> tasks do <em>not</em> pass
  750. property changes back up to the environment they were called
  751. from, so you would'nt be able to, for example, set a
  752. <code>result</code> property in the <code>cond-if-3</code> target,
  753. then do
  754. <code>&lt;echo message="result is ${result}"/&gt;</code>
  755. in the <code>cond</code> target.</p>
  756. <p>Starting with Ant 1.4, you can use the
  757. <code>&lt;condition&gt;</code> task.</p>
  758. <pre class="code">
  759. &lt;target name=&quot;cond&quot; depends=&quot;cond-if,cond-else&quot;/&gt;
  760. &lt;target name=&quot;check-cond&quot;&gt;
  761. &lt;condition property=&quot;cond-is-true&quot;&gt;
  762. &lt;and&gt;
  763. &lt;not&gt;
  764. &lt;equals arg1=&quot;${prop1}&quot; arg2=&quot;$${prop1}&quot; /&gt;
  765. &lt;/not&gt;
  766. &lt;not&gt;
  767. &lt;equals arg1=&quot;${prop2}&quot; arg2=&quot;$${prop2}&quot; /&gt;
  768. &lt;/not&gt;
  769. &lt;equals arg1=&quot;${prop3}&quot; arg2=&quot;$${prop3}&quot; /&gt;
  770. &lt;/and&gt;
  771. &lt;/condition&gt;
  772. &lt;/target&gt;
  773. &lt;target name=&quot;cond-if&quot; depends=&quot;check-cond&quot; if=&quot;cond-is-true&quot;&gt;
  774. &lt;echo message=&quot;yes&quot;/&gt;
  775. &lt;/target&gt;
  776. &lt;target name=&quot;cond-else&quot; depends=&quot;check-cond&quot; unless=&quot;cond-is-true&quot;&gt;
  777. &lt;echo message=&quot;no&quot;/&gt;
  778. &lt;/target&gt;
  779. </pre>
  780. <p>This version takes advantage of two things:</p>
  781. <ul>
  782. <li>If a property <code>a</code> has not been set,
  783. <code>${a}</code> will evaluate to <code>${a}</code>.</li>
  784. <li>To get a literal <code>$</code> in Ant, you have to
  785. escape it with another <code>$</code> - this will also break
  786. the special treatment of the <code>${</code> sequence.</li>
  787. </ul>
  788. <p>Because testing for a literal <code>${property}</code> string
  789. isn't all that readable or easy to understand,
  790. post-1.4.1 Ant introduces the <code>&lt;isset&gt;</code> element
  791. to the <code>&lt;condition&gt;</code> task.</p>
  792. <p>Here is the previous example done using
  793. <code>&lt;isset&gt;</code>:</p>
  794. <pre class="code">
  795. &lt;target name=&quot;check-cond&quot;&gt;
  796. &lt;condition property=&quot;cond-is-true&quot;&gt;
  797. &lt;and&gt;
  798. &lt;isset property=&quot;prop1&quot;/&gt;
  799. &lt;isset property=&quot;prop2&quot;/&gt;
  800. &lt;not&gt;
  801. &lt;isset property=&quot;prop3&quot;/&gt;
  802. &lt;/not&gt;
  803. &lt;/and&gt;
  804. &lt;/condition&gt;
  805. &lt;/target&gt;
  806. </pre>
  807. <p>The last option is to use a scripting language to set the
  808. properties. This can be particularly handy when you need much
  809. finer control than the simple conditions shown here but, of
  810. course, comes with the overhead of adding JAR files to support
  811. the language, to say nothing of the added maintenance in requiring
  812. two languages to implement a single system. See the
  813. <a href="manual/OptionalTasks/script.html">
  814. <code>&lt;script&gt;</code> task documentation</a> for more
  815. details.</p>
  816. <p class="faq">
  817. <a name="encoding"></a>
  818. How can I include national characters like German
  819. umlauts in my build file?
  820. </p>
  821. <p>You need to tell the XML parser which character encoding
  822. your build file uses, this is done inside the <a href="http://www.w3.org/TR/2000/REC-xml-20001006#sec-prolog-dtd">XML
  823. declaration</a>.</p>
  824. <p>By default the parser assumes you are using the UTF-8
  825. encoding instead of your platform's default. For most Western
  826. European countries you should set the encoding to
  827. <code>ISO-8859-1</code>. To do so, make the very first line
  828. of you build file read like</p>
  829. <pre class="code">
  830. &lt;?xml version=&quot;1.0&quot; encoding=&quot;ISO-8859-1&quot; ?&gt;
  831. </pre>
  832. <p class="faq">
  833. <a name="always-recompiles"></a>
  834. Why does Ant always recompile all my Java files?
  835. </p>
  836. <p>In order to find out which files should be compiled, Ant
  837. compares the timestamps of the source files to those of the
  838. resulting <code>.class</code> files. Opening all source files
  839. to find out which package they belong to would be very
  840. inefficient. Instead, Ant expects you to place your
  841. source files in a directory hierarchy that mirrors your
  842. package hierarchy and to point Ant to the root of this
  843. directory tree with the <code>srcdir</code> attribute.</p>
  844. <p>Say you have <code>&lt;javac srcdir="src"
  845. destdir="dest"/&gt;</code>. If Ant finds a file
  846. <code>src/a/b/C.java</code>, it expects it to be in package
  847. <code>a.b</code> so that the resulting <code>.class</code>
  848. file is going to be <code>dest/a/b/C.class</code>.</p>
  849. <p>If your source-tree directory structure does not match your
  850. package structure, Ant's heuristic won't work, and
  851. it will recompile classes that are up-to-date. Ant is not the
  852. only tool that expects a source-tree layout like this.</p>
  853. <p>If you have Java source files that aren't declared to
  854. be part of any package, you can still use the <code>&lt;javac&gt;</code>
  855. task to compile these files correctly - just set the
  856. <code>srcdir</code> and <code>destdir</code> attributes to
  857. the actual directory the source
  858. files live in and the directory the class files should go into,
  859. respectively.</p>
  860. <p class="faq">
  861. <a name="defaultexcludes"></a>
  862. I've used a <code>&lt;delete&gt;</code> task to
  863. delete unwanted SourceSafe control files (CVS files, editor
  864. backup files, etc.), but it doesn't seem to work; the files
  865. never get deleted. What's wrong?
  866. </p>
  867. <p>This is probably happening because, by default, Ant excludes
  868. SourceSafe control files (<code>vssver.scc</code>) and certain other
  869. files from FileSets.</p>
  870. <p>Here's what you probably did:</p>
  871. <pre class="code">
  872. &lt;delete&gt;
  873. &lt;fileset dir=&quot;${build.src}&quot; includes=&quot;**/vssver.scc&quot;/&gt;
  874. &lt;/delete&gt;
  875. </pre>
  876. <p>You need to switch off the default exclusions,
  877. and it will work:</p>
  878. <pre class="code">
  879. &lt;delete&gt;
  880. &lt;fileset dir=&quot;${build.src}&quot; includes=&quot;**/vssver.scc&quot;
  881. defaultexcludes=&quot;no&quot;/&gt;
  882. &lt;/delete&gt;
  883. </pre>
  884. <p>For a complete listing of the patterns that are excluded
  885. by default, see <a href="manual/dirtasks.html#defaultexcludes">the user
  886. manual</a>.</p>
  887. <p class="faq">
  888. <a name="stop-dependency"></a>
  889. I have a target I want to skip if a property is set,
  890. so I have <code>unless="property"</code> as an attribute
  891. of the target, but all the targets this target
  892. depends on are still executed. Why?
  893. </p>
  894. <p>The list of dependencies is generated by Ant before any of the
  895. targets are run. This allows dependent targets, such as an
  896. <code>init</code> target, to set properties that can control the
  897. execution of the targets higher in the dependency graph. This
  898. is a good thing.</p>
  899. <p>However, when your dependencies break down the
  900. higher-level task
  901. into several smaller steps, this behaviour becomes
  902. counter-intuitive. There are a couple of solutions available:
  903. </p>
  904. <ol>
  905. <li>Put the same condition on each of the dependent targets.</li>
  906. <li>Execute the steps using <code>&lt;antcall&gt;</code>,
  907. instead of specifying them inside the <code>depends</code>
  908. attribute.</li>
  909. </ol>
  910. <p class="faq">
  911. <a name="include-order"></a>
  912. In my <code>&lt;fileset&gt;</code>, I've put in an
  913. <code>&lt;exclude&gt;</code> of all files followed by an
  914. <code>&lt;include&gt;</code> of just the files I want, but it
  915. isn't giving me any files at all. What's wrong?
  916. </p>
  917. <p>The order of the <code>&lt;include&gt;</code> and
  918. <code>&lt;exclude&gt;</code> tags within a <code>&lt;fileset&gt;</code>
  919. is ignored when the FileSet is created. Instead, all of the
  920. <code>&lt;include&gt;</code> elements are processed together,
  921. followed by all of the <code>&lt;exclude&gt;</code>
  922. elements. This means that the <code>&lt;exclude&gt;</code>
  923. elements only apply to the file list produced by the
  924. <code>&lt;include&gt;</code> elements.</p>
  925. <p>To get the files you want, focus on just the
  926. <code>&lt;include&gt;</code> patterns that would be necessary
  927. to get them. If you find you need to trim the list that the
  928. <code>&lt;include&gt;</code> elements produce, then use
  929. <code>&lt;exclude&gt;</code> elements.</p>
  930. <p class="faq">
  931. <a name="properties-not-trimmed"></a>
  932. <code>ant</code> failed to build my program via javac
  933. even when I put the needed jars in an external
  934. <code>build.properties</code> file and reference them by
  935. <code>pathelement</code> or <code>classpath refid</code>.
  936. </p>
  937. <p>When <code>ant</code> loads properties from an external
  938. file it dosn't touch the value of properties, trailing blanks
  939. will not be trimmed for example.</p>
  940. <p>If the value represents a file path, like a jar needed to
  941. compile, the task which requires the value, javac for example
  942. would fail to compile since it can't find the file due to
  943. trailing spaces.</p>
  944. <p class="faq">
  945. <a name="winzip-lies"></a>
  946. Ant creates WAR files with a lower-case
  947. <code>web-inf</code> or JAR files with a lower-case
  948. <code>meta-inf</code> directory.
  949. </p>
  950. <p>No it doesn't.</p>
  951. <p>You may have seen these lower-case directory names in
  952. WinZIP, but WinZIP is trying to be helpful (and fails). If
  953. WinZIP encounters a filename that is all upper-case, it
  954. assumes it has come from an old DOS box andchanges the case to
  955. all lower-case for you.</p>
  956. <p>If you extract (or just check) the archive with jar, you
  957. will see that the names have the correct case.</p>
  958. <p>With WinZIP (version 8.1 at least), this can be corrected in the
  959. configuration. In the Options/Configuration menu, in the View tab, General
  960. section, check the "Allow all upper case files names" box. The META-INF and
  961. WEB-INF will look correct.</p>
  962. <p class="faq">
  963. <a name="integration"></a>
  964. Is Ant supported by my IDE/Editor?
  965. </p>
  966. <p>See the <a href="external.html#IDE and Editor Integration">section
  967. on IDE integration</a> on our External Tools and Tasks page.</p>
  968. <p class="faq">
  969. <a name="emacs-mode"></a>
  970. Why doesn't (X)Emacs/vi/MacOS X's project builder
  971. correctly parse the error messages generated by Ant?
  972. </p>
  973. <p>Ant adds a "banner" with the name of the current
  974. task in front of all logging messages - and there are no built-in
  975. regular expressions in your editor that would account for
  976. this.</p>
  977. <p>You can disable this banner by invoking Ant with the
  978. <code>-emacs</code> switch. To make Ant autodetect
  979. Emacs' compile mode, put this into your
  980. <code>.antrc</code> (contributed by Ville Skytt�).</p>
  981. <pre class="code">
  982. # Detect (X)Emacs compile mode
  983. if [ &quot;$EMACS&quot; = &quot;t&quot; ] ; then
  984. ANT_ARGS=&quot;$ANT_ARGS -emacs&quot;
  985. ANT_OPTS=&quot;$ANT_OPTS -Dbuild.compiler.emacs=true&quot;
  986. fi
  987. </pre>
  988. <p>Alternatively, you can add the following snippet to your
  989. <code>.emacs</code> to make Emacs understand Ant's
  990. output.</p>
  991. <pre class="code">
  992. (require 'compile)
  993. (setq compilation-error-regexp-alist
  994. (append (list
  995. ;; works for jikes
  996. '(&quot;^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):\\([0-9]+\\):[0-9]+:[0-9]+:&quot; 1 2 3)
  997. ;; works for javac
  998. '(&quot;^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):&quot; 1 2))
  999. compilation-error-regexp-alist))
  1000. </pre>
  1001. <p>Yet another alternative that preserves most of Ant's
  1002. formatting is to pipe Ant's output through the following Perl
  1003. script by Dirk-Willem van Gulik:</p>
  1004. <pre class="code">
  1005. #!/usr/bin/perl
  1006. #
  1007. # May 2001 dirkx@apache.org - remove any
  1008. # [foo] lines from the output; keeping
  1009. # spacing more or less there.
  1010. #
  1011. $|=1;
  1012. while(&lt;STDIN&gt;) {
  1013. if (s/^(\s+)\[(\w+)\]//) {
  1014. if ($2 ne $last) {
  1015. print &quot;$1\[$2\]&quot;;
  1016. $s = ' ' x length($2);
  1017. } else {
  1018. print &quot;$1 $s &quot;;
  1019. };
  1020. $last = $2;
  1021. };
  1022. print;
  1023. };
  1024. </pre>
  1025. <p class="faq">
  1026. <a name="dtd"></a>
  1027. Is there a DTD that I can use to validate my build
  1028. files?
  1029. </p>
  1030. <p>An incomplete DTD can be created by the
  1031. <code>&lt;antstructure&gt;</code> task - but this one
  1032. has a few problems:</p>
  1033. <ul>
  1034. <li>It doesn't know about required attributes. Only
  1035. manual tweaking of this file can help here.</li>
  1036. <li>It is not complete - if you add new tasks via
  1037. <code>&lt;taskdef&gt;</code> it won't know about it. See
  1038. <a href="http://www.sdv.fr/pages/casa/html/ant-dtd.en.html">this
  1039. page</a> by Michel Casabianca for a solution to this
  1040. problem. Note that the DTD you can download at this page
  1041. is based on Ant 0.3.1.</li>
  1042. <li>It may even be an invalid DTD. As Ant allows tasks
  1043. writers to define arbitrary elements, name collisions will
  1044. happen quite frequently - if your version of Ant contains
  1045. the optional <code>&lt;test&gt;</code> and
  1046. <code>&lt;junit&gt;</code> tasks, there are two XML
  1047. elements named <code>test</code> (the task and the nested child
  1048. element of <code>&lt;junit&gt;</code>) with different attribute
  1049. lists. This problem cannot be solved; DTDs don't give a
  1050. syntax rich enough to support this.</li>
  1051. </ul>
  1052. <p class="faq">
  1053. <a name="xml-entity-include"></a>
  1054. How do I include an XML snippet in my build file?
  1055. </p>
  1056. <p>You can use XML's way of including external files and let
  1057. the parser do the job for Ant:</p>
  1058. <pre class="code">
  1059. &lt;?xml version=&quot;1.0&quot;?&gt;
  1060. &lt;!DOCTYPE project [
  1061. &lt;!ENTITY common SYSTEM &quot;file:./common.xml&quot;&gt;
  1062. ]&gt;
  1063. &lt;project name=&quot;test&quot; default=&quot;test&quot; basedir=&quot;.&quot;&gt;
  1064. &lt;target name=&quot;setup&quot;&gt;
  1065. ...
  1066. &lt;/target&gt;
  1067. &amp;common;
  1068. ...
  1069. &lt;/project&gt;
  1070. </pre>
  1071. <p>will literally include the contents of <code>common.xml</code> where
  1072. you've placed the <code>&amp;common;</code> entity.</p>
  1073. <p>In combination with a DTD, this would look like this:</p>
  1074. <pre class="code">
  1075. &lt;!DOCTYPE project PUBLIC &quot;-//ANT//DTD project//EN&quot; &quot;file:./ant.dtd&quot; [
  1076. &lt;!ENTITY include SYSTEM &quot;file:./header.xml&quot;&gt;
  1077. ]&gt;
  1078. </pre>
  1079. <p class="faq">
  1080. <a name="mail-logger"></a>
  1081. How do I send an email with the result of my build
  1082. process?
  1083. </p>
  1084. <p>If you are using a nightly build of Ant 1.5 after
  1085. 2001-12-14, you can use the built-in MailLogger:</p>
  1086. <pre class="code">
  1087. ant -logger org.apache.tools.ant.listener.MailLogger
  1088. </pre>
  1089. <p>See the <a href="http://cvs.apache.org/viewcvs/~checkout~/ant/docs/manual/listeners.html?content-type=text/html">Listeners
  1090. &amp; Loggers</a> documentation for details on the properties
  1091. required.</p>
  1092. <p>For older versions of Ant, you can use a custom
  1093. BuildListener that sends out an email
  1094. in the buildFinished() method. Will Glozer
  1095. &lt;will.glozer@jda.com&gt; has written such a listener based
  1096. on <a href="http://java.sun.com/products/javamail/">JavaMail</a>.
  1097. The source is:</p>
  1098. <pre class="code">
  1099. import java.io.*;
  1100. import java.util.*;
  1101. import javax.mail.*;
  1102. import javax.mail.internet.*;
  1103. import org.apache.tools.ant.*;
  1104. /**
  1105. * A simple listener that waits for a build to finish and sends an email
  1106. * of the results. The settings are stored in &quot;monitor.properties&quot; and
  1107. * are fairly self explanatory.
  1108. *
  1109. * @author Will Glozer
  1110. * @version 1.05a 09/06/2000
  1111. */
  1112. public class BuildMonitor implements BuildListener {
  1113. protected Properties props;
  1114. /**
  1115. * Create a new BuildMonitor.
  1116. */
  1117. public BuildMonitor() throws Exception {
  1118. props = new Properties();
  1119. InputStream is = getClass().getResourceAsStream(&quot;monitor.properties&quot;);
  1120. props.load(is);
  1121. is.close();
  1122. }
  1123. public void buildStarted(BuildEvent e) {
  1124. }
  1125. /**
  1126. * Determine the status of the build and the actions to follow, now that
  1127. * the build has completed.
  1128. *
  1129. * @param e Event describing the build status.
  1130. */
  1131. public void buildFinished(BuildEvent e) {
  1132. Throwable th = e.getException();
  1133. String status = (th != null) ? &quot;failed&quot; : &quot;succeeded&quot;;
  1134. try {
  1135. String key = &quot;build.&quot; + status;
  1136. if (props.getProperty(key + &quot;.notify&quot;).equalsIgnoreCase(&quot;false&quot;)) {
  1137. return;
  1138. }
  1139. Session session = Session.getDefaultInstance(props, null);
  1140. MimeMessage message = new MimeMessage(session);
  1141. message.addRecipients(Message.RecipientType.TO, parseAddresses(
  1142. props.getProperty(key + &quot;.email.to&quot;)));
  1143. message.setSubject(props.getProperty(key + &quot;.email.subject&quot;));
  1144. BufferedReader br = new BufferedReader(new FileReader(
  1145. props.getProperty(&quot;build.log&quot;)));
  1146. StringWriter sw = new StringWriter();
  1147. String line = br.readLine();
  1148. while (line != null) {
  1149. sw.write(line);
  1150. sw.write(&quot;\n&quot;);
  1151. line = br.readLine();
  1152. }
  1153. br.close();
  1154. message.setText(sw.toString(), &quot;UTF-8&quot;);
  1155. sw.close();
  1156. Transport transport = session.getTransport();
  1157. transport.connect();
  1158. transport.send(message);
  1159. transport.close();
  1160. } catch (Exception ex) {
  1161. System.out.println(&quot;BuildMonitor failed to send email!&quot;);
  1162. ex.printStackTrace();
  1163. }
  1164. }
  1165. /**
  1166. * Parse a comma separated list of internet email addresses.
  1167. *
  1168. * @param s The list of addresses.
  1169. * @return Array of Addresses.
  1170. */
  1171. protected Address[] parseAddresses(String s) throws Exception {
  1172. StringTokenizer st = new StringTokenizer(s, &quot;,&quot;);
  1173. Address[] addrs = new Address[st.countTokens()];
  1174. for (int i = 0; i &lt; addrs.length; i++) {
  1175. addrs[i] = new InternetAddress(st.nextToken());
  1176. }
  1177. return addrs;
  1178. }
  1179. public void messageLogged(BuildEvent e) {
  1180. }
  1181. public void targetStarted(BuildEvent e) {
  1182. }
  1183. public void targetFinished(BuildEvent e) {
  1184. }
  1185. public void taskStarted(BuildEvent e) {
  1186. }
  1187. public void taskFinished(BuildEvent e) {
  1188. }
  1189. }
  1190. </pre>
  1191. <p>With a <code>monitor.properties</code> like this:</p>
  1192. <pre class="code">
  1193. # configuration for build monitor
  1194. mail.transport.protocol=smtp
  1195. mail.smtp.host=&lt;host&gt;
  1196. mail.from=Will Glozer &lt;will.glozer@jda.com&gt;
  1197. build.log=build.log
  1198. build.failed.notify=true
  1199. build.failed.email.to=will.glozer@jda.com
  1200. build.failed.email.subject=Nightly build failed!
  1201. build.succeeded.notify=true
  1202. build.succeeded.email.to=will.glozer@jda.com
  1203. build.succeeded.email.subject=Nightly build succeeded!
  1204. </pre>
  1205. <p><code>monitor.properties</code> should be placed right next
  1206. to your compiled <code>BuildMonitor.class</code>. To use it,
  1207. invoke Ant like:</p>
  1208. <pre class="code">
  1209. ant -listener BuildMonitor -logfile build.log
  1210. </pre>
  1211. <p>Make sure that <code>mail.jar</code> from JavaMail and
  1212. <code>activation.jar</code> from the
  1213. <a href="http://java.sun.com/products/javabeans/glasgow/jaf.html">Java
  1214. Beans Activation Framework</a> are in your <code>CLASSPATH</code>.</p>
  1215. <p class="faq">
  1216. <a name="listener-properties"></a>
  1217. How do I get at the properties that Ant was running
  1218. with from inside BuildListener?
  1219. </p>
  1220. <p>You can get at a hashtable with all the properties that Ant
  1221. has been using through the BuildEvent parameter. For
  1222. example:</p>
  1223. <pre class="code">
  1224. public void buildFinished(BuildEvent e) {
  1225. Hashtable table = e.getProject().getProperties();
  1226. String buildpath = (String)table.get(&quot;build.path&quot;);
  1227. ...
  1228. }
  1229. </pre>
  1230. <p>This is more accurate than just reading the same property
  1231. files that your project does, since it will give the correct
  1232. results for properties that were specified on the Ant command line.</p>
  1233. <p class="faq">
  1234. <a name="remove-cr"></a>
  1235. &lt;chmod&gt; or &lt;exec&gt; doesn't work in Ant
  1236. 1.3 on Unix
  1237. </p>
  1238. <p>The <code>antRun</code> script in <code>ANT_HOME/bin</code>
  1239. has DOS instead of Unix line endings; you must remove the
  1240. carriage-return characters from this file. This can be done by
  1241. using Ant's <code>&lt;fixcrlf&gt;</code> task
  1242. or something like:</p>
  1243. <pre class="code">
  1244. tr -d '\r' &lt; $ANT_HOME/bin/antRun &gt; /tmp/foo
  1245. mv /tmp/foo $ANT_HOME/bin/antRun
  1246. </pre>
  1247. <p class="faq">
  1248. <a name="javadoc-cannot-execute"></a>
  1249. JavaDoc failed: java.io.IOException: javadoc: cannot execute
  1250. </p>
  1251. <p>There is a bug in the Solaris reference implementation of
  1252. the JDK (see <a href="http://developer.java.sun.com/developer/bugParade/bugs/4230399.html">http://developer.java.sun.com/developer/bugParade/bugs/4230399.html</a>).
  1253. This also appears to be true under Linux. Moving the JDK to
  1254. the front of the PATH fixes the problem.</p>
  1255. <p class="faq">
  1256. <a name="delegating-classloader"></a>
  1257. &lt;style&gt; or &lt;junit&gt; ignores my
  1258. &lt;classpath&gt;
  1259. </p>
  1260. <p>These tasks don't ignore your classpath setting, you
  1261. are facing a common problem with delegating classloaders.</p>
  1262. <p>First of all let's state that Ant adds all
  1263. <code>.jar</code> files from <code>ANT_HOME/lib</code> to
  1264. <code>CLASSPATH</code>, therefore "in
  1265. <code>CLASSPATH</code>" shall mean "either in your
  1266. <code>CLASSPATH</code> environment variable or
  1267. <code>ANT_HOME/lib</code>" for the rest of this
  1268. answer.</p>
  1269. <p>This question collects a common type of problem: A task
  1270. needs an external library and it has a nested classpath
  1271. element so that you can point it to this external library, but
  1272. that doesn't work unless you put the external library into the
  1273. <code>CLASSPATH</code>.</p>
  1274. <p>The root of the problem is that the class that needs the
  1275. external library is on the <code>CLASSPATH</code>.</p>
  1276. <p>When you specify a nested <code>&lt;classpath&gt;</code> in
  1277. Ant, Ant creates a new class loader that uses the path you
  1278. have specified. It then tries to load additional classes from
  1279. this classloader.</p>
  1280. <p>In most cases - for example the two cases above - Ant
  1281. doesn't load the external library directly, it is the loaded
  1282. class that does so.</p>
  1283. <p>In the case of <code>&lt;junit&gt;</code> it is the task
  1284. implementation itself and in the case of
  1285. <code>&lt;style&gt;</code> it is the implementation of the
  1286. <code>org.apache.tools.ant.taskdefs.XSLTLiaison</code>
  1287. class.</p>
  1288. <p>Ant's class loader implementation uses Java's
  1289. delegation model, see <a href="http://java.sun.com/products/jdk/1.2/docs/api/java/lang/ClassLoader.html">http://java.sun.com/products/jdk/1.2/docs/api/java/lang/ClassLoader.html</a>
  1290. the paragraph</p>
  1291. <blockquote>The <code>ClassLoader</code> class uses a
  1292. delegation model to search for classes and resources. Each
  1293. instance of <code>ClassLoader</code> has an associated parent
  1294. class loader. When called upon to find a class or resource, a
  1295. <code>ClassLoader</code> instance will delegate the search for
  1296. the class or resource to its parent class loader before
  1297. attempting to find the class or resource itself. The virtual
  1298. machine's built-in class loader, called the bootstrap
  1299. class loader, does not itself have a parent but may serve as
  1300. the parent of a <code>ClassLoader</code>
  1301. instance.</blockquote>
  1302. <p>This means, Ant's class loader will consult the
  1303. bootstrap class loader first, which tries to load classes from
  1304. <code>CLASSPATH</code>. The bootstrap class loader
  1305. doesn't know anything about Ant's class loader or
  1306. even the path you have specified.</p>
  1307. <p>If the bootstrap class loader can load the class Ant has
  1308. asked it to load, this class will try to load the external
  1309. library from <code>CLASSPATH</code> as well - it doesn't
  1310. know anything else - and will not find it unless the library
  1311. is in <code>CLASSPATH</code> as well.</p>
  1312. <p>To solve this, you have two major options:</p>
  1313. <ol>
  1314. <li>put all external libraries you need in
  1315. <code>CLASSPATH</code> as well this is not what you want,
  1316. otherwise you wouldn't have found this FAQ entry.</li>
  1317. <li>remove the class that loads the external library from
  1318. the <code>CLASSPATH</code>.</li>
  1319. </ol>
  1320. <p>The easiest way to do this is to remove
  1321. <code>optional.jar</code> from <code>ANT_HOME/lib</code>. If
  1322. you do so, you will have to <code>&lt;taskdef&gt;</code> all
  1323. optional tasks and use nested <code>&lt;classpath&gt;</code>
  1324. elements in the <code>&lt;taskdef&gt;</code> tasks that point
  1325. to the new location of <code>optional.jar</code>. Also,
  1326. don't forget to add the new location of
  1327. <code>optional.jar</code> to the
  1328. <code>&lt;classpath&gt;</code> of your
  1329. <code>&lt;style&gt;</code> or <code>&lt;junit&gt;</code>
  1330. task.</p>
  1331. <p>If you want to avoid to <code>&lt;taskdef&gt;</code> all
  1332. optional tasks you need, the only other option is to remove
  1333. the classes that should not be loaded via the bootstrap class
  1334. loader from <code>optional.jar</code> and put them into a
  1335. separate archive. Add this separate archive to the
  1336. <code>&lt;classpath&gt;</code> of your
  1337. <code>&lt;style&gt;</code> or <code>&lt;junit&gt;</code> task
  1338. - and make sure the separate archive is not in
  1339. <code>CLASSPATH</code>.</p>
  1340. <p>In the case of <code>&lt;junit&gt;</code> you'd have
  1341. to remove all classes that are in the
  1342. <code>org/apache/tools/ant/taskdefs/optional/junit</code>
  1343. directory, in the <code>&lt;style&gt;</code> case it is one of
  1344. the <code>*Liaison</code> classes in
  1345. <code>org/apache/tools/ant/taskdefs/optional</code>.</p>
  1346. <p>If you use the option to break up <code>optional.jar</code>
  1347. for <code>&lt;junit&gt;</code>, you still have to use a
  1348. <code>&lt;taskdef&gt;</code> with a nested
  1349. <code>&lt;classpath&gt;</code> to define the junit task.</p>
  1350. <p class="faq">
  1351. <a name="winxp-jdk14-ant14"></a>
  1352. When running Ant 1.4 on Windows XP and JDK 1.4, I get
  1353. various errors when trying to <code>&lt;exec&gt;</code>, fork
  1354. <code>&lt;java&gt;</code> or access environment
  1355. variables.
  1356. </p>
  1357. <p>Ant &lt; 1.5 doesn't recognize Windows XP as a flavor
  1358. of Windows that runs <code>CMD.EXE</code> instead of
  1359. <code>COMMAND.COM</code>. JDK 1.3 will tell Ant that Windows
  1360. XP is Windows 2000 so the problem doesn't show up
  1361. there.</p>
  1362. <p>Apart from upgrading to Ant 1.5 or better, setting the
  1363. environment variable <code>ANT_OPTS</code> to
  1364. <code>-Dos.name=Windows_NT</code> prior to invoking Ant has
  1365. been confirmed as a workaround.</p>
  1366. <p class="faq">
  1367. <a name="1.5-cygwin-sh"></a>
  1368. The <code>ant</code> wrapper script of Ant 1.5 fails
  1369. for Cygwin if <code>ANT_HOME</code> is set to a Windows style
  1370. path.
  1371. </p>
  1372. <p>This problem has been reported only hours after Ant 1.5 has
  1373. been released, see <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=10664">Bug
  1374. 10664</a> and all its duplicates.</p>
  1375. <p>A fixed version of the wrapper script can be found <a href="http://ant.apache.org/old-releases/v1.5/errata/">here</a>.
  1376. Simply replace your script with this version.</p>
  1377. <p class="faq">
  1378. <a name="1.5.2-zip-broken"></a>
  1379. <code>&lt;zip&gt;</code> is broken in Ant 1.5.2.
  1380. </p>
  1381. <p>Yes, it is.</p>
  1382. <p>The problem reported by most people - see <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=17648">Bug
  1383. 17648</a> and all its duplicates - is that Ant creates
  1384. archives that a partially unreadable by WinZIP. Luckily
  1385. <code>jar</code> deals with the archives and so the generated
  1386. jars/wars/ears will most likely work for you anyway.</p>
  1387. <p>There are additional problems, see bugs <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=17780">Bug
  1388. 17780</a>, <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=17871">Bug
  1389. 17871</a> and <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=18403">Bug
  1390. 18403</a>. All of them are supposed to be fixed with Ant
  1391. 1.5.3 (and only 18403 should exist in 1.5.3beta1).</p>
  1392. </div>
  1393. </div>
  1394. <p class="copyright">
  1395. Copyright &copy; 2000-2003&nbsp;The Apache Software Foundation. All rights reserved.
  1396. <script type="text/javascript" language="JavaScript"><!--
  1397. document.write(" - "+"Last Published: " + document.lastModified);
  1398. // -->
  1399. </script>
  1400. </p>
  1401. </body>
  1402. </html>