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 89 KiB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063
  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="http://wiki.apache.org/ant/FrontPage">Wiki</a>
  105. </li>
  106. <li>
  107. <a href="./problems.html">Having Problems?</a>
  108. </li>
  109. </ul>
  110. </li>
  111. <li class="menuheader">Download
  112. <ul>
  113. <li>
  114. <a href="http://ant.apache.org/bindownload.cgi">Binary Distributions</a>
  115. </li>
  116. <li>
  117. <a href="http://ant.apache.org/srcdownload.cgi">Source Distributions</a>
  118. </li>
  119. </ul>
  120. </li>
  121. <li class="menuheader">Contributing
  122. <ul>
  123. <li>
  124. <a href="./mail.html">Mailing Lists</a>
  125. </li>
  126. <li>
  127. <a href="./svn.html">Subversion Repositories</a>
  128. </li>
  129. <li>
  130. <a href="./nightlies.html">Nightly Builds</a>
  131. </li>
  132. <li>
  133. <a href="./bugs.html">Bug Database</a>
  134. </li>
  135. <li>
  136. <a href="http://www.apache.org/foundation/contributing.html">Donations</a>
  137. </li>
  138. </ul>
  139. </li>
  140. <li class="menuheader">Project Management
  141. <ul>
  142. <li>
  143. <a href="./contributors.html">Contributors</a>
  144. </li>
  145. <li>
  146. <a href="./mission.html">Apache Ant Mission</a>
  147. </li>
  148. <li>
  149. <a href="./bylaws.html">Project Bylaws</a>
  150. </li>
  151. <li>
  152. <a href="./legal.html">Legal</a>
  153. </li>
  154. </ul>
  155. </li>
  156. </ul>
  157. </div>
  158. <center>
  159. <!--#include virtual="/ads/buttonbar.html" -->
  160. </center>
  161. <img style="float: left" height="10" width="10" border="0" alt="" src="./images/menu-left.gif">
  162. <img style="float: right" height="10" width="10" border="0" alt="" src="./images/menu-right.gif">
  163. </div>
  164. <div class="lightbluebar">&nbsp;</div>
  165. <div class="main">
  166. <div class="content">
  167. <h1 class="title">Frequently Asked Questions</h1>
  168. <h3 class="section">Questions</h3>
  169. <h4 class="toc">About this FAQ</h4>
  170. <ul>
  171. <li><a href="#latest-version">
  172. Where do I find the latest version of this
  173. document?
  174. </a></li>
  175. <li><a href="#adding-faqs">
  176. How can I contribute to this FAQ?
  177. </a></li>
  178. <li><a href="#creating-faq">
  179. How do you create the HTML version of this
  180. FAQ?
  181. </a></li>
  182. </ul>
  183. <h4 class="toc">General</h4>
  184. <ul>
  185. <li><a href="#what-is-ant">
  186. What is Apache Ant?
  187. </a></li>
  188. <li><a href="#ant-name">
  189. Why do you call it Ant?
  190. </a></li>
  191. <li><a href="#history">
  192. Tell us a little bit about Ant's history.
  193. </a></li>
  194. </ul>
  195. <h4 class="toc">Installation</h4>
  196. <ul>
  197. <li><a href="#no-gnu-tar">
  198. I get checksum errors when I try to extract the
  199. <code>tar.gz</code> distribution file. Why?
  200. </a></li>
  201. <li><a href="#RedHat_ES_3">
  202. How do you get ant-1.6.x (or any version later than
  203. 1.5.2) to work on on RedHat ES 3?
  204. </a></li>
  205. </ul>
  206. <h4 class="toc">How do I ...</h4>
  207. <ul>
  208. <li><a href="#implement-os-specific-configuration">
  209. How do I realize os--specific configurations?
  210. </a></li>
  211. <li><a href="#adding-external-tasks">
  212. How do I add an external task that I've written to the
  213. page "External Tools and Tasks"?
  214. </a></li>
  215. <li><a href="#create-extensions">
  216. How do I create new tasks?
  217. </a></li>
  218. <li><a href="#passing-cli-args">
  219. How do I pass parameters from the command line to my
  220. build file?
  221. </a></li>
  222. <li><a href="#jikes-switches">
  223. How can I use Jikes-specific command-line
  224. switches?
  225. </a></li>
  226. <li><a href="#shell-redirect-1">
  227. How do I include a &lt; character in my command-line arguments?
  228. </a></li>
  229. <li><a href="#shell-redirect-2">
  230. How do I redirect standard input or standard output
  231. in the <code>&lt;exec&gt;</code> task?
  232. </a></li>
  233. <li><a href="#batch-shell-execute">
  234. How do I execute a batch file or shell script from Ant?
  235. </a></li>
  236. <li><a href="#multi-conditions">
  237. I want to execute a particular target only if
  238. multiple conditions are true.
  239. </a></li>
  240. <li><a href="#encoding">
  241. How can I include national characters like German
  242. umlauts in my build file?
  243. </a></li>
  244. <li><a href="#use-zip-instead-of-jar">
  245. How do I use <code>jar</code>'s <code>M</code> switch?
  246. I don't want a MANIFEST.
  247. </a></li>
  248. <li><a href="#propertyvalue-as-name-for-property">
  249. How can I do something like <code>&lt;property name="prop"
  250. value="${${anotherprop}}"/&gt;</code> (double expanding the property)?
  251. </a></li>
  252. <li><a href="#delete-directory-children-only">
  253. How can I delete everything beneath a particular directory,
  254. preserving the directory itself?
  255. </a></li>
  256. </ul>
  257. <h4 class="toc">It doesn't work (as expected)</h4>
  258. <ul>
  259. <li><a href="#general-advice">
  260. General Advice
  261. </a></li>
  262. <li><a href="#always-recompiles">
  263. Why does Ant always recompile all my Java files?
  264. </a></li>
  265. <li><a href="#defaultexcludes">
  266. I've used a <code>&lt;delete&gt;</code> task to
  267. delete unwanted SourceSafe control files (CVS files, editor
  268. backup files, etc.), but it doesn't seem to work; the files
  269. never get deleted. What's wrong?
  270. </a></li>
  271. <li><a href="#stop-dependency">
  272. I have a target I want to skip if a property is set,
  273. so I have <code>unless="property"</code> as an attribute
  274. of the target, but all the targets this target
  275. depends on are still executed. Why?
  276. </a></li>
  277. <li><a href="#include-order">
  278. In my <code>&lt;fileset&gt;</code>, I've put in an
  279. <code>&lt;exclude&gt;</code> of all files followed by an
  280. <code>&lt;include&gt;</code> of just the files I want, but it
  281. isn't giving me any files at all. What's wrong?
  282. </a></li>
  283. <li><a href="#properties-not-trimmed">
  284. <code>ant</code> failed to build my program via javac
  285. even when I put the needed jars in an external
  286. <code>build.properties</code> file and reference them by
  287. <code>pathelement</code> or <code>classpath refid</code>.
  288. </a></li>
  289. <li><a href="#winzip-lies">
  290. Ant creates WAR files with a lower-case
  291. <code>web-inf</code> or JAR files with a lower-case
  292. <code>meta-inf</code> directory.
  293. </a></li>
  294. <li><a href="#NoClassDefFoundError">
  295. I installed Ant 1.6.x and now get
  296. <code>Exception in thread "main" java.lang.NoClassDefFoundError:
  297. </code>
  298. </a></li>
  299. <li><a href="#InstantiationException">
  300. I installed Ant 1.6.x and now get
  301. <code>java.lang.InstantiationException: org.apache.tools.ant.Main</code>
  302. </a></li>
  303. <li><a href="#mangled-manifest">
  304. Whenever I use the Ant jar or manifest related tasks, long lines in
  305. my manifest are wrapped at 70 characters and the resulting jar does
  306. not work in my application server. Why does Ant do this?
  307. </a></li>
  308. </ul>
  309. <h4 class="toc">Ant and IDEs/Editors</h4>
  310. <ul>
  311. <li><a href="#integration">
  312. Is Ant supported by my IDE/Editor?
  313. </a></li>
  314. <li><a href="#emacs-mode">
  315. Why doesn't (X)Emacs/vi/MacOS X's project builder
  316. correctly parse the error messages generated by Ant?
  317. </a></li>
  318. </ul>
  319. <h4 class="toc">Advanced Issues</h4>
  320. <ul>
  321. <li><a href="#dtd">
  322. Is there a DTD that I can use to validate my build
  323. files?
  324. </a></li>
  325. <li><a href="#xml-entity-include">
  326. How do I include an XML snippet in my build file?
  327. </a></li>
  328. <li><a href="#mail-logger">
  329. How do I send an email with the result of my build
  330. process?
  331. </a></li>
  332. <li><a href="#listener-properties">
  333. How do I get at the properties that Ant was running
  334. with from inside BuildListener?
  335. </a></li>
  336. </ul>
  337. <h4 class="toc">Known Problems</h4>
  338. <ul>
  339. <li><a href="#170-requires-junit">
  340. Ant 1.7.0 doesn't build from sources without
  341. JUnit
  342. </a></li>
  343. <li><a href="#remove-cr">
  344. &lt;chmod&gt; or &lt;exec&gt; doesn't work in Ant
  345. 1.3 on Unix
  346. </a></li>
  347. <li><a href="#javadoc-cannot-execute">
  348. JavaDoc failed: java.io.IOException: javadoc: cannot execute
  349. </a></li>
  350. <li><a href="#delegating-classloader">
  351. &lt;style&gt; or &lt;junit&gt; ignores my
  352. &lt;classpath&gt;
  353. </a></li>
  354. <li><a href="#delegating-classloader-1.5">
  355. &lt;style&gt; or &lt;junit&gt; ignores my
  356. &lt;classpath&gt; - Ant 1.5.x version
  357. </a></li>
  358. <li><a href="#delegating-classloader-1.6">
  359. &lt;style&gt; or &lt;junit&gt; ignores my
  360. &lt;classpath&gt; - Ant 1.6.x version
  361. </a></li>
  362. <li><a href="#winxp-jdk14-ant14">
  363. When running Ant 1.4 on Windows XP and JDK 1.4, I get
  364. various errors when trying to <code>&lt;exec&gt;</code>, fork
  365. <code>&lt;java&gt;</code> or access environment
  366. variables.
  367. </a></li>
  368. <li><a href="#1.5-cygwin-sh">
  369. The <code>ant</code> wrapper script of Ant 1.5 fails
  370. for Cygwin if <code>ANT_HOME</code> is set to a Windows style
  371. path.
  372. </a></li>
  373. <li><a href="#1.5.2-zip-broken">
  374. <code>&lt;zip&gt;</code> is broken in Ant 1.5.2.
  375. </a></li>
  376. <li><a href="#unknownelement.taskcontainer">
  377. Why do my custom task containers see Unknown Elements in Ant 1.6
  378. - they worked in Ant 1.5?
  379. </a></li>
  380. <li><a href="#java.exception.stacktrace">
  381. The program I run via &lt;java&gt; throws an exception but I
  382. can't seem to get the full stack trace.
  383. </a></li>
  384. <li><a href="#junit-no-runtime-xml">
  385. Using format="xml", &lt;junit&gt; fails with a
  386. <code>NoClassDefFoundError</code> if forked.
  387. </a></li>
  388. <li><a href="#xalan-jdk1.5">
  389. <code>&lt;junitreport&gt;</code> doesn't work with JDK 1.5 but
  390. worked fine with JDK 1.4.
  391. </a></li>
  392. </ul>
  393. <h3 class="section">Answers</h3>
  394. <p class="faq">
  395. <a name="latest-version"></a>
  396. Where do I find the latest version of this
  397. document?
  398. </p>
  399. <p>The latest version can always be found at Ant's homepage
  400. <a href="http://ant.apache.org/faq.html">http://ant.apache.org/faq.html</a>.</p>
  401. <p class="faq">
  402. <a name="adding-faqs"></a>
  403. How can I contribute to this FAQ?
  404. </p>
  405. <p>The page you are looking it is generated from
  406. <a href="http://svn.apache.org/repos/asf/ant/core/trunk/xdocs/faq.xml">this</a>
  407. document. If you want to add a new question, please submit
  408. a patch against this document to one of Ant's mailing lists;
  409. hopefully, the structure is self-explanatory.</p>
  410. <p>If you don't know how to create a patch, see the patches
  411. section of <a href="http://jakarta.apache.org/site/source.html">this
  412. page</a>.</p>
  413. <p class="faq">
  414. <a name="creating-faq"></a>
  415. How do you create the HTML version of this
  416. FAQ?
  417. </p>
  418. <p>We use
  419. <a href="http://jakarta.apache.org/velocity/anakia.html">Anakia</a>
  420. to render the HTML version from the original XML file.</p>
  421. <p>The Velocity stylesheets used to process the XML files can
  422. be found in the <code>xdocs/stylesheets</code> subdirectory of
  423. Ant's SVN repository - the build file
  424. <code>docs.xml</code> at the top level of the ant SVN
  425. module (trunk) is used to drive Anakia.</p>
  426. <p>This file assumes that you have the
  427. <code>jakarta-site2</code> CVS module checked out as well, but
  428. if you follow the instruction from Anakia's homepage, you
  429. should get it to work without that. Just make sure all
  430. required jars are in the task's classpath.</p>
  431. <p class="faq">
  432. <a name="what-is-ant"></a>
  433. What is Apache Ant?
  434. </p>
  435. <p> Ant is a Java-based build tool. In theory, it is kind of
  436. like Make, without Make's wrinkles and with the full
  437. portability of pure Java code.</p>
  438. <p class="faq">
  439. <a name="ant-name"></a>
  440. Why do you call it Ant?
  441. </p>
  442. <p>According to Ant's original author, James Duncan
  443. Davidson, the name is an acronym for "Another Neat
  444. Tool".</p>
  445. <p>Later explanations go along the lines of "ants
  446. do an extremely good job at building things", or
  447. "ants are very small and can carry a weight dozens of times
  448. their own" - describing what Ant is intended to
  449. be.</p>
  450. <p class="faq">
  451. <a name="history"></a>
  452. Tell us a little bit about Ant's history.
  453. </p>
  454. <p>Initially, Ant was part of the Tomcat code base, when it was
  455. donated to the Apache Software Foundation. It was
  456. created by James Duncan Davidson, who is also the original
  457. author of Tomcat. Ant was there to build Tomcat, nothing
  458. else.</p>
  459. <p>Soon thereafter, several open source Java projects realized
  460. that Ant could solve the problems they had with Makefiles.
  461. Starting with the projects hosted at Jakarta and the old Java
  462. Apache project, Ant spread like a virus and is now the build
  463. tool of choice for a lot of projects.</p>
  464. <p>In January 2000, Ant was moved to a separate CVS module and
  465. was promoted to a project of its own, independent of
  466. Tomcat, and became Apache Ant.</p>
  467. <p>The first version of Ant that was exposed to a larger audience
  468. was the one that shipped with Tomcat's 3.1 release on 19 April
  469. 2000. This version has later been referred to as Ant
  470. 0.3.1.</p>
  471. <p>The first official release of Ant as a stand-alone product was
  472. Ant 1.1, released on 19 July 2000. The complete release
  473. history:</p>
  474. <table class="ForrestTable" cellspacing="1" cellpadding="4">
  475. <tr>
  476. <th colspan="1" rowspan="1"
  477. valign="top" align="left">
  478. Ant Version
  479. </th>
  480. <th colspan="1" rowspan="1"
  481. valign="top" align="left">
  482. Release Date
  483. </th>
  484. </tr>
  485. <tr>
  486. <td colspan="1" rowspan="1"
  487. valign="top" align="left">
  488. 1.1
  489. </td>
  490. <td colspan="1" rowspan="1"
  491. valign="top" align="left">
  492. 19 July 2000
  493. </td>
  494. </tr>
  495. <tr>
  496. <td colspan="1" rowspan="1"
  497. valign="top" align="left">
  498. 1.2
  499. </td>
  500. <td colspan="1" rowspan="1"
  501. valign="top" align="left">
  502. 24 October 2000
  503. </td>
  504. </tr>
  505. <tr>
  506. <td colspan="1" rowspan="1"
  507. valign="top" align="left">
  508. 1.3
  509. </td>
  510. <td colspan="1" rowspan="1"
  511. valign="top" align="left">
  512. 3 March 2001
  513. </td>
  514. </tr>
  515. <tr>
  516. <td colspan="1" rowspan="1"
  517. valign="top" align="left">
  518. 1.4
  519. </td>
  520. <td colspan="1" rowspan="1"
  521. valign="top" align="left">
  522. 3 September 2001
  523. </td>
  524. </tr>
  525. <tr>
  526. <td colspan="1" rowspan="1"
  527. valign="top" align="left">
  528. 1.4.1
  529. </td>
  530. <td colspan="1" rowspan="1"
  531. valign="top" align="left">
  532. 11 October 2001
  533. </td>
  534. </tr>
  535. <tr>
  536. <td colspan="1" rowspan="1"
  537. valign="top" align="left">
  538. 1.5
  539. </td>
  540. <td colspan="1" rowspan="1"
  541. valign="top" align="left">
  542. 10 July 2002
  543. </td>
  544. </tr>
  545. <tr>
  546. <td colspan="1" rowspan="1"
  547. valign="top" align="left">
  548. 1.5.1
  549. </td>
  550. <td colspan="1" rowspan="1"
  551. valign="top" align="left">
  552. 3 October 2002
  553. </td>
  554. </tr>
  555. <tr>
  556. <td colspan="1" rowspan="1"
  557. valign="top" align="left">
  558. 1.5.2
  559. </td>
  560. <td colspan="1" rowspan="1"
  561. valign="top" align="left">
  562. 3 March 2003
  563. </td>
  564. </tr>
  565. <tr>
  566. <td colspan="1" rowspan="1"
  567. valign="top" align="left">
  568. 1.5.3
  569. </td>
  570. <td colspan="1" rowspan="1"
  571. valign="top" align="left">
  572. 9 April 2003
  573. </td>
  574. </tr>
  575. <tr>
  576. <td colspan="1" rowspan="1"
  577. valign="top" align="left">
  578. 1.5.4
  579. </td>
  580. <td colspan="1" rowspan="1"
  581. valign="top" align="left">
  582. 12 August 2003
  583. </td>
  584. </tr>
  585. <tr>
  586. <td colspan="1" rowspan="1"
  587. valign="top" align="left">
  588. 1.6.0
  589. </td>
  590. <td colspan="1" rowspan="1"
  591. valign="top" align="left">
  592. 18 December 2003
  593. </td>
  594. </tr>
  595. <tr>
  596. <td colspan="1" rowspan="1"
  597. valign="top" align="left">
  598. 1.6.1
  599. </td>
  600. <td colspan="1" rowspan="1"
  601. valign="top" align="left">
  602. 12 February 2004
  603. </td>
  604. </tr>
  605. <tr>
  606. <td colspan="1" rowspan="1"
  607. valign="top" align="left">
  608. 1.6.2
  609. </td>
  610. <td colspan="1" rowspan="1"
  611. valign="top" align="left">
  612. 16 July 2004
  613. </td>
  614. </tr>
  615. <tr>
  616. <td colspan="1" rowspan="1"
  617. valign="top" align="left">
  618. 1.6.3
  619. </td>
  620. <td colspan="1" rowspan="1"
  621. valign="top" align="left">
  622. 28 April 2005
  623. </td>
  624. </tr>
  625. <tr>
  626. <td colspan="1" rowspan="1"
  627. valign="top" align="left">
  628. 1.6.4
  629. </td>
  630. <td colspan="1" rowspan="1"
  631. valign="top" align="left">
  632. 19 May 2005
  633. </td>
  634. </tr>
  635. <tr>
  636. <td colspan="1" rowspan="1"
  637. valign="top" align="left">
  638. 1.6.5
  639. </td>
  640. <td colspan="1" rowspan="1"
  641. valign="top" align="left">
  642. 2 June 2005
  643. </td>
  644. </tr>
  645. <tr>
  646. <td colspan="1" rowspan="1"
  647. valign="top" align="left">
  648. 1.7.0
  649. </td>
  650. <td colspan="1" rowspan="1"
  651. valign="top" align="left">
  652. 19 December 2006
  653. </td>
  654. </tr>
  655. </table>
  656. <p class="faq">
  657. <a name="no-gnu-tar"></a>
  658. I get checksum errors when I try to extract the
  659. <code>tar.gz</code> distribution file. Why?
  660. </p>
  661. <p>Ant's distribution contains file names that are longer
  662. than 100 characters, which is not supported by the standard
  663. tar file format. Several different implementations of tar use
  664. different and incompatible ways to work around this
  665. restriction.</p>
  666. <p>Ant's &lt;tar&gt; task can create tar archives that use
  667. the GNU tar extension, and this has been used when putting
  668. together the distribution. If you are using a different
  669. version of tar (for example, the one shipping with Solaris),
  670. you cannot use it to extract the archive.</p>
  671. <p>The solution is to either install GNU tar, which can be
  672. found <a href="http://www.gnu.org/software/tar/tar.html">here</a>,
  673. or use the zip archive instead (you can extract it using
  674. <code>jar xf</code>).</p>
  675. <p class="faq">
  676. <a name="RedHat_ES_3"></a>
  677. How do you get ant-1.6.x (or any version later than
  678. 1.5.2) to work on on RedHat ES 3?
  679. </p>
  680. <p>Redhat ES 3.0 comes installed with ant 1.5.2. Even if you
  681. have your PATH and ANT_HOME variables set correctly to a later
  682. version of ant, you will always be forced to use the
  683. preinstalled version.</p>
  684. <p>To use a later version of ant on this OS you could do the
  685. following:</p>
  686. <pre class="code">
  687. $ ant -version
  688. Apache Ant version 1.5.2-23 compiled on November 12 2003
  689. $ su -
  690. # rpm -e ant ant-libs
  691. # exit
  692. $ hash -r
  693. $ ant -version
  694. Apache Ant version 1.6.2 compiled on July 16 2004
  695. </pre>
  696. <p class="faq">
  697. <a name="implement-os-specific-configuration"></a>
  698. How do I realize os--specific configurations?
  699. </p>
  700. <p>The core idea is using property files which name accords to the
  701. os-name. Then simply use the build-in property <tt>os.name</tt>.</p>
  702. <p>For better use you should also provide a file with defaul values.
  703. But be careful with the correct os-names. For test simply &lt;echo&gt;
  704. the ${os.name} on all machines and you can be sure to use the right
  705. file names.</p>
  706. <pre class="code">
  707. &lt;property file=&quot;${os.name}.properties&quot;/&gt;
  708. &lt;property file=&quot;default.properties&quot;/&gt;
  709. </pre>
  710. <p class="faq">
  711. <a name="adding-external-tasks"></a>
  712. How do I add an external task that I've written to the
  713. page "External Tools and Tasks"?
  714. </p>
  715. <p>Join and post a message to the dev or user mailing
  716. list (one list is enough), including the following
  717. information:</p>
  718. <ul>
  719. <li>the name of the task/tool</li>
  720. <li>a short description of the task/tool</li>
  721. <li>a Compatibility: entry stating with which version(s) of
  722. Ant the tool/task is compatible to</li>
  723. <li>a URL: entry linking to the main page of the tool/task</li>
  724. <li>a Contact: entry containing the email address or the URL
  725. of a webpage for the person or list to contact for issues
  726. related to the tool/task. <strong>Note that we'll add a
  727. link on the page, so any email address added there is not
  728. obfuscated and can (and probably will) be abused by robots
  729. harvesting websites for addresses to spam.</strong></li>
  730. <li>a License: entry containing the type of license for the
  731. tool/task</li>
  732. </ul>
  733. <p>The preferred format for this information is a patch to <a href="http://svn.apache.org/repos/asf/ant/core/trunk/xdocs/external.xml">this</a>
  734. document.</p>
  735. <p>If you have written something bigger than a 'simple plugin' to Ant it
  736. may be better to add the link to <a href="projects.html">projects.html</a>.
  737. The procedure to add it is the same. The file to patch is <a href="http://svn.apache.org/repos/asf/ant/core/trunk/xdocs/projects.xml">this</a>
  738. document. The syntax of that file is the same.</p>
  739. <p class="faq">
  740. <a name="create-extensions"></a>
  741. How do I create new tasks?
  742. </p>
  743. <p>Apart from a lot of information on using Ant, the
  744. <a href="manual/index.html">Manual</a> also contains information
  745. on how to extend Ant with new tasks. This information
  746. can be found under "Developing with Ant".</p>
  747. <p>Chances are that someone else already created the task you
  748. want to create, it may be wise to see
  749. <a href="external.html">External Tools and Tasks</a> and
  750. <a href="projects.html">Related Projects</a> first.</p>
  751. <p class="faq">
  752. <a name="passing-cli-args"></a>
  753. How do I pass parameters from the command line to my
  754. build file?
  755. </p>
  756. <p>Use properties. Using <code>ant
  757. -D<em>name</em>=<em>value</em></code> lets you define values for
  758. properties on the Ant command line. These properties can then be
  759. used within your build file as
  760. any normal property: <code>${<em>name</em>}</code> will put in
  761. <code><em>value</em></code>.</p>
  762. <p class="faq">
  763. <a name="jikes-switches"></a>
  764. How can I use Jikes-specific command-line
  765. switches?
  766. </p>
  767. <p>A couple of switches are supported via "magic"
  768. properties:</p>
  769. <table class="ForrestTable" cellspacing="1" cellpadding="4">
  770. <tr>
  771. <th colspan="1" rowspan="1"
  772. valign="top" align="left">
  773. switch
  774. </th>
  775. <th colspan="1" rowspan="1"
  776. valign="top" align="left">
  777. property
  778. </th>
  779. <th colspan="1" rowspan="1"
  780. valign="top" align="left">
  781. default
  782. </th>
  783. </tr>
  784. <tr>
  785. <td colspan="1" rowspan="1"
  786. valign="top" align="left">
  787. +E
  788. </td>
  789. <td colspan="1" rowspan="1"
  790. valign="top" align="left">
  791. build.compiler.emacs
  792. </td>
  793. <td colspan="1" rowspan="1"
  794. valign="top" align="left">
  795. false == not set
  796. </td>
  797. </tr>
  798. <tr>
  799. <td colspan="1" rowspan="1"
  800. valign="top" align="left">
  801. +P
  802. </td>
  803. <td colspan="1" rowspan="1"
  804. valign="top" align="left">
  805. build.compiler.pedantic
  806. </td>
  807. <td colspan="1" rowspan="1"
  808. valign="top" align="left">
  809. false == not set
  810. </td>
  811. </tr>
  812. <tr>
  813. <td colspan="1" rowspan="1"
  814. valign="top" align="left">
  815. +F
  816. </td>
  817. <td colspan="1" rowspan="1"
  818. valign="top" align="left">
  819. build.compiler.fulldepend
  820. </td>
  821. <td colspan="1" rowspan="1"
  822. valign="top" align="left">
  823. false == not set
  824. </td>
  825. </tr>
  826. <tr>
  827. <td colspan="1" rowspan="1"
  828. valign="top" align="left">
  829. <strong>(Only for Ant &lt; 1.4; replaced by the
  830. <code><strong>nowarn</strong></code>
  831. attribute of the <code><strong>&lt;javac&gt;</strong></code>
  832. task after that.)</strong><br />-nowarn
  833. </td>
  834. <td colspan="1" rowspan="1"
  835. valign="top" align="left">
  836. build.compiler.warnings
  837. </td>
  838. <td colspan="1" rowspan="1"
  839. valign="top" align="left">
  840. true == not set
  841. </td>
  842. </tr>
  843. </table>
  844. <p>With Ant &gt;= 1.5, you can also use nested
  845. <code>&lt;compilerarg&gt;</code> elements with the
  846. <code>&lt;javac&gt;</code> task.</p>
  847. <p class="faq">
  848. <a name="shell-redirect-1"></a>
  849. How do I include a &lt; character in my command-line arguments?
  850. </p>
  851. <p>The short answer is "Use: <code>&amp;lt;</code>".</p>
  852. <p>The long answer is that this probably won't do what you
  853. want anyway (see <a href="#shell-redirect-2">the next
  854. section</a>).</p>
  855. <p class="faq">
  856. <a name="shell-redirect-2"></a>
  857. How do I redirect standard input or standard output
  858. in the <code>&lt;exec&gt;</code> task?
  859. </p>
  860. <p>Say you want to redirect the standard output stream of the
  861. <code>m4</code> command to write to a file, something
  862. like:</p>
  863. <pre class="code">
  864. shell-prompt&gt; m4 foo.m4 &gt; foo
  865. </pre>
  866. <p>and try to translate it into</p>
  867. <pre class="code">
  868. &lt;exec executable=&quot;m4&quot;&gt;
  869. &lt;arg value=&quot;foo.m4&quot;/&gt;
  870. &lt;arg value=&quot;&amp;gt;&quot;/&gt;
  871. &lt;arg value=&quot;foo&quot;/&gt;
  872. &lt;/exec&gt;
  873. </pre>
  874. <p>This will not do what you expect. The output redirection is
  875. performed by your shell, not the command itself, so this
  876. should read:</p>
  877. <pre class="code">
  878. &lt;exec executable=&quot;/bin/sh&quot;&gt;
  879. &lt;arg value=&quot;-c&quot; /&gt;
  880. &lt;arg value=&quot;m4 foo.m4 &amp;gt; foo&quot; /&gt;
  881. &lt;/exec&gt;
  882. </pre>
  883. <p>Note that you must use the <code>value</code> attribute of
  884. <code>&lt;arg&gt;</code> in the last element, in order to have
  885. the command passed as a single, quoted argument. Alternatively,
  886. you can use:</p>
  887. <pre class="code">
  888. &lt;exec executable=&quot;/bin/sh&quot;&gt;
  889. &lt;arg line='-c &quot;m4 foo.m4 &amp;gt; foo&quot;'/&gt;
  890. &lt;/exec&gt;
  891. </pre>
  892. <p>Note the double-quotes nested inside the single-quotes.</p>
  893. <p class="faq">
  894. <a name="batch-shell-execute"></a>
  895. How do I execute a batch file or shell script from Ant?
  896. </p>
  897. <p>On native Unix systems, you should be able to run shell scripts
  898. directly. On systems running a Unix-type shell (for example, Cygwin
  899. on Windows) execute the (command) shell instead - <code>cmd</code>
  900. for batch files, <code>sh</code> for shell scripts - then pass the
  901. batch file or shell script (plus any arguments to the script)
  902. as a single command, using the <code>/c</code> or
  903. <code>-c</code> switch, respectively. See
  904. <a href="#shell-redirect-2">the above section</a>
  905. for example <code>&lt;exec&gt;</code> tasks
  906. executing <code>sh</code>. For batch files, use something like:</p>
  907. <pre class="code">
  908. &lt;exec dir=&quot;.&quot; executable=&quot;cmd&quot; os=&quot;Windows NT&quot;&gt;
  909. &lt;arg line=&quot;/c test.bat&quot;/&gt;
  910. &lt;/exec&gt;
  911. </pre>
  912. <p class="faq">
  913. <a name="multi-conditions"></a>
  914. I want to execute a particular target only if
  915. multiple conditions are true.
  916. </p>
  917. <p>There are actually several answers to this question.</p>
  918. <p>If you have only one set and one unset property to test,
  919. you can specify both an <code>if</code> and an <code>unless</code>
  920. attribute for the target, and they will act as if they
  921. are "anded" together.</p>
  922. <p>If you are using a version of Ant 1.3 or earlier, the
  923. way to work with all other cases is to chain targets together
  924. to determine the specific state you want to test for.</p>
  925. <p>To see how this works, assume you have three properties:
  926. <code>prop1</code>, <code>prop2</code>, and <code>prop3</code>.
  927. You want to test that <code>prop1</code> and <code>prop2</code>
  928. are set, and that <code>prop3</code> is not. If the condition
  929. holds true you want to echo "yes".</p>
  930. <p>Here is the implementation in Ant 1.3 and earlier:</p>
  931. <pre class="code">
  932. &lt;target name=&quot;cond&quot; depends=&quot;cond-if&quot;/&gt;
  933. &lt;target name=&quot;cond-if&quot; if=&quot;prop1&quot;&gt;
  934. &lt;antcall target=&quot;cond-if-2&quot;/&gt;
  935. &lt;/target&gt;
  936. &lt;target name=&quot;cond-if-2&quot; if=&quot;prop2&quot;&gt;
  937. &lt;antcall target=&quot;cond-if-3&quot;/&gt;
  938. &lt;/target&gt;
  939. &lt;target name=&quot;cond-if-3&quot; unless=&quot;prop3&quot;&gt;
  940. &lt;echo message=&quot;yes&quot;/&gt;
  941. &lt;/target&gt;
  942. </pre>
  943. <p>Note: <code>&lt;antcall&gt;</code> tasks do <em>not</em> pass
  944. property changes back up to the environment they were called
  945. from, so you wouldn't be able to, for example, set a
  946. <code>result</code> property in the <code>cond-if-3</code> target,
  947. then do
  948. <code>&lt;echo message="result is ${result}"/&gt;</code>
  949. in the <code>cond</code> target.</p>
  950. <p>Starting with Ant 1.4, you can use the
  951. <code>&lt;condition&gt;</code> task.</p>
  952. <pre class="code">
  953. &lt;target name=&quot;cond&quot; depends=&quot;cond-if,cond-else&quot;/&gt;
  954. &lt;target name=&quot;check-cond&quot;&gt;
  955. &lt;condition property=&quot;cond-is-true&quot;&gt;
  956. &lt;and&gt;
  957. &lt;not&gt;
  958. &lt;equals arg1=&quot;${prop1}&quot; arg2=&quot;$${prop1}&quot; /&gt;
  959. &lt;/not&gt;
  960. &lt;not&gt;
  961. &lt;equals arg1=&quot;${prop2}&quot; arg2=&quot;$${prop2}&quot; /&gt;
  962. &lt;/not&gt;
  963. &lt;equals arg1=&quot;${prop3}&quot; arg2=&quot;$${prop3}&quot; /&gt;
  964. &lt;/and&gt;
  965. &lt;/condition&gt;
  966. &lt;/target&gt;
  967. &lt;target name=&quot;cond-if&quot; depends=&quot;check-cond&quot; if=&quot;cond-is-true&quot;&gt;
  968. &lt;echo message=&quot;yes&quot;/&gt;
  969. &lt;/target&gt;
  970. &lt;target name=&quot;cond-else&quot; depends=&quot;check-cond&quot; unless=&quot;cond-is-true&quot;&gt;
  971. &lt;echo message=&quot;no&quot;/&gt;
  972. &lt;/target&gt;
  973. </pre>
  974. <p>This version takes advantage of two things:</p>
  975. <ul>
  976. <li>If a property <code>a</code> has not been set,
  977. <code>${a}</code> will evaluate to <code>${a}</code>.</li>
  978. <li>To get a literal <code>$</code> in Ant, you have to
  979. escape it with another <code>$</code> - this will also break
  980. the special treatment of the <code>${</code> sequence.</li>
  981. </ul>
  982. <p>Because testing for a literal <code>${property}</code> string
  983. isn't all that readable or easy to understand,
  984. post-1.4.1 Ant introduces the <code>&lt;isset&gt;</code> element
  985. to the <code>&lt;condition&gt;</code> task.</p>
  986. <p>Here is the previous example done using
  987. <code>&lt;isset&gt;</code>:</p>
  988. <pre class="code">
  989. &lt;target name=&quot;check-cond&quot;&gt;
  990. &lt;condition property=&quot;cond-is-true&quot;&gt;
  991. &lt;and&gt;
  992. &lt;isset property=&quot;prop1&quot;/&gt;
  993. &lt;isset property=&quot;prop2&quot;/&gt;
  994. &lt;not&gt;
  995. &lt;isset property=&quot;prop3&quot;/&gt;
  996. &lt;/not&gt;
  997. &lt;/and&gt;
  998. &lt;/condition&gt;
  999. &lt;/target&gt;
  1000. </pre>
  1001. <p>The last option is to use a scripting language to set the
  1002. properties. This can be particularly handy when you need much
  1003. finer control than the simple conditions shown here but, of
  1004. course, comes with the overhead of adding JAR files to support
  1005. the language, to say nothing of the added maintenance in requiring
  1006. two languages to implement a single system. See the
  1007. <a href="manual/OptionalTasks/script.html">
  1008. <code>&lt;script&gt;</code> task documentation</a> for more
  1009. details.</p>
  1010. <p class="faq">
  1011. <a name="encoding"></a>
  1012. How can I include national characters like German
  1013. umlauts in my build file?
  1014. </p>
  1015. <p>You need to tell the XML parser which character encoding
  1016. your build file uses, this is done inside the <a href="http://www.w3.org/TR/2000/REC-xml-20001006#sec-prolog-dtd">XML
  1017. declaration</a>.</p>
  1018. <p>By default the parser assumes you are using the UTF-8
  1019. encoding instead of your platform's default. For most Western
  1020. European countries you should set the encoding to
  1021. <code>ISO-8859-1</code>. To do so, make the very first line
  1022. of you build file read like</p>
  1023. <pre class="code">
  1024. &lt;?xml version=&quot;1.0&quot; encoding=&quot;ISO-8859-1&quot; ?&gt;
  1025. </pre>
  1026. <p class="faq">
  1027. <a name="use-zip-instead-of-jar"></a>
  1028. How do I use <code>jar</code>'s <code>M</code> switch?
  1029. I don't want a MANIFEST.
  1030. </p>
  1031. <p>A JAR archive is a ZIP file, so if you don't want a
  1032. MANIFEST you can simply use <code>&lt;zip&gt;</code>.</p>
  1033. <p>If your file names contain national characters you should
  1034. know that Sun's <code>jar</code> utility like Ant's
  1035. <code>&lt;jar&gt;</code> uses UTF-8 to encode their names while
  1036. <code>&lt;zip&gt;</code> uses your platforms default encoding.
  1037. Use the encoding attribute of <code>&lt;zip&gt;</code> if
  1038. necessary.</p>
  1039. <p class="faq">
  1040. <a name="propertyvalue-as-name-for-property"></a>
  1041. How can I do something like <code>&lt;property name="prop"
  1042. value="${${anotherprop}}"/&gt;</code> (double expanding the property)?
  1043. </p>
  1044. <p>Without any external help you can not.</p>
  1045. <p>With &lt;script/&gt;, which needs external libraries, you can do</p>
  1046. <pre class="code">
  1047. &lt;script language=&quot;javascript&quot;&gt;
  1048. propname = project.getProperty(&quot;anotherprop&quot;);
  1049. project.setNewProperty(&quot;prop&quot;, propname);
  1050. &lt;/script&gt;
  1051. </pre>
  1052. <p>With AntContrib (external task library) you can do <code>
  1053. &lt;propertycopy name="prop" from="${anotherprop}"/&gt;</code>.</p>
  1054. <p>With Ant 1.6 you can simulate the AntContribs &lt;propertycopy&gt;
  1055. and avoid the need of an external library:</p>
  1056. <pre class="code">
  1057. &lt;macrodef name=&quot;propertycopy&quot;&gt;
  1058. &lt;attribute name=&quot;name&quot;/&gt;
  1059. &lt;attribute name=&quot;from&quot;/&gt;
  1060. &lt;sequential&gt;
  1061. &lt;property name=&quot;@{name}&quot; value=&quot;${@{from}}&quot;/&gt;
  1062. &lt;/sequential&gt;
  1063. &lt;/macrodef&gt;
  1064. </pre>
  1065. <p class="faq">
  1066. <a name="delete-directory-children-only"></a>
  1067. How can I delete everything beneath a particular directory,
  1068. preserving the directory itself?
  1069. </p>
  1070. <p>Most users who go down this path have no problem figuring out that
  1071. <code>&lt;delete includeemptydirs="true" /&gt;</code> will help them. The
  1072. seemingly tricky part is preserving the base directory itself,
  1073. which Ant includes in the directory scan. Fortunately the answer is simple:
  1074. </p>
  1075. <pre class="code">
  1076. &lt;delete includeemptydirs=&quot;true&quot;&gt;
  1077. &lt;fileset dir=&quot;dirtokeep&quot; includes=&quot;**/*&quot; /&gt;
  1078. &lt;/delete&gt;
  1079. </pre>
  1080. <p class="faq">
  1081. <a name="general-advice"></a>
  1082. General Advice
  1083. </p>
  1084. <p>There are many reasons why Ant doesn't behave as
  1085. expected, not all of them are due to Ant bugs. See our <a href="problems.html">Having Problems?</a> page for hints that
  1086. may help pinning down the reasons for your problem.</p>
  1087. <p class="faq">
  1088. <a name="always-recompiles"></a>
  1089. Why does Ant always recompile all my Java files?
  1090. </p>
  1091. <p>In order to find out which files should be compiled, Ant
  1092. compares the timestamps of the source files to those of the
  1093. resulting <code>.class</code> files. Opening all source files
  1094. to find out which package they belong to would be very
  1095. inefficient. Instead, Ant expects you to place your
  1096. source files in a directory hierarchy that mirrors your
  1097. package hierarchy and to point Ant to the root of this
  1098. directory tree with the <code>srcdir</code> attribute.</p>
  1099. <p>Say you have <code>&lt;javac srcdir="src"
  1100. destdir="dest"/&gt;</code>. If Ant finds a file
  1101. <code>src/a/b/C.java</code>, it expects it to be in package
  1102. <code>a.b</code> so that the resulting <code>.class</code>
  1103. file is going to be <code>dest/a/b/C.class</code>.</p>
  1104. <p>If your source-tree directory structure does not match your
  1105. package structure, Ant's heuristic won't work, and
  1106. it will recompile classes that are up-to-date. Ant is not the
  1107. only tool that expects a source-tree layout like this.</p>
  1108. <p>If you have Java source files that aren't declared to
  1109. be part of any package, you can still use the <code>&lt;javac&gt;</code>
  1110. task to compile these files correctly - just set the
  1111. <code>srcdir</code> and <code>destdir</code> attributes to
  1112. the actual directory the source
  1113. files live in and the directory the class files should go into,
  1114. respectively.</p>
  1115. <p class="faq">
  1116. <a name="defaultexcludes"></a>
  1117. I've used a <code>&lt;delete&gt;</code> task to
  1118. delete unwanted SourceSafe control files (CVS files, editor
  1119. backup files, etc.), but it doesn't seem to work; the files
  1120. never get deleted. What's wrong?
  1121. </p>
  1122. <p>This is probably happening because, by default, Ant excludes
  1123. SourceSafe control files (<code>vssver.scc</code>) and certain other
  1124. files from FileSets.</p>
  1125. <p>Here's what you probably did:</p>
  1126. <pre class="code">
  1127. &lt;delete&gt;
  1128. &lt;fileset dir=&quot;${build.src}&quot; includes=&quot;**/vssver.scc&quot;/&gt;
  1129. &lt;/delete&gt;
  1130. </pre>
  1131. <p>You need to switch off the default exclusions,
  1132. and it will work:</p>
  1133. <pre class="code">
  1134. &lt;delete&gt;
  1135. &lt;fileset dir=&quot;${build.src}&quot; includes=&quot;**/vssver.scc&quot;
  1136. defaultexcludes=&quot;no&quot;/&gt;
  1137. &lt;/delete&gt;
  1138. </pre>
  1139. <p>For a complete listing of the patterns that are excluded
  1140. by default, see <a href="manual/dirtasks.html#defaultexcludes">the user
  1141. manual</a>.</p>
  1142. <p class="faq">
  1143. <a name="stop-dependency"></a>
  1144. I have a target I want to skip if a property is set,
  1145. so I have <code>unless="property"</code> as an attribute
  1146. of the target, but all the targets this target
  1147. depends on are still executed. Why?
  1148. </p>
  1149. <p>The list of dependencies is generated by Ant before any of the
  1150. targets are run. This allows dependent targets, such as an
  1151. <code>init</code> target, to set properties that can control the
  1152. execution of the targets higher in the dependency graph. This
  1153. is a good thing.</p>
  1154. <p>However, when your dependencies break down the
  1155. higher-level task
  1156. into several smaller steps, this behaviour becomes
  1157. counter-intuitive. There are a couple of solutions available:
  1158. </p>
  1159. <ol>
  1160. <li>Put the same condition on each of the dependent targets.</li>
  1161. <li>Execute the steps using <code>&lt;antcall&gt;</code>,
  1162. instead of specifying them inside the <code>depends</code>
  1163. attribute.</li>
  1164. </ol>
  1165. <p class="faq">
  1166. <a name="include-order"></a>
  1167. In my <code>&lt;fileset&gt;</code>, I've put in an
  1168. <code>&lt;exclude&gt;</code> of all files followed by an
  1169. <code>&lt;include&gt;</code> of just the files I want, but it
  1170. isn't giving me any files at all. What's wrong?
  1171. </p>
  1172. <p>The order of the <code>&lt;include&gt;</code> and
  1173. <code>&lt;exclude&gt;</code> tags within a <code>&lt;fileset&gt;</code>
  1174. is ignored when the FileSet is created. Instead, all of the
  1175. <code>&lt;include&gt;</code> elements are processed together,
  1176. followed by all of the <code>&lt;exclude&gt;</code>
  1177. elements. This means that the <code>&lt;exclude&gt;</code>
  1178. elements only apply to the file list produced by the
  1179. <code>&lt;include&gt;</code> elements.</p>
  1180. <p>To get the files you want, focus on just the
  1181. <code>&lt;include&gt;</code> patterns that would be necessary
  1182. to get them. If you find you need to trim the list that the
  1183. <code>&lt;include&gt;</code> elements produce, then use
  1184. <code>&lt;exclude&gt;</code> elements.</p>
  1185. <p class="faq">
  1186. <a name="properties-not-trimmed"></a>
  1187. <code>ant</code> failed to build my program via javac
  1188. even when I put the needed jars in an external
  1189. <code>build.properties</code> file and reference them by
  1190. <code>pathelement</code> or <code>classpath refid</code>.
  1191. </p>
  1192. <p>When <code>ant</code> loads properties from an external
  1193. file it doesn't touch the value of properties, trailing blanks
  1194. will not be trimmed for example.</p>
  1195. <p>If the value represents a file path, like a jar needed to
  1196. compile, the task which requires the value, javac for example
  1197. would fail to compile since it can't find the file due to
  1198. trailing spaces.</p>
  1199. <p class="faq">
  1200. <a name="winzip-lies"></a>
  1201. Ant creates WAR files with a lower-case
  1202. <code>web-inf</code> or JAR files with a lower-case
  1203. <code>meta-inf</code> directory.
  1204. </p>
  1205. <p>No it doesn't.</p>
  1206. <p>You may have seen these lower-case directory names in
  1207. WinZIP, but WinZIP is trying to be helpful (and fails). If
  1208. WinZIP encounters a filename that is all upper-case, it
  1209. assumes it has come from an old DOS box and changes the case to
  1210. all lower-case for you.</p>
  1211. <p>If you extract (or just check) the archive with jar, you
  1212. will see that the names have the correct case.</p>
  1213. <p>With WinZIP (version 8.1 at least), this can be corrected in the
  1214. configuration. In the Options/Configuration menu, in the View tab, General
  1215. section, check the "Allow all upper case files names" box. The META-INF and
  1216. WEB-INF will look correct.</p>
  1217. <p class="faq">
  1218. <a name="NoClassDefFoundError"></a>
  1219. I installed Ant 1.6.x and now get
  1220. <code>Exception in thread "main" java.lang.NoClassDefFoundError:
  1221. </code>
  1222. </p>
  1223. <p>
  1224. The cause of this is that there is an old version of ant somewhere in the
  1225. class path or configuration.
  1226. </p>
  1227. <p>
  1228. A version of this problem happens with jars that are in the classpath
  1229. that include an embedded copy of ant classes.
  1230. An example of this is some copies of weblogic.jar.
  1231. </p>
  1232. <p>
  1233. One can check if this is the case by doing (on unix/sh):
  1234. <code><pre>
  1235. unset CLASSPATH
  1236. ant -version
  1237. </pre>
  1238. </code>
  1239. </p>
  1240. <p class="faq">
  1241. <a name="InstantiationException"></a>
  1242. I installed Ant 1.6.x and now get
  1243. <code>java.lang.InstantiationException: org.apache.tools.ant.Main</code>
  1244. </p>
  1245. <p>
  1246. The cause of this is that there is an old version of ant somewhere in the
  1247. class path or configuration.
  1248. </p>
  1249. <p>
  1250. A version of this problem may be seen on some linux systems.
  1251. Some linux systems (Fedora Core 2 for example), comes with a version
  1252. of ant pre-installed. There is a configuration file called
  1253. <code>/etc/ant.conf</code> which if present, the ant shell
  1254. script will 'dot' include. On Fedora Core 2, the /etc/ant.conf
  1255. file resets the <code>ANT_HOME</code> environment variable to
  1256. <code>/usr/share/ant</code>. This causes the problem that
  1257. an old version of ant (1.5.x in this cause) will be used
  1258. with a new version of the ant script file.
  1259. </p>
  1260. <p>
  1261. One can check if this is the case by doing
  1262. <code>ant --noconfig -version</code>.
  1263. </p>
  1264. <p class="faq">
  1265. <a name="mangled-manifest"></a>
  1266. Whenever I use the Ant jar or manifest related tasks, long lines in
  1267. my manifest are wrapped at 70 characters and the resulting jar does
  1268. not work in my application server. Why does Ant do this?
  1269. </p>
  1270. <p>
  1271. Ant implements the Java
  1272. <a href="http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html">Jar
  1273. file specification</a>. Please refer to the notes section where it
  1274. discusses the maximum allowable length of a line and the concept of
  1275. continuation characters.
  1276. </p>
  1277. <p>
  1278. If a jar file produced by Ant does not work in your appserver, and
  1279. that failure is due to the wrapped manifest, then you need
  1280. to consult your appserver provider, as it is a bug in their
  1281. appserver. Far more likely, however, is a problem in your
  1282. specification of your classpath. It is not Ant's wrapping of your
  1283. classpath that is the problem.
  1284. </p>
  1285. <p>
  1286. Do not raise a bug about this issue until you have checked to ensure
  1287. that the problem is not due to your classpath specification.
  1288. </p>
  1289. <p class="faq">
  1290. <a name="integration"></a>
  1291. Is Ant supported by my IDE/Editor?
  1292. </p>
  1293. <p>See the <a href="external.html#IDE and Editor Integration">section
  1294. on IDE integration</a> on our External Tools and Tasks page.</p>
  1295. <p class="faq">
  1296. <a name="emacs-mode"></a>
  1297. Why doesn't (X)Emacs/vi/MacOS X's project builder
  1298. correctly parse the error messages generated by Ant?
  1299. </p>
  1300. <p>Ant adds a "banner" with the name of the current
  1301. task in front of all logging messages - and there are no built-in
  1302. regular expressions in your editor that would account for
  1303. this.</p>
  1304. <p>You can disable this banner by invoking Ant with the
  1305. <code>-emacs</code> switch. To make Ant autodetect
  1306. Emacs' compile mode, put this into your
  1307. <code>.antrc</code> (contributed by Ville Skytt�).</p>
  1308. <pre class="code">
  1309. # Detect (X)Emacs compile mode
  1310. if [ &quot;$EMACS&quot; = &quot;t&quot; ] ; then
  1311. ANT_ARGS=&quot;$ANT_ARGS -emacs&quot;
  1312. ANT_OPTS=&quot;$ANT_OPTS -Dbuild.compiler.emacs=true&quot;
  1313. fi
  1314. </pre>
  1315. <p>Alternatively, you can add the following snippet to your
  1316. <code>.emacs</code> to make Emacs understand Ant's
  1317. output.</p>
  1318. <pre class="code">
  1319. (require 'compile)
  1320. (setq compilation-error-regexp-alist
  1321. (append (list
  1322. ;; works for jikes
  1323. '(&quot;^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):\\([0-9]+\\):[0-9]+:[0-9]+:&quot; 1 2 3)
  1324. ;; works for javac
  1325. '(&quot;^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):&quot; 1 2))
  1326. compilation-error-regexp-alist))
  1327. </pre>
  1328. <p>Yet another alternative that preserves most of Ant's
  1329. formatting is to pipe Ant's output through the following Perl
  1330. script by Dirk-Willem van Gulik:</p>
  1331. <pre class="code">
  1332. #!/usr/bin/perl
  1333. #
  1334. # May 2001 dirkx@apache.org - remove any
  1335. # [foo] lines from the output; keeping
  1336. # spacing more or less there.
  1337. #
  1338. $|=1;
  1339. while(&lt;STDIN&gt;) {
  1340. if (s/^(\s+)\[(\w+)\]//) {
  1341. if ($2 ne $last) {
  1342. print &quot;$1\[$2\]&quot;;
  1343. $s = ' ' x length($2);
  1344. } else {
  1345. print &quot;$1 $s &quot;;
  1346. };
  1347. $last = $2;
  1348. };
  1349. print;
  1350. };
  1351. </pre>
  1352. <p class="faq">
  1353. <a name="dtd"></a>
  1354. Is there a DTD that I can use to validate my build
  1355. files?
  1356. </p>
  1357. <p>An incomplete DTD can be created by the
  1358. <code>&lt;antstructure&gt;</code> task - but this one
  1359. has a few problems:</p>
  1360. <ul>
  1361. <li>It doesn't know about required attributes. Only
  1362. manual tweaking of this file can help here.</li>
  1363. <li>It is not complete - if you add new tasks via
  1364. <code>&lt;taskdef&gt;</code> it won't know about it. See
  1365. <a href="http://www.sdv.fr/pages/casa/html/ant-dtd.en.html">this
  1366. page</a> by Michel Casabianca for a solution to this
  1367. problem. Note that the DTD you can download at this page
  1368. is based on Ant 0.3.1.</li>
  1369. <li>It may even be an invalid DTD. As Ant allows tasks
  1370. writers to define arbitrary elements, name collisions will
  1371. happen quite frequently - if your version of Ant contains
  1372. the optional <code>&lt;test&gt;</code> and
  1373. <code>&lt;junit&gt;</code> tasks, there are two XML
  1374. elements named <code>test</code> (the task and the nested child
  1375. element of <code>&lt;junit&gt;</code>) with different attribute
  1376. lists. This problem cannot be solved; DTDs don't give a
  1377. syntax rich enough to support this.</li>
  1378. </ul>
  1379. <p class="faq">
  1380. <a name="xml-entity-include"></a>
  1381. How do I include an XML snippet in my build file?
  1382. </p>
  1383. <p>You can use XML's way of including external files and let
  1384. the parser do the job for Ant:</p>
  1385. <pre class="code">
  1386. &lt;?xml version=&quot;1.0&quot;?&gt;
  1387. &lt;!DOCTYPE project [
  1388. &lt;!ENTITY common SYSTEM &quot;common.xml&quot;&gt;
  1389. ]&gt;
  1390. &lt;project name=&quot;test&quot; default=&quot;test&quot; basedir=&quot;.&quot;&gt;
  1391. &lt;target name=&quot;setup&quot;&gt;
  1392. ...
  1393. &lt;/target&gt;
  1394. &amp;common;
  1395. ...
  1396. &lt;/project&gt;
  1397. </pre>
  1398. <p>will literally include the contents of <code>common.xml</code> where
  1399. you've placed the <code>&amp;common;</code> entity.</p>
  1400. <p>(The filename <code>common.xml</code> in this example is resolved
  1401. relative to the containing XML file by the XML parser. You may also use
  1402. an absolute <code>file:</code> protocol URI.)</p>
  1403. <p>In combination with a DTD, this would look like this:</p>
  1404. <pre class="code">
  1405. &lt;!DOCTYPE project PUBLIC &quot;-//ANT//DTD project//EN&quot; &quot;ant.dtd&quot; [
  1406. &lt;!ENTITY include SYSTEM &quot;header.xml&quot;&gt;
  1407. ]&gt;
  1408. </pre>
  1409. <p>Starting with Ant 1.6, there is a new
  1410. <code>&lt;import&gt;</code> task that can (also) be used to
  1411. include build file fragments. Unlike the snippets used with
  1412. entity includes, the referenced files have to be complete Ant
  1413. build files, though.</p>
  1414. <p>The example above would become:</p>
  1415. <pre class="code">
  1416. &lt;?xml version=&quot;1.0&quot;?&gt;
  1417. &lt;project name=&quot;test&quot; default=&quot;test&quot; basedir=&quot;.&quot;&gt;
  1418. &lt;target name=&quot;setup&quot;&gt;
  1419. ...
  1420. &lt;/target&gt;
  1421. &lt;import file=&quot;./common.xml&quot;/&gt;
  1422. ...
  1423. &lt;/project&gt;
  1424. </pre>
  1425. <p>Unlike entity includes, <code>&lt;import&gt;</code> will
  1426. let you use Ant properties in the file name.</p>
  1427. <p class="faq">
  1428. <a name="mail-logger"></a>
  1429. How do I send an email with the result of my build
  1430. process?
  1431. </p>
  1432. <p>If you are using a nightly build of Ant 1.5 after
  1433. 2001-12-14, you can use the built-in MailLogger:</p>
  1434. <pre class="code">
  1435. ant -logger org.apache.tools.ant.listener.MailLogger
  1436. </pre>
  1437. <p>See the <a href="http://svn.apache.org/repos/asf/ant/core/trunk/docs/manual/listeners.html">Listeners
  1438. &amp; Loggers</a> documentation for details on the properties
  1439. required.</p>
  1440. <p>For older versions of Ant, you can use a custom
  1441. BuildListener that sends out an email
  1442. in the buildFinished() method. Will Glozer
  1443. &lt;will.glozer@jda.com&gt; has written such a listener based
  1444. on <a href="http://java.sun.com/products/javamail/">JavaMail</a>.
  1445. The source is:</p>
  1446. <pre class="code">
  1447. import java.io.*;
  1448. import java.util.*;
  1449. import javax.mail.*;
  1450. import javax.mail.internet.*;
  1451. import org.apache.tools.ant.*;
  1452. /**
  1453. * A simple listener that waits for a build to finish and sends an email
  1454. * of the results. The settings are stored in &quot;monitor.properties&quot; and
  1455. * are fairly self explanatory.
  1456. *
  1457. * @author Will Glozer
  1458. * @version 1.05a 09/06/2000
  1459. */
  1460. public class BuildMonitor implements BuildListener {
  1461. protected Properties props;
  1462. /**
  1463. * Create a new BuildMonitor.
  1464. */
  1465. public BuildMonitor() throws Exception {
  1466. props = new Properties();
  1467. InputStream is = getClass().getResourceAsStream(&quot;monitor.properties&quot;);
  1468. props.load(is);
  1469. is.close();
  1470. }
  1471. public void buildStarted(BuildEvent e) {
  1472. }
  1473. /**
  1474. * Determine the status of the build and the actions to follow, now that
  1475. * the build has completed.
  1476. *
  1477. * @param e Event describing the build status.
  1478. */
  1479. public void buildFinished(BuildEvent e) {
  1480. Throwable th = e.getException();
  1481. String status = (th != null) ? &quot;failed&quot; : &quot;succeeded&quot;;
  1482. try {
  1483. String key = &quot;build.&quot; + status;
  1484. if (props.getProperty(key + &quot;.notify&quot;).equalsIgnoreCase(&quot;false&quot;)) {
  1485. return;
  1486. }
  1487. Session session = Session.getDefaultInstance(props, null);
  1488. MimeMessage message = new MimeMessage(session);
  1489. message.addRecipients(Message.RecipientType.TO, parseAddresses(
  1490. props.getProperty(key + &quot;.email.to&quot;)));
  1491. message.setSubject(props.getProperty(key + &quot;.email.subject&quot;));
  1492. BufferedReader br = new BufferedReader(new FileReader(
  1493. props.getProperty(&quot;build.log&quot;)));
  1494. StringWriter sw = new StringWriter();
  1495. String line = br.readLine();
  1496. while (line != null) {
  1497. sw.write(line);
  1498. sw.write(&quot;\n&quot;);
  1499. line = br.readLine();
  1500. }
  1501. br.close();
  1502. message.setText(sw.toString(), &quot;UTF-8&quot;);
  1503. sw.close();
  1504. Transport transport = session.getTransport();
  1505. transport.connect();
  1506. transport.send(message);
  1507. transport.close();
  1508. } catch (Exception ex) {
  1509. System.out.println(&quot;BuildMonitor failed to send email!&quot;);
  1510. ex.printStackTrace();
  1511. }
  1512. }
  1513. /**
  1514. * Parse a comma separated list of internet email addresses.
  1515. *
  1516. * @param s The list of addresses.
  1517. * @return Array of Addresses.
  1518. */
  1519. protected Address[] parseAddresses(String s) throws Exception {
  1520. StringTokenizer st = new StringTokenizer(s, &quot;,&quot;);
  1521. Address[] addrs = new Address[st.countTokens()];
  1522. for (int i = 0; i &lt; addrs.length; i++) {
  1523. addrs[i] = new InternetAddress(st.nextToken());
  1524. }
  1525. return addrs;
  1526. }
  1527. public void messageLogged(BuildEvent e) {
  1528. }
  1529. public void targetStarted(BuildEvent e) {
  1530. }
  1531. public void targetFinished(BuildEvent e) {
  1532. }
  1533. public void taskStarted(BuildEvent e) {
  1534. }
  1535. public void taskFinished(BuildEvent e) {
  1536. }
  1537. }
  1538. </pre>
  1539. <p>With a <code>monitor.properties</code> like this:</p>
  1540. <pre class="code">
  1541. # configuration for build monitor
  1542. mail.transport.protocol=smtp
  1543. mail.smtp.host=&lt;host&gt;
  1544. mail.from=Will Glozer &lt;will.glozer@jda.com&gt;
  1545. build.log=build.log
  1546. build.failed.notify=true
  1547. build.failed.email.to=will.glozer@jda.com
  1548. build.failed.email.subject=Nightly build failed!
  1549. build.succeeded.notify=true
  1550. build.succeeded.email.to=will.glozer@jda.com
  1551. build.succeeded.email.subject=Nightly build succeeded!
  1552. </pre>
  1553. <p><code>monitor.properties</code> should be placed right next
  1554. to your compiled <code>BuildMonitor.class</code>. To use it,
  1555. invoke Ant like:</p>
  1556. <pre class="code">
  1557. ant -listener BuildMonitor -logfile build.log
  1558. </pre>
  1559. <p>Make sure that <code>mail.jar</code> from JavaMail and
  1560. <code>activation.jar</code> from the
  1561. <a href="http://java.sun.com/products/javabeans/glasgow/jaf.html">Java
  1562. Beans Activation Framework</a> are in your <code>CLASSPATH</code>.</p>
  1563. <p class="faq">
  1564. <a name="listener-properties"></a>
  1565. How do I get at the properties that Ant was running
  1566. with from inside BuildListener?
  1567. </p>
  1568. <p>You can get at a hashtable with all the properties that Ant
  1569. has been using through the BuildEvent parameter. For
  1570. example:</p>
  1571. <pre class="code">
  1572. public void buildFinished(BuildEvent e) {
  1573. Hashtable table = e.getProject().getProperties();
  1574. String buildpath = (String)table.get(&quot;build.path&quot;);
  1575. ...
  1576. }
  1577. </pre>
  1578. <p>This is more accurate than just reading the same property
  1579. files that your project does, since it will give the correct
  1580. results for properties that were specified on the Ant command line.</p>
  1581. <p class="faq">
  1582. <a name="170-requires-junit"></a>
  1583. Ant 1.7.0 doesn't build from sources without
  1584. JUnit
  1585. </p>
  1586. <p>When building Ant 1.7.0 from the source release without
  1587. junit.jar the build fails with the message "We cannot build
  1588. the test jar unless JUnit is present".</p>
  1589. <p>With Ant 1.7.0 we've started to add ant-testutil.jar as
  1590. part of the distribution and this causes a hard dependency on
  1591. JUnit - at least in version 1.7.0. Unfortunately the
  1592. installation docs don't say so.</p>
  1593. <p>There are two workarounds:</p>
  1594. <ol>
  1595. <li>Add junit.jar to your CLASSPATH when building Ant.</li>
  1596. <li>Change Ant's buildfile and remove test-jar from the
  1597. depends list of the dist-lite target.</li>
  1598. </ol>
  1599. <p class="faq">
  1600. <a name="remove-cr"></a>
  1601. &lt;chmod&gt; or &lt;exec&gt; doesn't work in Ant
  1602. 1.3 on Unix
  1603. </p>
  1604. <p>The <code>antRun</code> script in <code>ANT_HOME/bin</code>
  1605. has DOS instead of Unix line endings; you must remove the
  1606. carriage-return characters from this file. This can be done by
  1607. using Ant's <code>&lt;fixcrlf&gt;</code> task
  1608. or something like:</p>
  1609. <pre class="code">
  1610. tr -d '\r' &lt; $ANT_HOME/bin/antRun &gt; /tmp/foo
  1611. mv /tmp/foo $ANT_HOME/bin/antRun
  1612. </pre>
  1613. <p class="faq">
  1614. <a name="javadoc-cannot-execute"></a>
  1615. JavaDoc failed: java.io.IOException: javadoc: cannot execute
  1616. </p>
  1617. <p>There is a bug in the Solaris reference implementation of
  1618. 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>).
  1619. This also appears to be true under Linux. Moving the JDK to
  1620. the front of the PATH fixes the problem.</p>
  1621. <p class="faq">
  1622. <a name="delegating-classloader"></a>
  1623. &lt;style&gt; or &lt;junit&gt; ignores my
  1624. &lt;classpath&gt;
  1625. </p>
  1626. <p>Starting with Ant 1.7.0, &lt;junit&gt; will honor your
  1627. nested &lt;classpath&gt;.</p>
  1628. <p>These tasks don't ignore your classpath setting, you
  1629. are facing a common problem with delegating classloaders.</p>
  1630. <p>This question collects a common type of problem: A task
  1631. needs an external library and it has a nested classpath
  1632. element so that you can point it to this external library, but
  1633. that doesn't work unless you put the external library
  1634. into the <code>CLASSPATH</code> or place it in
  1635. <code>ANT_HOME/lib</code>.</p>
  1636. <p>Some background is necessary before we can discuss
  1637. solutions for <a href="#delegating-classloader-1.5">Ant
  1638. 1.5.x</a> and <a href="#delegating-classloader-1.6">Ant
  1639. 1.6.x</a>.</p>
  1640. <p>When you specify a nested <code>&lt;classpath&gt;</code> in
  1641. Ant, Ant creates a new class loader that uses the path you
  1642. have specified. It then tries to load additional classes from
  1643. this classloader.</p>
  1644. <p>In most cases - for example using &lt;style&gt; or
  1645. &lt;junit&gt; - Ant doesn't load the external library
  1646. directly, it is the loaded class that does so.</p>
  1647. <p>In the case of <code>&lt;junit&gt;</code> it is the task
  1648. implementation itself and in the case of
  1649. <code>&lt;style&gt;</code> it is the implementation of the
  1650. <code>org.apache.tools.ant.taskdefs.XSLTLiaison</code>
  1651. class.</p>
  1652. <p><em>As of Ant 1.7</em> <code>&lt;junit&gt;</code> no longer
  1653. requires you to have <code>junit.jar</code> in Ant's startup
  1654. classpath even if <code>ant-junit.jar</code> is present there.</p>
  1655. <p>Ant's class loader implementation uses Java's
  1656. 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>
  1657. the paragraph</p>
  1658. <blockquote>The <code>ClassLoader</code> class uses a
  1659. delegation model to search for classes and resources. Each
  1660. instance of <code>ClassLoader</code> has an associated parent
  1661. class loader. When called upon to find a class or resource, a
  1662. <code>ClassLoader</code> instance will delegate the search for
  1663. the class or resource to its parent class loader before
  1664. attempting to find the class or resource itself. The virtual
  1665. machine's built-in class loader, called the bootstrap
  1666. class loader, does not itself have a parent but may serve as
  1667. the parent of a <code>ClassLoader</code>
  1668. instance.</blockquote>
  1669. <p>The possible solutions depend on the version of Ant you
  1670. use, see the next sections.</p>
  1671. <p class="faq">
  1672. <a name="delegating-classloader-1.5"></a>
  1673. &lt;style&gt; or &lt;junit&gt; ignores my
  1674. &lt;classpath&gt; - Ant 1.5.x version
  1675. </p>
  1676. <p>Please read <a href="#delegating-classloader">the previous
  1677. entry</a> before you go ahead.</p>
  1678. <p>First of all let's state that Ant's wrapper script
  1679. (<code>ant</code> or <code>ant.bat</code>) adds all
  1680. <code>.jar</code> files from <code>ANT_HOME/lib</code> to
  1681. <code>CLASSPATH</code>, therefore "in
  1682. <code>CLASSPATH</code>" shall mean "either in your
  1683. <code>CLASSPATH</code> environment variable or
  1684. <code>ANT_HOME/lib</code>" for the rest of this
  1685. answer.</p>
  1686. <p>The root of the problem is that the class that needs the
  1687. external library is on the <code>CLASSPATH</code>.</p>
  1688. <p>Let's see what happens when you load the &lt;junit&gt;
  1689. task. Ant's class loader will consult the
  1690. bootstrap class loader first, which tries to load classes from
  1691. <code>CLASSPATH</code>. The bootstrap class loader
  1692. doesn't know anything about Ant's class loader or
  1693. even the path you have specified.</p>
  1694. <p>If the bootstrap class loader can load the class Ant has
  1695. asked it to load (which it can if <code>optional.jar</code> is
  1696. part of <code>CLASSPATH</code>), this class will try to load
  1697. the external library from <code>CLASSPATH</code> as well - it
  1698. doesn't know anything else - and will not find it unless
  1699. the library is in <code>CLASSPATH</code> as well.</p>
  1700. <p>To solve this, you have two major options:</p>
  1701. <ol>
  1702. <li>put all external libraries you need in
  1703. <code>CLASSPATH</code> as well this is not what you want,
  1704. otherwise you wouldn't have found this FAQ entry.</li>
  1705. <li>remove the class that loads the external library from
  1706. the <code>CLASSPATH</code>.</li>
  1707. </ol>
  1708. <p>The easiest way to do this is to remove
  1709. <code>optional.jar</code> from <code>ANT_HOME/lib</code>. If
  1710. you do so, you will have to <code>&lt;taskdef&gt;</code> all
  1711. optional tasks and use nested <code>&lt;classpath&gt;</code>
  1712. elements in the <code>&lt;taskdef&gt;</code> tasks that point
  1713. to the new location of <code>optional.jar</code>. Also,
  1714. don't forget to add the new location of
  1715. <code>optional.jar</code> to the
  1716. <code>&lt;classpath&gt;</code> of your
  1717. <code>&lt;style&gt;</code> or <code>&lt;junit&gt;</code>
  1718. task.</p>
  1719. <p>If you want to avoid to <code>&lt;taskdef&gt;</code> all
  1720. optional tasks you need, the only other option is to remove
  1721. the classes that should not be loaded via the bootstrap class
  1722. loader from <code>optional.jar</code> and put them into a
  1723. separate archive. Add this separate archive to the
  1724. <code>&lt;classpath&gt;</code> of your
  1725. <code>&lt;style&gt;</code> or <code>&lt;junit&gt;</code> task
  1726. - and make sure the separate archive is not in
  1727. <code>CLASSPATH</code>.</p>
  1728. <p>In the case of <code>&lt;junit&gt;</code> you'd have
  1729. to remove all classes that are in the
  1730. <code>org/apache/tools/ant/taskdefs/optional/junit</code>
  1731. directory, in the <code>&lt;style&gt;</code> case it is one of
  1732. the <code>*Liaison</code> classes in
  1733. <code>org/apache/tools/ant/taskdefs/optional</code>.</p>
  1734. <p>If you use the option to break up <code>optional.jar</code>
  1735. for <code>&lt;junit&gt;</code> or remove
  1736. <code>ant-junit.jar</code>, you still have to use a
  1737. <code>&lt;taskdef&gt;</code> with a nested
  1738. <code>&lt;classpath&gt;</code> to define the junit task.</p>
  1739. <p class="faq">
  1740. <a name="delegating-classloader-1.6"></a>
  1741. &lt;style&gt; or &lt;junit&gt; ignores my
  1742. &lt;classpath&gt; - Ant 1.6.x version
  1743. </p>
  1744. <p>Please read <a href="#delegating-classloader">the general
  1745. entry</a> before you go ahead.</p>
  1746. <p>The wrapper script of Ant 1.6.x no longer adds the contents
  1747. of <code>ANT_HOME/lib</code> to <code>CLASSPATH</code>,
  1748. instead Ant will create a classloader on top of the bootstrap
  1749. classloader - let's call it the coreloader for the rest of
  1750. this answer - which holds the contents of
  1751. <code>ANT_HOME/lib</code>. Ant's core and its tasks will be
  1752. loaded through this classloader and not the bootstrap
  1753. classloader.</p>
  1754. <p>This causes some small but notable differences between Ant
  1755. 1.5.x and 1.6.x. Most importantly, a third-party task that is
  1756. part of <code>CLASSPATH</code> will no longer work in Ant
  1757. 1.6.x since the task now can't find Ant's classes. In a sense
  1758. this is the same problem this entry is about, only
  1759. <code>ant.jar</code> has become the external library in
  1760. question now.</p>
  1761. <p>This coreloader also holds the contents of
  1762. <code>~/.ant/lib</code> and any file or directory that has
  1763. been specified using Ant's <code>-lib</code> command line
  1764. argument.</p>
  1765. <p>Let's see what happens when you load the &lt;junit&gt;
  1766. task. Ant's class loader will consult the bootstrap
  1767. class loader first, which tries to load classes from
  1768. <code>CLASSPATH</code>. The bootstrap class loader
  1769. doesn't know anything about Ant's class loader or
  1770. even the path you have specified. If it fails to find the
  1771. class using the bootstrap classloader it will try the
  1772. coreloader next. Again, the coreloader doesn't know anything
  1773. about your path.</p>
  1774. <p>If the coreloader can load the class Ant has asked it to
  1775. load (which it can if <code>ant-junit.jar</code> is in
  1776. <code>ANT_HOME/lib</code>), this class will try to load the
  1777. external library from coreloader as well - it doesn't
  1778. know anything else - and will not find it unless the library
  1779. is in <code>CLASSPATH</code> or the coreloader as well.</p>
  1780. <p>To solve this, you have the following major options:</p>
  1781. <ol>
  1782. <li>put all external libraries you need in
  1783. <code>CLASSPATH</code> as well this is not what you want,
  1784. otherwise you wouldn't have found this FAQ entry.</li>
  1785. <li>put all external libraries you need in
  1786. <code>ANT_HOME/lib</code> or <code>.ant/lib</code>. This
  1787. probably still isn't what you want, but you might reconsider
  1788. the <code>.ant/lib</code> option.</li>
  1789. <li>Always start Ant with the <code>-lib</code> command line
  1790. switch and point to your external libraries (or the
  1791. directories holding them).</li>
  1792. <li>remove the class that loads the external library from
  1793. the coreloader.</li>
  1794. </ol>
  1795. <p>In Ant 1.6 <code>optional.jar</code> has been split into
  1796. multiple jars, each one containing classes with the same
  1797. dependencies on external libraries. You can move the
  1798. "offending" jar out of <code>ANT_HOME/lib</code>. For the
  1799. <code>&lt;junit&gt;</code> task it would be
  1800. <code>ant-junit.jar</code> and for <code>&lt;style&gt;</code>
  1801. it would be <code>ant-trax.jar</code>
  1802. or <code>ant-xslp.jar</code> -
  1803. depending on the processor you use.</p>
  1804. <p>If you do so, you will have to <code>&lt;taskdef&gt;</code>
  1805. all optional tasks that need the external library and use
  1806. nested <code>&lt;classpath&gt;</code> elements in the
  1807. <code>&lt;taskdef&gt;</code> tasks that point to the new
  1808. location of <code>ant-*.jar</code>. Also, don't forget
  1809. to add the new location of <code>ant-*.jar</code> to the
  1810. <code>&lt;classpath&gt;</code> of your
  1811. <code>&lt;style&gt;</code> or <code>&lt;junit&gt;</code>
  1812. task.</p>
  1813. <p>For example</p>
  1814. <pre class="code">
  1815. &lt;taskdef name=&quot;junit&quot;
  1816. class=&quot;org.apache.tools.ant.taskdefs.optional.junit.JUnitTask&quot;&gt;
  1817. &lt;classpath&gt;
  1818. &lt;pathelement location=&quot;HOME-OF/junit.jar&quot;/&gt;
  1819. &lt;pathelement location=&quot;NEW-HOME-OF/ant-junit.jar&quot;/&gt;
  1820. &lt;/classpath&gt;
  1821. &lt;/taskdef&gt;
  1822. </pre>
  1823. <p class="faq">
  1824. <a name="winxp-jdk14-ant14"></a>
  1825. When running Ant 1.4 on Windows XP and JDK 1.4, I get
  1826. various errors when trying to <code>&lt;exec&gt;</code>, fork
  1827. <code>&lt;java&gt;</code> or access environment
  1828. variables.
  1829. </p>
  1830. <p>Ant &lt; 1.5 doesn't recognize Windows XP as a flavor
  1831. of Windows that runs <code>CMD.EXE</code> instead of
  1832. <code>COMMAND.COM</code>. JDK 1.3 will tell Ant that Windows
  1833. XP is Windows 2000 so the problem doesn't show up
  1834. there.</p>
  1835. <p>Apart from upgrading to Ant 1.5 or better, setting the
  1836. environment variable <code>ANT_OPTS</code> to
  1837. <code>-Dos.name=Windows_NT</code> prior to invoking Ant has
  1838. been confirmed as a workaround.</p>
  1839. <p class="faq">
  1840. <a name="1.5-cygwin-sh"></a>
  1841. The <code>ant</code> wrapper script of Ant 1.5 fails
  1842. for Cygwin if <code>ANT_HOME</code> is set to a Windows style
  1843. path.
  1844. </p>
  1845. <p>This problem has been reported only hours after Ant 1.5 has
  1846. been released, see <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=10664">Bug
  1847. 10664</a> and all its duplicates.</p>
  1848. <p>A fixed version of the wrapper script can be found <a href="http://ant.apache.org/old-releases/v1.5/errata/">here</a>.
  1849. Simply replace your script with this version.</p>
  1850. <p class="faq">
  1851. <a name="1.5.2-zip-broken"></a>
  1852. <code>&lt;zip&gt;</code> is broken in Ant 1.5.2.
  1853. </p>
  1854. <p>Yes, it is.</p>
  1855. <p>The problem reported by most people - see <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=17648">Bug
  1856. 17648</a> and all its duplicates - is that Ant creates
  1857. archives that a partially unreadable by WinZIP. Luckily
  1858. <code>jar</code> deals with the archives and so the generated
  1859. jars/wars/ears will most likely work for you anyway.</p>
  1860. <p>There are additional problems, see bugs <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=17780">Bug
  1861. 17780</a>, <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=17871">Bug
  1862. 17871</a> and <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=18403">Bug
  1863. 18403</a>. All of them are supposed to be fixed with Ant
  1864. 1.5.3 (and only 18403 should exist in 1.5.3beta1).</p>
  1865. <p class="faq">
  1866. <a name="unknownelement.taskcontainer"></a>
  1867. Why do my custom task containers see Unknown Elements in Ant 1.6
  1868. - they worked in Ant 1.5?
  1869. </p>
  1870. <p>
  1871. The objects added in TaskContainer.addTask(Task task)
  1872. have changed from Tasks to UnknownElements.
  1873. </p>
  1874. <p>
  1875. There was a number of valid reasons for this change. But the backward
  1876. compatibility problems were not noticed until after Ant 1.6.0 was
  1877. released.
  1878. </p>
  1879. <p>
  1880. Your container class will need to be modified to check if the Task
  1881. is an UnknownElement and call perform on it to
  1882. convert it to a Task and to execute it.
  1883. (see apache.tools.ant.taskdefs.Sequential)
  1884. </p>
  1885. <p>
  1886. If you want to do more processing on the task,
  1887. you need to use the techniques in apache.tools.ant.taskdefs.Antlib#execute()
  1888. This does make use of one 1.6 method call (UE#getRealObject()),
  1889. you need to use UE#getTask() instead - this will
  1890. return null for non tasks (types like fileset id=x).
  1891. </p>
  1892. <p>
  1893. So.. iterate over the tasks, if they are UEs, convert them to
  1894. tasks, using UE#maybeConfigure and UE#getTask()
  1895. </p>
  1896. <pre class="code">
  1897. for (Iterator i = tasks.iterator(); i.hasNext();) {
  1898. Task t = (Task) i.next();
  1899. if (t instanceof UnknownElement) {
  1900. ((UnknownElement) t).maybeConfigure();
  1901. t = ((UnknownElement) t).getTask();
  1902. if (t == null) {
  1903. continue;
  1904. }
  1905. }
  1906. // .... original Custom code
  1907. }
  1908. </pre>
  1909. <p>
  1910. This approach should work for ant1.5 and ant1.6.
  1911. </p>
  1912. <p class="faq">
  1913. <a name="java.exception.stacktrace"></a>
  1914. The program I run via &lt;java&gt; throws an exception but I
  1915. can't seem to get the full stack trace.
  1916. </p>
  1917. <p>This is a know bug that has been fixed after the release of
  1918. Ant 1.6.1.</p>
  1919. <p>As a workaround, run your &lt;java&gt; task with
  1920. <code>fork="true"</code> and Ant will display the full
  1921. trace.</p>
  1922. <p class="faq">
  1923. <a name="junit-no-runtime-xml"></a>
  1924. Using format="xml", &lt;junit&gt; fails with a
  1925. <code>NoClassDefFoundError</code> if forked.
  1926. </p>
  1927. <p>The XML formatter needs the <a href="http://www.w3.org/DOM/">DOM classes</a> to work. If you
  1928. are using JDK 1.4 or later they are included with your Java
  1929. Runtime and this problem won't occur. If you are running JDK
  1930. 1.3 or earlier, the DOM classes have to be on your
  1931. &lt;junit&gt; task's &lt;classpath&gt;.</p>
  1932. <p>Prior to Ant 1.6.0 Ant would include the DOM classes from
  1933. the XML parser that is used by Ant itself if you set the
  1934. includeAntRuntime attribute to true (the default). With Ant
  1935. 1.6.0 this has been changed as this behavior made it
  1936. impossible to use a different XML parser in your tests.</p>
  1937. <p>This means that you have to take care of the DOM classes
  1938. explicitly starting with Ant 1.6.0. If you don't need to set
  1939. up a different XML parser for your tests, the easiest solution
  1940. is to add</p>
  1941. <pre class="code">
  1942. &lt;pathelement path=&quot;${ant.home}/lib/xml-apis.jar:${ant.home}/lib/xercesImpl.jar&quot;/&gt;
  1943. </pre>
  1944. <p>to your task's &lt;classpath&gt;.</p>
  1945. <p class="faq">
  1946. <a name="xalan-jdk1.5"></a>
  1947. <code>&lt;junitreport&gt;</code> doesn't work with JDK 1.5 but
  1948. worked fine with JDK 1.4.
  1949. </p>
  1950. <p>While JDK 1.4.x contains a version of Xalan-J 2, JDK 1.5
  1951. (and later?) have <a href="http://java.sun.com/j2se/1.5.0/compatibility.html#4959783">moved
  1952. to XSLTC</a>. Since this task uses Xalan's redirect
  1953. extensions for its internal stylesheet, Ant prior to 1.6.2 didn't support
  1954. XSLTC. This means that you have to install <a href="http://xml.apache.org/xalan-j/">Xalan-J 2</a> in order
  1955. to use this task with JDK 1.5 in older versions of Ant.</p>
  1956. <p>Starting with Ant 1.6.2 <code>&lt;junitreport&gt;</code>
  1957. supports JDK 1.5.</p>
  1958. </div>
  1959. </div>
  1960. <p class="copyright">
  1961. <script type="text/javascript" language="JavaScript"><!--
  1962. document.write(" - "+"Last Published: " + document.lastModified);
  1963. // -->
  1964. </script>
  1965. </p>
  1966. </body>
  1967. </html>