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

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