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.

index.html 187 KiB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Language" content="en-us">
  4. <title>Ant</title>
  5. </head>
  6. <body>
  7. <h1>Ant User Manual</h1>
  8. <p>by</p>
  9. <!-- Names are in alphabetical order, on last name -->
  10. <ul>
  11. <li>Jacques Bergeron (<a href="mailto:jacques.bergeron@dogico.com">jacques.bergeron@dogico.com</a>)</li>
  12. <li>Stefan Bodewig (<a href="mailto:stefan.bodewig@megabit.net">stefan.bodewig@megabit.net</a>)</li>
  13. <li>Patrick Chanezon (<a href="mailto:chanezon@netscape.com">chanezon@netscape.com</a>)</li>
  14. <li>James Duncan Davison (<a href="mailto:duncan@x180.com">duncan@x180.com</a>)</li>
  15. <li>Tom Dimock (<a href="mailto:tad1@cornell.edu">tad1@cornell.edu</a>)</li>
  16. <li>Bill Kelly (<a href="mailto:bill.kelly@softwired-inc.com">bill.kelly@softwired-inc.com</a>)</li>
  17. <li>Arnout J. Kuiper (<a href="mailto:ajkuiper@wxs.nl">ajkuiper@wxs.nl</a>)</li>
  18. <li>Conor MacNeill (<a href="mailto:conor@cortexebusiness.com.au">conor@cortexebusiness.com.au</a>)</li>
  19. <li>Stefano Mazzocchi (<a href="mailto:stefano@apache.org">stefano@apache.org</a>)</li>
  20. <li>Sam Ruby (<a href="mailto:rubys@us.ibm.com">rubys@us.ibm.com</a>)</li>
  21. <li>Roger Vaughn (<a href="mailto:rvaughn@seaconinc.com">rvaughn@seaconinc.com</a>)</li>
  22. <li>Dave Walend (<a href="mailto:dwalend@cs.tufts.edu">dwalend@cs.tufts.edu</a>)</li>
  23. </ul>
  24. <p>Version 1.2 - 2000/08/10</p>
  25. <hr>
  26. <h2>Table of Contents</h2>
  27. <ul>
  28. <li><a href="#introduction">Introduction</a></li>
  29. <li><a href="#getting">Getting Ant</a></li>
  30. <li><a href="#sysrequirements">System Requirements</a></li>
  31. <li><a href="#buildingant">Building Ant</a></li>
  32. <li><a href="#installing">Installing Ant</a></li>
  33. <li><a href="#running">Running Ant</a></li>
  34. <li><a href="#buildfile">Writing a simple buildfile</a>
  35. <li><a href="#directorybasedtasks">Directory based tasks</a></li>
  36. <li><a href="#tasks">Built in Tasks</a>
  37. <li><a href="#optionaltasks">Optional Tasks</a>
  38. <li><a href="#buildevents">Build Events</a>
  39. <li><a href="#writingowntask">Writing your own task</a></li>
  40. <li><a href="#faq">FAQ, DTD, external resources</a>
  41. <li><a href="../LICENSE">License</a></li>
  42. <li><a href="#feedback">Feedback</a></li>
  43. </ul>
  44. <hr>
  45. <h2><a name="introduction">Introduction</a></h2>
  46. <p>Ant is a Java based build tool. In theory it is kind of like make without
  47. make's wrinkles.</p>
  48. <h3>Why?</h3>
  49. <p>Why another build tool when there is already make, gnumake, nmake, jam, and
  50. others? Because all of those tools have limitations that its original author
  51. couldn't live with when developing software across multiple platforms. Make like
  52. tools are inherently shell based. They evaluate a set of dependencies and then
  53. execute commands not unlike what you would issue on a shell. This means that you
  54. can easily extend these tools by using or writing any program for the OS that
  55. you are working on. However, this also means that you limit yourself to the OS,
  56. or at least the OS type such as Unix, that you are working on.</p>
  57. <p>Makefiles are inherently evil as well. Anybody who has worked on them for any
  58. time has run into the dreaded tab problem. &quot;Is my command not executing
  59. because I have a space in front of my tab!!!&quot; said the original author of
  60. Ant way too many times. Tools like Jam took care of this to a great degree, but
  61. still use yet another format to use and remember.</p>
  62. <p>Ant is different. Instead a model where it is extended with shell based
  63. commands, it is extended using Java classes. Instead of writing shell commands,
  64. the configuration files are XML based calling out a target tree where various
  65. tasks get executed. Each task is run by an object which implements a particular
  66. Task interface.</p>
  67. <p>Granted, this removes some of the expressive power that is inherent by being
  68. able to construct a shell command such as `find . -name foo -exec rm {}` but it
  69. gives you the ability to be cross platform. To work anywhere and everywhere. And
  70. hey, if you really need to execute a shell command, Ant has an exec rule that
  71. allows different commands to be executed based on the OS that it is executing
  72. on.</p>
  73. <hr>
  74. <h2><a name="getting">Getting Ant</a></h2>
  75. <h3>Binary edition</h3>
  76. <p>The latest stable version of Ant can be downloaded from <a
  77. href="http://jakarta.apache.org/builds/ant/release/v1.1/bin/">
  78. http://jakarta.apache.org/builds/ant/release/v1.1/bin/</a>.
  79. If you like living on the edge, you can download the latest version from <a
  80. href="http://jakarta.apache.org/builds/ant/nightly/">http://jakarta.apache.org/builds/ant/nightly/</a>.</p>
  81. <h3>Source edition</h3>
  82. <p>If you prefer the source edition, you can download Ant from <a
  83. href="http://jakarta.apache.org/builds/ant/release/v1.1/src/">
  84. http://jakarta.apache.org/builds/ant/release/v1.1/src/</a>
  85. (latest stable) or from <a
  86. href="http://jakarta.apache.org/from-cvs/jakarta-tools/">http://jakarta.apache.org/from-cvs/jakarta-ant/</a>
  87. (current). See the section <a href="#buildingant">Building Ant</a> on how to
  88. build Ant from the source code.</p>
  89. <hr>
  90. <h2><a name="sysrequirements">System Requirements</a></h2>
  91. <p>
  92. To build and use ant you must have a JAXP compliant XML parser installed and available on your classpath.
  93. <p>
  94. If you do not have a JAXP compliant XML parse installed, you may use the reference implementation
  95. available from Sun. It is available from <a href="http://java.sun.com/xml">http://java.sun.com/xml</a>.
  96. Once installed make sure the "jaxp.jar" and "parser.jar" files are in your classpath.
  97. <p>
  98. You will also need the JDK installed on your system, version 1.1 or later.
  99. <hr>
  100. <h2><a name="buildingant">Building Ant</a></h2>
  101. <p>Go to the directory <code>jakarta-ant</code>.</p>
  102. <p>Make sure the JDK is in you path.</p>
  103. <p>Set the JAVA_HOME environment variable. This should be set to the
  104. directory where the JDK is installed. See <a href="#installing">Installing Ant</a>
  105. for examples on how to do this for your operating system.</p>
  106. <p>Run <code>bootstrap.bat</code> (Windows) or <code>bootstrap.sh</code> (UNIX)
  107. to build a bootstrap version of Ant.</p>
  108. <p>When finished, use</p>
  109. <blockquote>
  110. <p><code>build.bat -Dant.dist.dir=&lt;directory to install Ant&gt; dist</code></p>
  111. </blockquote>
  112. <p>for Windows, and</p>
  113. <blockquote>
  114. <p><code>build.sh -Dant.dist.dir=&lt;directory to install Ant&gt; dist</code></p>
  115. </blockquote>
  116. <p>for UNIX, to create a binary distribution of Ant. This distribution can be
  117. found in the directory you specified.</p>
  118. <hr>
  119. <h2><a name="installing">Installing Ant</a></h2>
  120. <p>The binary distribution of Ant consists of three directories: <code>bin</code>,
  121. <code>docs</code> and <code>lib</code>. Only the <code>bin</code> and <code>lib</code>
  122. directory are crucial for running Ant. To run Ant, the following must be done:</p>
  123. <ul>
  124. <li>Add the <code>bin</code> directory to your path.</li>
  125. <li>Set the ANT_HOME environment variable. This should be set to the directory
  126. which contains the <code>bin</code> and <code>lib</code> directory.</li>
  127. <li>Set the JAVA_HOME environment variable. This should be set to the
  128. directory where the JDK is installed.</li>
  129. </ul>
  130. <h3>Windows</h3>
  131. <p>Assume Ant is installed in <code>c:\ant\</code>. The following sets up the
  132. environment:</p>
  133. <pre>set ANT_HOME=c:\ant
  134. set JAVA_HOME=c:\jdk1.2.2
  135. set PATH=%PATH%;%ANT_HOME%\bin</pre>
  136. <h3>Unix (bash)</h3>
  137. <p>Assume Ant is installed in <code>/usr/local/ant</code>. The following sets up
  138. the environment:</p>
  139. <pre>export ANT_HOME=/usr/local/ant
  140. export JAVA_HOME=/usr/local/jdk-1.2.2
  141. export PATH=${PATH}:${ANT_HOME}/bin</pre>
  142. <h3>Advanced</h3>
  143. <p>There are lots of variants that can be used to run Ant. What you need is at
  144. least the following:</p>
  145. <p>The classpath for Ant must contain <code>ant.jar</code> and any jars/classes
  146. needed for your chosen JAXP compliant XML parser.</p>
  147. <p>When you need JDK functionality (like a <a href="#javac">javac</a> task, or a
  148. <a href="#rmic">rmic</a> task), then for JDK 1.1, the <code>classes.zip</code>
  149. file of the JDK must be added to the classpath; for JDK 1.2, <code>tools.jar</code>
  150. must be added. The scripts supplied with ant, in the bin directory, will add
  151. <code>tools.jar</code> automatically if the JAVA_HOME environment variable is set.</p>
  152. <p>When you are executing platform specific applications (like the <a
  153. href="#exec">exec</a> task, or the <a href="#cvs">cvs</a> task), the property <code>ant.home</code>
  154. must be set to the directory containing a bin directory, which contains the <code>antRun</code> shell script necessary to run execs on Unix.</p>
  155. <hr>
  156. <h2><a name="running">Running Ant</a></h2>
  157. <p>Running Ant is simple, when you installed it as described in the previous
  158. section. Just type <code>ant</code>.</p>
  159. <p>When nothing is specified, Ant looks for a <code>build.xml</code> file in the
  160. current directory. When found, it uses that file as a buildfile. To make Ant use
  161. another buildfile, use the commandline option <i>-buildfile &lt;file&gt;</i>,
  162. where <i>&lt;file&gt;</i> is the buildfile you want to use.</p>
  163. <p>You can also set properties which override properties specified in the
  164. buildfile (see the <a href="#property">property task</a>).
  165. This can be done with the <i>-D&lt;property&gt;=&lt;value&gt;</i>
  166. option, where <i>&lt;property&gt;</i> is the name of the property and <i>&lt;value&gt;</i>
  167. the value.</p>
  168. <p>To more options are <i>-quiet</i> which instructs Ant to print less
  169. information on the console when running. The option <i>-verbose</i> on the other
  170. hand makes Ant print more information on the console.</p>
  171. <p>It is also possible to specify the target that should be executed. Default
  172. the target that is mentioned in the <i>default</i> attribute of the project is
  173. used. This can be overridden by adding the target name to the end of the
  174. commandline.</p>
  175. <p>Commandline option summary:</p>
  176. <pre>ant [options] [target]
  177. Options:
  178. -help print this message
  179. -version print the version information and exit
  180. -quiet be extra quiet
  181. -verbose be extra verbose
  182. -logfile &lt;file&gt; use given file for log
  183. -listener &lt;classname&gt; add an instance of class as a project listener
  184. -buildfile &lt;file&gt; use given buildfile
  185. -D&lt;property&gt;=&lt;value&gt; use value for given property</pre>
  186. <h3>Examples</h3>
  187. <blockquote>
  188. <pre>ant</pre>
  189. </blockquote>
  190. <p>runs Ant using the <code>build.xml</code> file in the current directory, on
  191. the default target.</p>
  192. <blockquote>
  193. <pre>ant -buildfile test.xml</pre>
  194. </blockquote>
  195. <p>runs Ant using the <code>test.xml</code> file in the current directory, on
  196. the default target.</p>
  197. <blockquote>
  198. <pre>ant -buildfile test.xml dist</pre>
  199. </blockquote>
  200. <p>runs Ant using the <code>test.xml</code> file in the current directory, on a
  201. target called <code>dist</code>.</p>
  202. <blockquote>
  203. <pre>ant -buildfile test.xml -Dbuild=build/classes dist</pre>
  204. </blockquote>
  205. <p>runs Ant using the <code>test.xml</code> file in the current directory, on a
  206. target called <code>dist</code>. It also sets the <i>build</i> property to the
  207. value <i>build/classes</i>.</p>
  208. <h3>Running Ant by hand</h3>
  209. <p>When you have installed Ant in the do-it-yourself way, Ant can be started
  210. with:</p>
  211. <blockquote>
  212. <pre>java -Dant.home=c:\ant org.apache.tools.ant.Main [options] [target]</pre>
  213. </blockquote>
  214. <p>These instructions actually do exactly the same as the <code>ant</code>
  215. command. The options and target are the same as when running Ant with the <code>ant</code>
  216. command. This example assumes you have set up your classpath to include
  217. <ul>
  218. <li>ant.jar
  219. <li>jars/classes for your XML parser
  220. <li>the JDK's tools.jar
  221. </ul>
  222. <hr>
  223. <h2><a name="buildfile">Writing a simple buildfile</a></h2>
  224. <p>The buildfile is written in XML. Each buildfile contains one project.</p>
  225. <p>Each element of the buildfile can have an <code>id</code> attribute and
  226. can later be referred to by the value supplied to this. The value has
  227. to be unique.</p>
  228. <h3>Projects</h3>
  229. <p>A project has three attributes:</p>
  230. <table border="1" cellpadding="2" cellspacing="0">
  231. <tr>
  232. <td valign="top"><b>Attribute</b></td>
  233. <td valign="top"><b>Description</b></td>
  234. <td align="center" valign="top"><b>Required</b></td>
  235. </tr>
  236. <tr>
  237. <td valign="top">name</td>
  238. <td valign="top">the name of the project.</td>
  239. <td align="center" valign="top">Yes</td>
  240. </tr>
  241. <tr>
  242. <td valign="top">default</td>
  243. <td valign="top">the default target to use when no target is supplied.</td>
  244. <td align="center" valign="top">Yes</td>
  245. </tr>
  246. <tr>
  247. <td valign="top">basedir</td>
  248. <td valign="top">the base directory from which all path calculations are
  249. done. This attribute might be overridden by setting the &quot;basedir&quot;
  250. property on forehand. When this is done, it might be omitted in the
  251. project tag.</td>
  252. <td align="center" valign="top">Yes</td>
  253. </tr>
  254. </table>
  255. <p>Each project defines one or more targets. A target is a set of tasks you want
  256. to be executed. When starting Ant, you can select which target you want to have
  257. executed. When no target is given, the project's default is used.</p>
  258. <h3>Targets</h3>
  259. <p>A target can depend on other targets. You might have a target for compiling,
  260. for instance, and a target for creating a distributable. You can only build a
  261. distributable when you have compiled first, so the distribute target depends on
  262. the compile target. Ant resolves all these dependencies.</p>
  263. <p>Ant tries to execute the targets in the <i>depends</i> attribute in the order
  264. they appear (from left to right). Keep in mind that it is possible that a target
  265. can get executed earlier when an earlier target depends on it:</p>
  266. <blockquote>
  267. <pre>&lt;target name=&quot;A&quot;/&gt;
  268. &lt;target name=&quot;B&quot; depends=&quot;A&quot;/&gt;
  269. &lt;target name=&quot;C&quot; depends=&quot;B&quot;/&gt;
  270. &lt;target name=&quot;D&quot; depends=&quot;C,B,A&quot;/&gt;</pre>
  271. </blockquote>
  272. <p>Suppose we want to execute target D. From its <i>depends</i> attribute, you
  273. might think that first target C, then B and then A is executed. Wrong! C depends
  274. on B, and B depends on A, so first A is executed, then B, then C, and finally D.</p>
  275. <p>A target gets executed only once. Even when more targets depend on it (see
  276. the previous example).</p>
  277. <p>A target has also the ability to perform its execution if (or
  278. unless) a property has been set. This allows, for example, better
  279. control on the building process depending on the state of the system
  280. (java version, OS, command line properties, etc...). To make target
  281. <i>sense</i> this property you should add the <i>if</i> (or
  282. <i>unless</i>) attribute with the name of the property that the target
  283. should react to, for example</p>
  284. <blockquote>
  285. <pre>&lt;target name=&quot;build-module-A&quot; if=&quot;module-A-present&quot;/&gt;</pre>
  286. <pre>&lt;target name=&quot;build-own-fake-module-A&quot; unless=&quot;module-A-present&quot;/&gt;</pre>
  287. </blockquote>
  288. <p>If no <i>if</i> and no <i>unless</i> attribute is present, the target will
  289. always be executed.</p>
  290. <p>It is a good practice to place your <a
  291. href="#tstamp">tstamp</a> tasks in a so called initialization target, on which
  292. all other targets depend. Make sure that target is always the first one in
  293. the depends list of the other targets. In this manual, most initialization targets
  294. have the name "init".</p>
  295. <p>A target has the following attributes:</p>
  296. <table border="1" cellpadding="2" cellspacing="0">
  297. <tr>
  298. <td valign="top"><b>Attribute</b></td>
  299. <td valign="top"><b>Description</b></td>
  300. <td align="center" valign="top"><b>Required</b></td>
  301. </tr>
  302. <tr>
  303. <td valign="top">name</td>
  304. <td valign="top">the name of the project.</td>
  305. <td align="center" valign="top">Yes</td>
  306. </tr>
  307. <tr>
  308. <td valign="top">depends</td>
  309. <td valign="top">a comma separated list of names of targets on which this
  310. target depends.</td>
  311. <td align="center" valign="top">No</td>
  312. </tr>
  313. <tr>
  314. <td valign="top">if</td>
  315. <td valign="top">the name of the property that must be set in order for this
  316. target to execute.</td>
  317. <td align="center" valign="top">No</td>
  318. </tr>
  319. <tr>
  320. <td valign="top">unless</td>
  321. <td valign="top">the name of the property that must not be set in order
  322. for this target to execute.</td>
  323. <td align="center" valign="top">No</td>
  324. </tr>
  325. </table>
  326. <h3>Tasks</h3>
  327. <p>A task is a piece of code that can be executed.</p>
  328. <p>A task can have multiple attributes (or arguments if you prefer). The value
  329. of an attribute might contain references to a property. These references will be
  330. resolved before the task is executed.</p>
  331. <p>Tasks have a common structure:</p>
  332. <blockquote>
  333. <pre>&lt;name attribute1=&quot;value1&quot; attribute2=&quot;value2&quot; ... /&gt;</pre>
  334. </blockquote>
  335. <p>where name is the name of the task, attribute-x the attribute name, and
  336. value-x the value of this attribute.</p>
  337. <p>There is a set of <a href="#tasks">built in tasks</a>, but it is also very
  338. easy to <a href="#writingowntask">write your own</a>.</p>
  339. <p>All tasks share a <code>taskname</code> attribute. The value of
  340. this attribute will be used in the logging messages generated by
  341. Ant.</p>
  342. <h3>Properties</h3>
  343. <p>A project can have a set of properties. These might be set in the buildfile
  344. by the <a href="#property">property task</a>, or might be set outside Ant. A
  345. property has a name and a value. Properties might be used in in the value of
  346. task attributes. This is done by placing the property name between
  347. &quot;${&quot; and &quot;}&quot; in the attribute value.</p>
  348. <p>If there is a property called &quot;builddir&quot; with the value
  349. &quot;build&quot;, then this could be used in an attribute like this: &quot;${builddir}/classes&quot;.
  350. This is resolved as &quot;build/classes&quot;.</p>
  351. <h3>Example</h3>
  352. <blockquote>
  353. <pre>
  354. &lt;project name=&quot;MyProject&quot; default=&quot;dist&quot; basedir=&quot;.&quot;&gt;
  355. &lt;!-- set global properties for this build --&gt;
  356. &lt;property name=&quot;src&quot; value=&quot;.&quot; /&gt;
  357. &lt;property name=&quot;build&quot; value=&quot;build&quot; /&gt;
  358. &lt;property name=&quot;dist&quot; value=&quot;dist&quot; /&gt;
  359. &lt;target name=&quot;prepare&quot;&gt;
  360. &lt;!-- Create the time stamp --&gt;
  361. &lt;tstamp/&gt;
  362. &lt;!-- Create the build directory structure used by compile --&gt;
  363. &lt;mkdir dir=&quot;${build}&quot; /&gt;
  364. &lt;/target&gt;
  365. &lt;target name=&quot;compile&quot; depends=&quot;prepare&quot;&gt;
  366. &lt;!-- Compile the java code from ${src} into ${build} --&gt;
  367. &lt;javac srcdir=&quot;${src}&quot; destdir=&quot;${build}&quot; /&gt;
  368. &lt;/target&gt;
  369. &lt;target name=&quot;dist&quot; depends=&quot;compile&quot;&gt;
  370. &lt;!-- Create the ${dist}/lib directory --&gt;
  371. &lt;mkdir dir=&quot;${dist}/lib&quot; /&gt;
  372. &lt;!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file --&gt;
  373. &lt;jar jarfile=&quot;${dist}/lib/MyProject-${DSTAMP}.jar&quot; basedir=&quot;${build}&quot; /&gt;
  374. &lt;/target&gt;
  375. &lt;target name=&quot;clean&quot;&gt;
  376. &lt;!-- Delete the ${build} and ${dist} directory trees --&gt;
  377. &lt;deltree dir=&quot;${build}&quot; /&gt;
  378. &lt;deltree dir=&quot;${dist}&quot; /&gt;
  379. &lt;/target&gt;
  380. &lt;/project&gt;
  381. </pre>
  382. </blockquote>
  383. <h3>Token Filters</h3>
  384. <p>A project can have a set of tokens that might be automatically expanded if
  385. found when a file is copied, when the filtering-copy behavior is selected in the
  386. tasks that support this. These might be set in the buildfile
  387. by the <a href="#filter">filter task</a>.&nbsp;</p>
  388. <p>Since this can be a very harmful behavior, the tokens in the files <b>must</b>
  389. be of the form<i> @token@</i> where <i>token</i> is the token name that is set
  390. in the filter task. This token syntax matches the syntax of other build systems
  391. that perform such filtering and remains sufficiently orthogonal to most
  392. programming and scripting languages, as well with documentation systems.</p>
  393. <p>Note: in case a token with the format @token@ if found in a file but no
  394. filter is associated with that token, no changes take place. So, no escaping
  395. method is present, but as long as you choose appropriate names for your tokens,
  396. this should not cause problems.</p>
  397. <h3><a name="path">PATH like structures</a></h3>
  398. <p>You can specify PATH and CLASSPATH variables using both
  399. &quot;:&quot; and &quot;;&quot; as separator characters, Ant will
  400. convert it to the correct character of the current operating
  401. system.</p>
  402. <p>Wherever PATH like values need to be specified a nested element can
  403. be used. This takes the general form of</p>
  404. <pre>
  405. &lt;classpath&gt;
  406. &lt;pathelement path=&quot;${classpath}&quot; /&gt;
  407. &lt;pathelement location=&quot;lib/helper.jar&quot; /&gt;
  408. &lt;/classpath&gt;
  409. </pre>
  410. <p>The <code>location</code> attribute specifies a single file or
  411. directory relative to the project's base directory (or an absolute
  412. filename), while the <code>path</code> attribute accepts &quot;:&quot;
  413. or &quot;;&quot; separated lists of locations. The <code>path</code>
  414. attribute is intended to be used with predefined paths - in any other
  415. case multiple elements with <code>location</code> attributes should be
  416. preferred.</p>
  417. <p>As a shortcut the surrounding PATH element supports path and
  418. location attributes of its own, so</p>
  419. <pre>
  420. &lt;classpath&gt;
  421. &lt;pathelement path=&quot;${classpath}&quot; /&gt;
  422. &lt;/classpath&gt;
  423. </pre>
  424. <p>can be abreviated to</p>
  425. <pre>
  426. &lt;classpath path=&quot;${classpath}&quot; /&gt;
  427. </pre>
  428. <p>In addition, <a href="#fileset">FileSet</a>s can be specified via
  429. nested <code>&lt;fileset&gt;</code> and
  430. <code>&lt;filesetref&gt;</code> elements. The order in which the files
  431. building up FileSet are added to the PATH like structure is not
  432. defined.</p>
  433. <pre>
  434. &lt;classpath&gt;
  435. &lt;pathelement path=&quot;${classpath}&quot; /&gt;
  436. &lt;fileset dir=&quot;lib&quot;&gt;
  437. &lt;include name=&quot;**/*.jar&quot; /&gt;
  438. &lt;/fileset;&gt;
  439. &lt;pathelement location=&quot;classes&quot; /&gt;
  440. &lt;/classpath&gt;
  441. </pre>
  442. <p>Builds a PATH which holds the value of <code>${classpath}</code>
  443. followed by all JAR files in the <code>lib</code> directory, followed
  444. by the <code>classes</code> directory.</p>
  445. <h3><a name="arg">Command line arguments</a></h3>
  446. <p>Several tasks take arguments that shall be passed to another
  447. process on the command line. To make it easier to specify arguments
  448. that contain space characters, nested elements can be used.</p>
  449. <table border="1" cellpadding="2" cellspacing="0">
  450. <tr>
  451. <td width="12%" valign="top"><b>Attribute</b></td>
  452. <td width="78%" valign="top"><b>Description</b></td>
  453. <td width="10%" valign="top"><b>Required</b></td>
  454. </tr>
  455. <tr>
  456. <td valign="top">value</td>
  457. <td valign="top">a single command line argument, can contain space
  458. characters.</td>
  459. <td align="center" rowspan="4">Exactly one of these.</td>
  460. </tr>
  461. <tr>
  462. <td valign="top">line</td>
  463. <td valign="top">a space delimited list of command line arguments.</td>
  464. </tr>
  465. <tr>
  466. <td valign="top">file</td>
  467. <td valign="top">The name of a file as a single command line
  468. argument. Will be replaced with the absolute filename of the file
  469. by Ant.</td>
  470. </tr>
  471. <tr>
  472. <td valign="top">path</td>
  473. <td valign="top">A string that shall be treated as a PATH like
  474. string as a single command line argument. You can use ; or : as
  475. path separators and Ant will convert it to the platform's local
  476. conventions.</td>
  477. </tr>
  478. </table>
  479. <h4>Examples</h4>
  480. <blockquote><pre>
  481. &lt;arg value=&quot;-l -a&quot; /&gt;
  482. </pre></blockquote>
  483. <p>is a single command line argument containing a space character.</p>
  484. <blockquote><pre>
  485. &lt;arg line=&quot;-l -a&quot; /&gt;
  486. </pre></blockquote>
  487. <p>stands for two separate command line arguments.</p>
  488. <blockquote><pre>
  489. &lt;arg path=&quot;/dir;/dir2:\dir3&quot; /&gt;
  490. </pre></blockquote>
  491. <p>is a single command line argument with value
  492. <code>\dir;\dir2;\dir3</code> on DOS based systems and
  493. <code>/dir:/dir2:/dir3</code> on Unix like systems.</p>
  494. <h3><a name="references">References</a></h3>
  495. <p>The <code>id</code> attribute of the buildfile's elements can be
  496. used to refer to them. This can useful if you are going to replicate
  497. the same snippet of XML over and over again - using a
  498. <code>&lt;classpath&gt;</code> structure more than once for
  499. example.</p>
  500. <p>The following example</p>
  501. <blockquote><pre>
  502. &lt;rmic ...&gt;
  503. &lt;classpath&gt;
  504. &lt;pathelement location=&quot;lib/&quot; /&gt;
  505. &lt;pathelement path=&quot;${java.class.path}/&quot; /&gt;
  506. &lt;pathelement path=&quot;${additional.path}&quot; /&gt;
  507. &lt;/classpath&gt;
  508. &lt;/rmic&gt;
  509. &lt;javac ...&gt;
  510. &lt;classpath&gt;
  511. &lt;pathelement location=&quot;lib/&quot; /&gt;
  512. &lt;pathelement path=&quot;${java.class.path}/&quot; /&gt;
  513. &lt;pathelement path=&quot;${additional.path}&quot; /&gt;
  514. &lt;/classpath&gt;
  515. &lt;/javac&gt;
  516. </pre></blockquote>
  517. <p>could be rewritten as</p>
  518. <blockquote><pre>
  519. &lt;rmic ...&gt;
  520. &lt;classpath id=&quot;project.class.path&quot;&gt;
  521. &lt;pathelement location=&quot;lib/&quot; /&gt;
  522. &lt;pathelement path=&quot;${java.class.path}/&quot; /&gt;
  523. &lt;pathelement path=&quot;${additional.path}&quot; /&gt;
  524. &lt;/classpath&gt;
  525. &lt;/rmic&gt;
  526. &lt;javac ...&gt;
  527. &lt;classpathref refid=&quot;project.class.path&quot; /&gt;
  528. &lt;/javac&gt;
  529. </pre></blockquote>
  530. <p>All tasks that use nested elements for <a
  531. href="#patternset">PatternSet</a>s, <a href="#fileset">FileSet</a>s or
  532. <a href="#path">PATH like structures</a> accept references to these
  533. structures as well.</p>
  534. <hr>
  535. <h2><a name="directorybasedtasks">Directory based tasks</a></h2>
  536. <p>Some tasks use directory trees for the task they perform. For instance, the <a
  537. href="#javac">Javac task</a> which works upon a directory tree with .java files.
  538. Sometimes it can be very useful to work on a subset of that directory tree. This
  539. section describes how you can select a subset of such a directory tree.</p>
  540. <p>Ant gives you two ways to create a subset, both of which can be used at the same
  541. time:</p>
  542. <ul>
  543. <li>Only include files/directories that match at least one pattern of a set of
  544. patterns</li>
  545. <li>Exclude files/directories that match at least one pattern a set of
  546. patterns</li>
  547. </ul>
  548. <p>When both inclusion and exclusion are used, only files/directories that match
  549. the include patterns, and don't match the exclude patterns are used.</p>
  550. <p>Patterns can be specified inside the buildfile via task attributes or
  551. nested elements and via external files. Each line of the external file
  552. is taken as pattern that is added to the list of include or exclude
  553. patterns.</p>
  554. <h3>Patterns</h3>
  555. <p>As described earlier, patterns are used for the inclusion and exclusion.
  556. These patterns look very much like the patterns used in DOS and UNIX:</p>
  557. <p>'*' matches zero or more characters, '?' matches one character.</p>
  558. <p>Examples:</p>
  559. <p>'*.java' matches '.java', 'x.java' and 'FooBar.java', but not 'FooBar.xml'
  560. (does not end with '.java').</p>
  561. <p>'?.java' matches 'x.java', 'A.java', but not '.java' or 'xyz.java' (both
  562. don't have one character before '.java').</p>
  563. <p>Combinations of '*'s and '?'s are allowed.</p>
  564. <p>Matching is done per-directory. This means that first the first directory in
  565. the pattern is matched against the first directory in the path to match. Then
  566. the second directories are matched, and so on. E.g. when we have the pattern '/?abc/*/*.java'
  567. and the path '/xabc/foobar/test.java', then first '?abc' is matched with 'xabc',
  568. then '*' is matched with 'foobar' and finally '*.java' is matched with 'test.java'.
  569. They all match so the path matches the pattern.</p>
  570. <p>Too make things a bit more flexible, we add one extra feature, which makes it
  571. possible to match multiple directory levels. This can be used to match a
  572. complete directory tree, or a file anywhere in the directory tree. To do this, '**'
  573. must be used as the name of a directory. When '**' is used as the name of a
  574. directory in the pattern, it matches zero or more directories. For instance:
  575. '/test/**' matches all files/directories under '/test/', such as '/test/x.java',
  576. or '/test/foo/bar/xyz.html', but not '/xyz.xml'.</p>
  577. <p>There is one &quot;shorthand&quot;, if a pattern ends with '/' or '\', then '**'
  578. is appended. E.g. &quot;mypackage/test/&quot; is interpreted as were it &quot;mypackage/test/**&quot;.</p>
  579. <p>Examples:</p>
  580. <table border="1" cellpadding="2" cellspacing="0">
  581. <tr>
  582. <td valign="top">**/CVS/*</td>
  583. <td valign="top">Matches all files in CVS directories, that can be located
  584. anywhere in the directory tree.
  585. <p>Matches:</p>
  586. <p>CVS/Repository<br>
  587. org/apache/CVS/Entries<br>
  588. org/apache/jakarta/tools/ant/CVS/Entries</p>
  589. <p>But not:</p>
  590. <p>org/apache/CVS/foo/bar/Entries ('foo/bar/' part does not match)</td>
  591. </tr>
  592. <tr>
  593. <td valign="top">org/apache/jakarta/**</td>
  594. <td valign="top">Matches all files in the org/apache/jakarta directory tree.
  595. <p>Matches:</p>
  596. <p>org/apache/jakarta/tools/ant/docs/index.html<br>
  597. org/apache/jakarta/test.xml</p>
  598. <p>But not:</p>
  599. <p>org/apache/xyz.java ('jakarta'/' part is missing)</td>
  600. </tr>
  601. <tr>
  602. <td valign="top">org/apache/**/CVS/*</td>
  603. <td valign="top">Matches all files in CVS directories, that are located
  604. anywhere in the directory tree under org/apache.
  605. <p>Matches:</p>
  606. <p>org/apache/CVS/Entries<br>
  607. org/apache/jakarta/tools/ant/CVS/Entries</p>
  608. <p>But not:</p>
  609. <p>org/apache/CVS/foo/bar/Entries ('foo/bar/' part does not match)</td>
  610. </tr>
  611. <tr>
  612. <td valign="top">**/test/**</td>
  613. <td valign="top">Matches all files which have a directory 'test' in their
  614. path, including 'test' as a filename.</td>
  615. </tr>
  616. </table>
  617. <p>When these patterns are used in inclusion and exclusion, you have a powerful
  618. way to select just the files you want.</p>
  619. <h3>Examples</h3>
  620. <pre> &lt;copydir src=&quot;${src}&quot;
  621. dest=&quot;${dist}&quot;
  622. includes=&quot;**/images/*&quot;
  623. excludes=&quot;**/*.gif&quot; /&gt;</pre>
  624. <p>This copies all files in directories called &quot;images&quot;, that are
  625. located in the directory tree &quot;${src}&quot; to the destination &quot;${dist}&quot;,
  626. but excludes all &quot;*.gif&quot; files from the copy.</p>
  627. <p> This example can also be expressed using nested elements as
  628. <pre> &lt;copydir src=&quot;${src}&quot;
  629. dest=&quot;${dist}&quot;&gt;
  630. &lt;include name=&quot;**/images/*&quot;/&gt;
  631. &lt;exclude name=&quot;**/*.gif&quot; /&gt;
  632. &lt;/copydir&gt;
  633. </pre>
  634. <h3>Default Excludes</h3>
  635. <p>There are a set of definitions which are excluded by default from all directory based tasks.
  636. They are:
  637. <pre> &quot;**/*~&quot;,
  638. &quot;**/#*#&quot;,
  639. &quot;**/%*%&quot;,
  640. &quot;**/CVS&quot;,
  641. &quot;**/CVS/*&quot;,
  642. &quot;**/.cvsignore&quot;
  643. </pre>
  644. If you do not want these default excludes applied, you may disable them with the
  645. <code>defaultexcludes=&quot;no&quot;</code> attribute.</p>
  646. <h3><a name="patternset">PatternSets</a></h3>
  647. <p>Patterns can be grouped to sets and later be referenced by their id
  648. attribute. They are defined via a <code>patternset</code> element -
  649. which can currently only appear nested into a <a
  650. href="#fileset">FileSet</a> or a directory based task that constitutes
  651. an implicit FileSet.</p>
  652. <p>Patterns can be specified by nested <code>&lt;include&gt;</code> or
  653. <code>&lt;exclude&gt;</code> elements or the following attributes.</p>
  654. <table border="1" cellpadding="2" cellspacing="0">
  655. <tr>
  656. <td valign="top"><b>Attribute</b></td>
  657. <td valign="top"><b>Description</b></td>
  658. </tr>
  659. <tr>
  660. <td valign="top">includes</td>
  661. <td valign="top">comma separated list of patterns of files that must be
  662. included. All files are included when omitted.</td>
  663. </tr>
  664. <tr>
  665. <td valign="top">includesfile</td>
  666. <td valign="top">the name of a file. Each line of this file is
  667. taken to be an include pattern</td>
  668. </tr>
  669. <tr>
  670. <td valign="top">excludes</td>
  671. <td valign="top">comma separated list of patterns of files that must be
  672. excluded. No files (except default excludes) are excluded when omitted.</td>
  673. </tr>
  674. <tr>
  675. <td valign="top">excludesfile</td>
  676. <td valign="top">the name of a file. Each line of this file is
  677. taken to be an exclude pattern</td>
  678. </tr>
  679. </table>
  680. <h4>Examples:</h4>
  681. <blockquote><pre>
  682. &lt;patternset id=&quot;non.test.sources&quot; &gt;
  683. &lt;include name=&quot;**/*.java&quot; /&gt;
  684. &lt;exclude name=&quot;**/*Test*&quot; /&gt;
  685. &lt;/patternset&gt;
  686. </pre></blockquote>
  687. <p>Builds a set of patterns, that matches all <code>.java</code> files
  688. that do not contain the text <code>Test</code> in their name. This set
  689. can be <a href="#references">referred</a> to via
  690. <code>&lt;patternsetref refid=&quot;non.test.sources&quot;
  691. /&gt;</code> by tasks that support this feature or by FileSets.</p>
  692. <h3><a name="fileset">FileSets</a></h3>
  693. <p>FileSets are groups of files. These files can be found in a
  694. directory tree starting in a base directory and are matched by
  695. patterns taken from a number of <a
  696. href="#patternset">PatternSets</a>. Currently FileSets can only appear
  697. inside task that support this feature.</p>
  698. <p>PatternSets can be specified as nested
  699. <code>&lt;patternset&gt;</code> or <code>&lt;patternsetref&gt;</code>
  700. elements. In addition FileSet holds an implicit PatternSet and
  701. supports the nested <code>&lt;include&gt;</code> and
  702. <code>&lt;exclude&gt;</code> elements of PatternSet directly as well
  703. as PatternSet's attributes.</p>
  704. <table border="1" cellpadding="2" cellspacing="0">
  705. <tr>
  706. <td valign="top"><b>Attribute</b></td>
  707. <td valign="top"><b>Description</b></td>
  708. <td align="center" valign="top"><b>Required</b></td>
  709. </tr>
  710. <tr>
  711. <td valign="top">dir</td>
  712. <td valign="top">The root of the directory tree of this FileSet.</td>
  713. <td valign="top" align="center">Yes</td>
  714. </tr>
  715. <tr>
  716. <td valign="top">defaultexcludes</td>
  717. <td valign="top">indicates whether default excludes should be used or not
  718. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  719. <td valign="top" align="center">No</td>
  720. </tr>
  721. <tr>
  722. <td valign="top">includes</td>
  723. <td valign="top">comma separated list of patterns of files that must be
  724. included. All files are included when omitted.</td>
  725. <td valign="top" align="center">No</td>
  726. </tr>
  727. <tr>
  728. <td valign="top">includesfile</td>
  729. <td valign="top">the name of a file. Each line of this file is
  730. taken to be an include pattern</td>
  731. <td valign="top" align="center">No</td>
  732. </tr>
  733. <tr>
  734. <td valign="top">excludes</td>
  735. <td valign="top">comma separated list of patterns of files that must be
  736. excluded. No files (except default excludes) are excluded when omitted.</td>
  737. <td valign="top" align="center">No</td>
  738. </tr>
  739. <tr>
  740. <td valign="top">excludesfile</td>
  741. <td valign="top">the name of a file. Each line of this file is
  742. taken to be an exclude pattern</td>
  743. <td valign="top" align="center">No</td>
  744. </tr>
  745. </table>
  746. <h4>Examples:</h4>
  747. <blockquote><pre>
  748. &lt;fileset dir=&quot;${server.src}&quot; &gt;
  749. &lt;patternset id=&quot;non.test.sources&quot; &gt;
  750. &lt;include name=&quot;**/*.java&quot; /&gt;
  751. &lt;exclude name=&quot;**/*Test*&quot; /&gt;
  752. &lt;/patternset&gt;
  753. &lt;/fileset&gt;
  754. </pre></blockquote>
  755. <p>Groups all files in directory <code>${server.src}</code> that are Java
  756. source files and don't have the text <code>Test</code> in their
  757. name.</p>
  758. <blockquote><pre>
  759. &lt;fileset dir=&quot;${client.src}&quot; &gt;
  760. &lt;patternsetref refid=&quot;non.test.sources&quot; /&gt;
  761. &lt;/fileset&gt;
  762. </pre></blockquote>
  763. <p>Groups all files in directory <code>${client.src}</code> using the
  764. same patterns as the example before.</p>
  765. <hr>
  766. <h2><a name="tasks">Built in tasks</a></h2>
  767. <ul>
  768. <li><a href="#ant">Ant</a></li>
  769. <li><a href="#antstructure">AntStructure</a></li>
  770. <li><a href="#available">Available</a></li>
  771. <li><a href="#chmod">Chmod</a></li>
  772. <li><a href="#copydir">Copydir</a></li>
  773. <li><a href="#copyfile">Copyfile</a></li>
  774. <li><a href="#cvs">Cvs</a></li>
  775. <li><a href="#delete">Delete</a></li>
  776. <li><a href="#deltree">Deltree</a></li>
  777. <li><a href="#echo">Echo</a></li>
  778. <li><a href="#exec">Exec</a></li>
  779. <li><a href="#exec">ExecOn</a></li>
  780. <li><a href="#filter">Filter</a></li>
  781. <li><a href="#fixcrlf">FixCRLF</a></li>
  782. <li><a href="#genkey">GenKey</a></li>
  783. <li><a href="#get">Get</a></li>
  784. <li><a href="#gunzip">GUnzip</a></li>
  785. <li><a href="#gzip">GZip</a></li>
  786. <li><a href="#jar">Jar</a></li>
  787. <li><a href="#java">Java</a></li>
  788. <li><a href="#javac">Javac</a></li>
  789. <li><a href="#javadoc">Javadoc/Javadoc2</a></li>
  790. <li><a href="#mkdir">Mkdir</a></li>
  791. <li><a href="#patch">Patch</a></li>
  792. <li><a href="#property">Property</a></li>
  793. <li><a href="#rename">Rename</a></li>
  794. <li><a href="#replace">Replace</a></li>
  795. <li><a href="#rmic">Rmic</a></li>
  796. <li><a href="#signjar">SignJar</a></li>
  797. <li><a href="#tar">Tar</a></li>
  798. <li><a href="#taskdef">Taskdef</a></li>
  799. <li><a href="#touch">Touch</a></li>
  800. <li><a href="#tstamp">Tstamp</a></li>
  801. <li><a href="sql.html">Sql</a></li>
  802. <li><a href="#style">Style</a></li>
  803. <li><a href="#unzip">Unjar</a></li>
  804. <li><a href="#untar">Untar</a></li>
  805. <li><a href="#unzip">Unzip</a></li>
  806. <li><a href="#zip">Zip</a></li>
  807. </ul>
  808. <hr>
  809. <h2><a name="ant">Ant</a></h2>
  810. <h3><b>Description:</b></h3>
  811. <p>Runs Ant on a supplied buildfile. This can be used to build subprojects.</p>
  812. <p>When the <i>antfile</i> attribute is omitted, the file &quot;build.xml&quot;
  813. in the supplied directory (<i>dir</i> attribute) is used.</p>
  814. <p>If no target attribute is supplied, the default target of the new project is
  815. used.</p>
  816. <p>The properties of the current project will be available in the new project.
  817. These properties will override the properties that are set in the new project.
  818. (See also the <a href="#property">properties task</a>). �You can set properties
  819. in the new project from the old project by using nested property tags. This
  820. allows you to parameterize your subprojects.</p>
  821. <h3>Parameters:</h3>
  822. <table border="1" cellpadding="2" cellspacing="0">
  823. <tr>
  824. <td valign="top"><b>Attribute</b></td>
  825. <td valign="top"><b>Description</b></td>
  826. <td align="center" valign="top"><b>Required</b></td>
  827. </tr>
  828. <tr>
  829. <td valign="top">antfile</td>
  830. <td valign="top">the buildfile to use.</td>
  831. <td valign="top" align="center">No</td>
  832. </tr>
  833. <tr>
  834. <td valign="top">dir</td>
  835. � �<td valign="top">the directory to use as a basedir for the new Ant project
  836. Defaults to the current directory.</td>
  837. � �<td valign="top" align="center">No</td>
  838. </tr>
  839. <tr>
  840. <td valign="top">target</td>
  841. <td valign="top">the target of the new Ant project that should be executed.</td>
  842. <td valign="top" align="center">No</td>
  843. </tr>
  844. <tr>
  845. <td valign="top">output</td>
  846. <td valign="top">Filename to write the ant output to.
  847. </td>
  848. <td align="center" valign="top">No</td>
  849. </tr>
  850. </table>
  851. <h3>Examples</h3>
  852. <pre>
  853. �&lt;ant antfile=&quot;subproject/subbuild.xml&quot; dir=&quot;subproject&quot; target=&quot;compile&quot; /&gt;
  854. �&lt;ant dir=&quot;subproject&quot; /&gt;
  855. �&lt;ant antfile=&quot;subproject/property_based_subbuild.xml&quot;&gt;
  856. � �&lt;property name=&quot;param1&quot; value=&quot;version 1.x&quot; /&gt;
  857. � �&lt;property file=&quot;config/subproject/default.properties&quot; /&gt;
  858. �&lt;/ant&gt;
  859. </pre>
  860. <hr>
  861. <h2><a name="antstructure">AntStructure</a></h2>
  862. <h3><b>Description:</b></h3>
  863. <p>Generates a DTD for Ant build files which contains information
  864. about all tasks currently known to Ant.</p>
  865. <p>Note that the DTD generated by this task is incomplete, you can
  866. always add XML entities using <a
  867. href="#taskdef"><code>&lt;taskdef&gt;</code></a>. See <a
  868. href="http://www.sdv.fr/pages/casa/html/ant-dtd.en.html">here</a> for
  869. a way to get around this problem.</p>
  870. <p>This task doesn't know about required attributes, all will be
  871. listed as <code>#IMPLIED</code>.</p>
  872. <h3>Parameters:</h3>
  873. <table border="1" cellpadding="2" cellspacing="0">
  874. <tr>
  875. <td valign="top"><b>Attribute</b></td>
  876. <td valign="top"><b>Description</b></td>
  877. <td align="center" valign="top"><b>Required</b></td>
  878. </tr>
  879. <tr>
  880. <td valign="top">output</td>
  881. <td valign="top">file to write the DTD to.</td>
  882. <td valign="top" align="center">Yes</td>
  883. </tr>
  884. </table>
  885. <h3>Examples</h3>
  886. <blockquote><pre>
  887. &lt;antstructure output=&quot;project.dtd&quot; /&gt;
  888. </pre></blockquote>
  889. <hr>
  890. <h2><a name="available">Available</a></h2>
  891. <h3>Description</h3>
  892. <p>Sets a property if a resource is available at runtime. This resource can be a
  893. file resource, a class in classpath or a JVM system resource.</p>
  894. <p>The value part of the properties being set is <i>true</i> if the resource is
  895. present, otherwise, the property is not set.</p>
  896. <p>Normally, this task is used to set properties that are useful to avoid target
  897. execution depending on system parameters.</p>
  898. <h3>Parameters</h3>
  899. <table border="1" cellpadding="2" cellspacing="0">
  900. <tr>
  901. <td valign="top"><b>Attribute</b></td>
  902. <td valign="top"><b>Description</b></td>
  903. <td align="center" valign="top"><b>Required</b></td>
  904. </tr>
  905. <tr>
  906. <td valign="top">property</td>
  907. <td valign="top">the name of the property to set.</td>
  908. <td valign="top" align="center">Yes</td>
  909. </tr>
  910. <tr>
  911. <td valign="top">classname</td>
  912. <td valign="top">the class to look for in classpath.</td>
  913. <td valign="middle" align="center" rowspan="3">Yes</td>
  914. </tr>
  915. <tr>
  916. <td valign="top">resource</td>
  917. <td valign="top">the resource to look for in the JVM</td>
  918. </tr>
  919. <tr>
  920. <td valign="top">file</td>
  921. <td valign="top">the file to look for.</td>
  922. </tr>
  923. </table>
  924. <h3>Examples</h3>
  925. <pre> &lt;available classname=&quot;org.whatever.Myclass&quot; property=&quot;Myclass.present&quot; /&gt;</pre>
  926. <p>sets the property <code><i>Myclass.present</i></code> to the value &quot;true&quot;
  927. if the <i>org.whatever.Myclass</i> is found in Ant's classpath.</p>
  928. <hr>
  929. <h2><a name="chmod">Chmod</a></h2>
  930. <h3>Description</h3>
  931. <p>Changes the permissions of a file or all files inside specified directories. Right now it has effect only under Unix.
  932. The permissions are also UNIX style, like the argument for the chmod command.</p>
  933. <p>See the section on <a href="#directorybasedtasks">directory based
  934. tasks</a>, on how the inclusion/exclusion of files works, and how to
  935. write patterns.</p>
  936. <p>This task holds an implicit <a href="#fileset">FileSet</a> and
  937. supports all of FileSet's attributes and nested elements
  938. directly. More FileSets can be specified using nested
  939. <code>&lt;fileset&gt;</code> or <code>&lt;filesetref&gt;</code>
  940. elements.</p>
  941. <h3>Parameters</h3>
  942. <table border="1" cellpadding="2" cellspacing="0">
  943. <tr>
  944. <td valign="top"><b>Attribute</b></td>
  945. <td valign="top"><b>Description</b></td>
  946. <td align="center" valign="top"><b>Required</b></td>
  947. </tr>
  948. <tr>
  949. <td valign="top">file</td>
  950. <td valign="top">the file or single directory of which the permissions
  951. must be changed.</td>
  952. <td valign="top" valign="middle" rowspan="2">exactly one of the two or nested <code>&lt;fileset&gt;</code> elements.</td>
  953. </tr>
  954. <tr>
  955. <td valign="top">dir</td>
  956. <td valign="top">the directory which holds the files whose permissions
  957. must be changed.</td>
  958. </tr>
  959. <tr>
  960. <td valign="top">perm</td>
  961. <td valign="top">the new permissions.</td>
  962. <td valign="top" align="center">Yes</td>
  963. </tr>
  964. <tr>
  965. <td valign="top">includes</td>
  966. <td valign="top">comma separated list of patterns of files that must be
  967. included. All files are included when omitted.</td>
  968. <td valign="top" align="center">No</td>
  969. </tr>
  970. <tr>
  971. <td valign="top">includesfile</td>
  972. <td valign="top">the name of a file. Each line of this file is
  973. taken to be an include pattern</td>
  974. <td valign="top" align="center">No</td>
  975. </tr>
  976. <tr>
  977. <td valign="top">excludes</td>
  978. <td valign="top">comma separated list of patterns of files that must be
  979. excluded. No files (except default excludes) are excluded when omitted.</td>
  980. <td valign="top" align="center">No</td>
  981. </tr>
  982. <tr>
  983. <td valign="top">excludesfile</td>
  984. <td valign="top">the name of a file. Each line of this file is
  985. taken to be an exclude pattern</td>
  986. <td valign="top" align="center">No</td>
  987. </tr>
  988. <tr>
  989. <td valign="top">defaultexcludes</td>
  990. <td valign="top">indicates whether default excludes should be used or not
  991. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  992. <td valign="top" align="center">No</td>
  993. </tr>
  994. <tr>
  995. <td valign="top">parallel</td>
  996. <td valign="top">process all specified files using a single
  997. <code>chmod</code> command. Defaults to true.</td>
  998. <td valign="top" align="center">No</td>
  999. </tr>
  1000. </table>
  1001. <h3>Examples</h3>
  1002. <blockquote>
  1003. <p><code>&lt;chmod file=&quot;${dist}/start.sh&quot; perm=&quot;ugo+rx&quot;
  1004. /&gt;</code></p>
  1005. </blockquote>
  1006. <p>makes the &quot;start.sh&quot; file readable and executable for anyone on a
  1007. UNIX system.</p>
  1008. <blockquote>
  1009. <pre>
  1010. &lt;chmod dir=&quot;${dist}/bin&quot; perm=&quot;ugo+rx&quot; includes="**/*.sh" /&gt;
  1011. </pre>
  1012. </blockquote>
  1013. <p>makes all &quot;.sh&quot; files below <code>${dist}/bin</code>
  1014. readable and executable for anyone on a UNIX system.</p>
  1015. <blockquote>
  1016. <pre>
  1017. &lt;chmod perm=&quot;g+w&quot; /&gt;
  1018. &lt;fileset dir=&quot;shared/sources1&quot; &gt;
  1019. &lt;exclude name=&quot;**/trial/**&quot; /&gt;
  1020. &lt;/fileset&gt;
  1021. &lt;filesetref refid=&quot;other.shared.sources&quot; /&gt;
  1022. &lt;/chmod&gt;
  1023. </pre>
  1024. </blockquote>
  1025. <p>makes all files below <code>shared/sources1</code> (except those
  1026. below any directory named trial) writable for members of the same
  1027. group on a UNIX system. In addition all files belonging to a FileSet
  1028. with <code>id</code> <code>other.shared.sources</code> get the same
  1029. permissions.</p>
  1030. <hr>
  1031. <h2><a name="copydir">Copydir</a></h2>
  1032. <h3>Description</h3>
  1033. <p>Copies a directory tree from the source to the destination.</p>
  1034. <p>It is possible to refine the set of files that are being copied. This can be
  1035. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  1036. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  1037. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  1038. the files you want to have excluded. This is also done with patterns. And
  1039. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  1040. want to use default exclusions or not. See the section on <a
  1041. href="#directorybasedtasks">directory based tasks</a>, on how the
  1042. inclusion/exclusion of files works, and how to write patterns.</p>
  1043. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  1044. supports all attributes of <code>&lt;fileset&gt;</code>
  1045. (<code>dir</code> becomes <code>src</code>) as well as the nested
  1046. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  1047. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  1048. elements.</p>
  1049. <h3>Parameters</h3>
  1050. <table border="1" cellpadding="2" cellspacing="0">
  1051. <tr>
  1052. <td valign="top"><b>Attribute</b></td>
  1053. <td valign="top"><b>Description</b></td>
  1054. <td align="center" valign="top"><b>Required</b></td>
  1055. </tr>
  1056. <tr>
  1057. <td valign="top">src</td>
  1058. <td valign="top">the directory to copy.</td>
  1059. <td valign="top" align="center">Yes</td>
  1060. </tr>
  1061. <tr>
  1062. <td valign="top">dest</td>
  1063. <td valign="top">the directory to copy to.</td>
  1064. <td valign="top" align="center">Yes</td>
  1065. </tr>
  1066. <tr>
  1067. <td valign="top">includes</td>
  1068. <td valign="top">comma separated list of patterns of files that must be
  1069. included. All files are included when omitted.</td>
  1070. <td valign="top" align="center">No</td>
  1071. </tr>
  1072. <tr>
  1073. <td valign="top">includesfile</td>
  1074. <td valign="top">the name of a file. Each line of this file is
  1075. taken to be an include pattern</td>
  1076. <td valign="top" align="center">No</td>
  1077. </tr>
  1078. <tr>
  1079. <td valign="top">excludes</td>
  1080. <td valign="top">comma separated list of patterns of files that must be
  1081. excluded. No files (except default excludes) are excluded when omitted.</td>
  1082. <td valign="top" align="center">No</td>
  1083. </tr>
  1084. <tr>
  1085. <td valign="top">excludesfile</td>
  1086. <td valign="top">the name of a file. Each line of this file is
  1087. taken to be an exclude pattern</td>
  1088. <td valign="top" align="center">No</td>
  1089. </tr>
  1090. <tr>
  1091. <td valign="top">defaultexcludes</td>
  1092. <td valign="top">indicates whether default excludes should be used or not
  1093. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  1094. <td valign="top" align="center">No</td>
  1095. </tr>
  1096. <tr>
  1097. <td valign="top">filtering</td>
  1098. <td valign="top">indicates whether token filtering should take place during
  1099. the copy</td>
  1100. <td valign="top" align="center">No</td>
  1101. </tr>
  1102. <tr>
  1103. <td valign="top">flatten</td>
  1104. <td valign="top">ignore directory structure of source directory,
  1105. copy all files into a single directory - specified by the dest
  1106. attribute (default is false).</td>
  1107. <td valign="top" align="center">No</td>
  1108. </tr>
  1109. <tr>
  1110. <td valign="top">forceoverwrite</td>
  1111. <td valign="top">overwrite existing files even if the destination
  1112. files are newer (default is false).</td>
  1113. <td valign="top" align="center">No</td>
  1114. </tr>
  1115. </table>
  1116. <h3>Examples</h3>
  1117. <pre> &lt;copydir src=&quot;${src}/resources&quot;
  1118. dest=&quot;${dist}&quot;
  1119. /&gt;</pre>
  1120. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>.</p>
  1121. <pre> &lt;copydir src=&quot;${src}/resources&quot;
  1122. dest=&quot;${dist}&quot;
  1123. includes=&quot;**/*.java&quot;
  1124. excludes=&quot;**/Test.java&quot;
  1125. /&gt;</pre>
  1126. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>
  1127. recursively. All java files are copied, except for files with the name <code>Test.java</code>.</p>
  1128. <pre> &lt;copydir src=&quot;${src}/resources&quot;
  1129. dest=&quot;${dist}&quot;
  1130. includes=&quot;**/*.java&quot;
  1131. excludes=&quot;mypackage/test/**&quot; /&gt;</pre>
  1132. <p>copies the directory <code>${src}/resources</code> to <code>${dist}</code>
  1133. recursively. All java files are copied, except for the files under the <code>mypackage/test</code>
  1134. directory.</p>
  1135. <hr>
  1136. <h2><a name="copyfile">Copyfile</a></h2>
  1137. <h3>Description</h3>
  1138. <p>Copies a file from the source to the destination. The file is only copied if
  1139. the source file is newer than the destination file, or when the destination file
  1140. does not exist.</p>
  1141. <h3>Parameters</h3>
  1142. <table border="1" cellpadding="2" cellspacing="0">
  1143. <tr>
  1144. <td valign="top"><b>Attribute</b></td>
  1145. <td valign="top"><b>Description</b></td>
  1146. <td align="center" valign="top"><b>Required</b></td>
  1147. </tr>
  1148. <tr>
  1149. <td valign="top">src</td>
  1150. <td valign="top">the filename of the file to copy.</td>
  1151. <td valign="top" align="center">Yes</td>
  1152. </tr>
  1153. <tr>
  1154. <td valign="top">dest</td>
  1155. <td valign="top">the filename of the file where to copy to.</td>
  1156. <td valign="top" align="center">Yes</td>
  1157. </tr>
  1158. <tr>
  1159. <td valign="top">filtering</td>
  1160. <td valign="top">indicates whether token filtering should take place during
  1161. the copy</td>
  1162. <td valign="top" align="center">No</td>
  1163. </tr>
  1164. <tr>
  1165. <td valign="top">forceoverwrite</td>
  1166. <td valign="top">overwrite existing files even if the destination
  1167. files are newer (default is false).</td>
  1168. <td valign="top" align="center">No</td>
  1169. </tr>
  1170. </table>
  1171. <h3>Examples</h3>
  1172. <blockquote>
  1173. <p><code>&lt;copyfile src=&quot;test.java&quot; dest=&quot;subdir/test.java&quot;
  1174. /&gt;</code></p>
  1175. <p><code>&lt;copyfile src=&quot;${src}/index.html&quot; dest=&quot;${dist}/help/index.html&quot;
  1176. /&gt;</code></p>
  1177. </blockquote>
  1178. <hr>
  1179. <h2><a name="cvs">Cvs</a></h2>
  1180. <h3>Description</h3>
  1181. <p>Handles packages/modules retrieved from a
  1182. <a href="http://www.cyclic.com/">CVS</a> repository.</p>
  1183. <p>When doing automated builds, the <a href="#get">get task</a> should be
  1184. preferred over the <i>checkout</i> command, because of speed.</p>
  1185. <h3>Parameters</h3>
  1186. <table border="1" cellpadding="2" cellspacing="0">
  1187. <tr>
  1188. <td valign="top"><b>Attribute</b></td>
  1189. <td valign="top"><b>Description</b></td>
  1190. <td align="center" valign="top"><b>Required</b></td>
  1191. </tr>
  1192. <tr>
  1193. <td valign="top">command</td>
  1194. <td valign="top">the CVS command to execute.</td>
  1195. <td align="center" valign="top">No, default &quot;checkout&quot;</td>
  1196. </tr>
  1197. <tr>
  1198. <td valign="top">cvsRoot</td>
  1199. <td valign="top">the CVSROOT variable.</td>
  1200. <td align="center" valign="top">No</td>
  1201. </tr>
  1202. <tr>
  1203. <td valign="top">dest</td>
  1204. <td valign="top">the directory where the checked out files should be placed.</td>
  1205. <td align="center" valign="top">No, default is project's basedir.</td>
  1206. </tr>
  1207. <tr>
  1208. <td valign="top">package</td>
  1209. <td valign="top">the package/module to check out.</td>
  1210. <td align="center" valign="top">No</td>
  1211. </tr>
  1212. <tr>
  1213. <td valign="top">tag</td>
  1214. <td valign="top">the tag of the package/module to check out.</td>
  1215. <td align="center" valign="top">No</td>
  1216. </tr>
  1217. <tr>
  1218. <td valign="top">date</td>
  1219. <td valign="top">Use the most recent revision no later than the given date</td>
  1220. <td align="center" valign="top">No</td>
  1221. </tr>
  1222. <tr>
  1223. <td valign="top">quiet</td>
  1224. <td valign="top">suppress informational messages.</td>
  1225. <td align="center" valign="top">No, default &quot;false&quot;</td>
  1226. </tr>
  1227. <tr>
  1228. <td valign="top">noexec</td>
  1229. <td valign="top">report only, don't change any files.</td>
  1230. <td align="center" valign="top">No, default &quot;false&quot;</td>
  1231. </tr>
  1232. </table>
  1233. <h3>Examples</h3>
  1234. <pre> &lt;cvs cvsRoot=&quot;:pserver:anoncvs@jakarta.apache.org:/home/cvspublic&quot;
  1235. package=&quot;jakarta-tools&quot;
  1236. dest=&quot;${ws.dir}&quot;
  1237. /&gt;</pre>
  1238. <p>checks out the package/module &quot;jakarta-tools&quot; from the CVS
  1239. repository pointed to by the cvsRoot attribute, and stores the files in &quot;${ws.dir}&quot;.</p>
  1240. <pre> &lt;cvs dest=&quot;${ws.dir}&quot; command=&quot;update&quot; /&gt;</pre>
  1241. <p>updates the package/module that has previously been checked out into
  1242. &quot;${ws.dir}&quot;.</p>
  1243. <hr>
  1244. <h2><a name="delete">Delete</a></h2>
  1245. <h3>Description</h3>
  1246. <p>Deletes either a single file or
  1247. all files in a specified directory and its sub-directories.</p>
  1248. <p>It is possible to refine the set of files that are being deleted. This can be
  1249. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  1250. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  1251. have included in the deletion process by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  1252. the files you want to have excluded from the deletion process. This is also done with patterns. And
  1253. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  1254. want to use default exclusions or not. See the section on <a
  1255. href="#directorybasedtasks">directory based tasks</a>, on how the
  1256. inclusion/exclusion of files works, and how to write patterns.</p>
  1257. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  1258. supports all attributes of <code>&lt;fileset&gt;</code> as well as the
  1259. nested <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  1260. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  1261. elements.</p>
  1262. <h3>Parameters</h3>
  1263. <table border="1" cellpadding="2" cellspacing="0">
  1264. <tr>
  1265. <td valign="top"><b>Attribute</b></td>
  1266. <td valign="top"><b>Description</b></td>
  1267. <td align="center" valign="top"><b>Required</b></td>
  1268. </tr>
  1269. <tr>
  1270. <td valign="top">file</td>
  1271. <td valign="top">The file to delete.</td>
  1272. <td align="center" valign="middle" rowspan="2">at least one of the two</td>
  1273. </tr>
  1274. <tr>
  1275. <td valign="top">dir</td>
  1276. <td valign="top">The directory to delete files from.</td>
  1277. </tr>
  1278. <tr>
  1279. <td valign="top">includes</td>
  1280. <td valign="top">Comma separated list of patterns of files that must be
  1281. deleted. All files are in the current directory
  1282. and any sub-directories are deleted when omitted.</td>
  1283. <td valign="top" align="center">No</td>
  1284. </tr>
  1285. <tr>
  1286. <td valign="top">includesfile</td>
  1287. <td valign="top">the name of a file. Each line of this file is
  1288. taken to be an include pattern</td>
  1289. <td valign="top" align="center">No</td>
  1290. </tr>
  1291. <tr>
  1292. <td valign="top">excludes</td>
  1293. <td valign="top">Comma separated list of patterns of files that must be
  1294. excluded from the deletion list. No files (except default excludes) are excluded when omitted.</td>
  1295. <td valign="top" align="center">No</td>
  1296. </tr>
  1297. <tr>
  1298. <td valign="top">excludesfile</td>
  1299. <td valign="top">the name of a file. Each line of this file is
  1300. taken to be an exclude pattern</td>
  1301. <td valign="top" align="center">No</td>
  1302. </tr>
  1303. <tr>
  1304. <td valign="top">defaultexcludes</td>
  1305. <td valign="top">Indicates whether default excludes should be used or not
  1306. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  1307. <td valign="top" align="center">No</td>
  1308. </tr>
  1309. <tr>
  1310. <td valign="top">verbose</td>
  1311. <td valign="top">Show name of each deleted file (&quot;true&quot;/&quot;false&quot;). Default is "false" when omitted.</td>
  1312. <td align="center" valign="top">No</td>
  1313. </tr>
  1314. </table>
  1315. <h3>Examples</h3>
  1316. <pre> &lt;delete file=&quot;/lib/ant.jar&quot; /&gt;</pre>
  1317. <p>deletes the file <code>/lib/ant.jar</code>.</p>
  1318. <pre> &lt;delete dir=&quot;lib&quot; /&gt;</pre>
  1319. <p>deletes all files in the <code>/lib</code> directory.</p>
  1320. <pre> &lt;delete dir=&quot;.&quot;
  1321. includes=&quot;**/*.bak&quot;
  1322. /&gt;
  1323. </pre>
  1324. <p>deletes all files with the extension &quot;<code>.bak</code>&quot from the current directory
  1325. and any sub-directories.</p>
  1326. <hr>
  1327. <h2><a name="deltree">Deltree</a></h2>
  1328. <h3>Description</h3>
  1329. <p>Deletes a directory with all its files and subdirectories.</p>
  1330. <h3>Parameters</h3>
  1331. <table border="1" cellpadding="2" cellspacing="0">
  1332. <tr>
  1333. <td valign="top"><b>Attribute</b></td>
  1334. <td valign="top"><b>Description</b></td>
  1335. <td align="center" valign="top"><b>Required</b></td>
  1336. </tr>
  1337. <tr>
  1338. <td valign="top">dir</td>
  1339. <td valign="top">the directory to delete.</td>
  1340. <td valign="top" align="center">Yes</td>
  1341. </tr>
  1342. </table>
  1343. <h3>Examples</h3>
  1344. <pre> &lt;deltree dir=&quot;dist&quot; /&gt;</pre>
  1345. <p>deletes the directory <code>dist</code>, including its files and
  1346. subdirectories.</p>
  1347. <pre> &lt;deltree dir=&quot;${dist}&quot; /&gt;</pre>
  1348. <p>deletes the directory <code>${dist}</code>, including its files and
  1349. subdirectories.</p>
  1350. <hr>
  1351. <h2><a name="echo">Echo</a></h2>
  1352. <h3>Description</h3>
  1353. <p>Echoes a message to System.out.</p>
  1354. <h3>Parameters</h3>
  1355. <table border="1" cellpadding="2" cellspacing="0">
  1356. <tr>
  1357. <td valign="top"><b>Attribute</b></td>
  1358. <td valign="top"><b>Description</b></td>
  1359. <td align="center" valign="top"><b>Required</b></td>
  1360. </tr>
  1361. <tr>
  1362. <td valign="top">message</td>
  1363. <td valign="top">the message to echo.</td>
  1364. <td valign="top" align="center">Yes</td>
  1365. </tr>
  1366. </table>
  1367. <h3>Examples</h3>
  1368. <pre> &lt;echo message=&quot;Hello world&quot; /&gt;</pre>
  1369. <hr>
  1370. <h2><a name="exec">Exec</a></h2>
  1371. <h3>Description</h3>
  1372. <p>Executes a system command. When the <i>os</i> attribute is specified, then
  1373. the command is only executed when Ant is run on one of the specified operating
  1374. systems.</p>
  1375. <h3>Parameters</h3>
  1376. <table border="1" cellpadding="2" cellspacing="0">
  1377. <tr>
  1378. <td valign="top"><b>Attribute</b></td>
  1379. <td valign="top"><b>Description</b></td>
  1380. <td align="center" valign="top"><b>Required</b></td>
  1381. </tr>
  1382. <tr>
  1383. <td valign="top">command</td>
  1384. <td valign="top">the command to execute with all command line
  1385. arguments. <b>deprecated, use executable and nested
  1386. <code>&lt;arg&gt;</code> elements instead</b>.</td>
  1387. <td align="center" rowspan="2">Exactly one of the two.</td>
  1388. </tr>
  1389. <tr>
  1390. <td valign="top">executable</td>
  1391. <td valign="top">the command to execute without any command line
  1392. arguments.</b></td>
  1393. </tr>
  1394. <tr>
  1395. <td valign="top">dir</td>
  1396. <td valign="top">the directory in which the command should be executed.</td>
  1397. <td align="center" valign="top">No</td>
  1398. </tr>
  1399. <tr>
  1400. <td valign="top">os</td>
  1401. <td valign="top">list of Operating Systems on which the command may be
  1402. executed.</td>
  1403. <td align="center" valign="top">No</td>
  1404. </tr>
  1405. <tr>
  1406. <td valign="top">output</td>
  1407. <td valign="top">the file to which the output of the command should be
  1408. redirected.</td>
  1409. <td align="center" valign="top">No</td>
  1410. </tr>
  1411. <tr>
  1412. <td valign="top">timeout</td>
  1413. <td valign="top">Stop the command if it doesn't finish within the
  1414. specified time (given in milliseconds).</td>
  1415. <td align="center" valign="top">No</td>
  1416. </tr>
  1417. <tr>
  1418. <td valign="top">failonerror</td>
  1419. <td valign="top">Stop the buildprocess if the command exits with a
  1420. returncode other than 0.</td>
  1421. <td align="center" valign="top">No</td>
  1422. </tr>
  1423. </table>
  1424. <h3>Examples</h3>
  1425. <blockquote>
  1426. <p><code>&lt;exec dir=&quot;${src}&quot; executable=&quot;dir&quot; os=&quot;windows&quot;
  1427. output=&quot;dir.txt&quot; /&gt;</code></p>
  1428. </blockquote>
  1429. <h3>Parameters specified as nested elements</h3>
  1430. <h4>arg</h4>
  1431. <p>Command line arguments should be specified as nested
  1432. <code>&lt;arg&gt;</code> elements. See <a
  1433. href="index.html#arg">Command line arguments</a>.</p>
  1434. <h4><a name="env">env</a></h4>
  1435. <p>It is possible to specify environment variables to pass to the
  1436. system command via nested <code>&lt;env&gt;</code> elements.</p>
  1437. <p>Please note that the environment of the current Ant process is
  1438. <b>not</b> passed to the system command if you specify variables using
  1439. <code>&lt;env&gt;</code>.</p>
  1440. <table border="1" cellpadding="2" cellspacing="0">
  1441. <tr>
  1442. <td valign="top"><b>Attribute</b></td>
  1443. <td valign="top"><b>Description</b></td>
  1444. <td align="center" valign="top"><b>Required</b></td>
  1445. </tr>
  1446. <tr>
  1447. <td valign="top">key</td>
  1448. <td valign="top">The name of the environment variable.</td>
  1449. <td align="center" valign="top">Yes</td>
  1450. </tr>
  1451. <tr>
  1452. <td valign="top">value</td>
  1453. <td valign="top">The literal value for the environment variable.</td>
  1454. <td align="center" rowspan="3">Exactly one of these.</td>
  1455. </tr>
  1456. <tr>
  1457. <td valign="top">path</td>
  1458. <td valign="top">The value for a PATH like environment
  1459. variable. You can use ; or : as path separators and Ant will
  1460. convert it to the platform's local conventions.</td>
  1461. </tr>
  1462. <tr>
  1463. <td valign="top">file</td>
  1464. <td valign="top">The value for the environment variable. Will be
  1465. replaced by the absolute filename of the file by Ant.</td>
  1466. </tr>
  1467. </table>
  1468. <h5>Examples</h5>
  1469. <blockquote><pre>
  1470. &lt;exec executable="emacs" &gt;
  1471. &lt;env key=&quot;DISPLAY&quot; value=&quot;:1.0&quot; /&gt;
  1472. &lt;/exec&gt;
  1473. </pre></blockquote>
  1474. <p>starts <code>emacs</code> on display 1 of the X Window System.</p>
  1475. <blockquote><pre>
  1476. &lt;exec ... &gt;
  1477. &lt;env key=&quot;PATH&quot; path=&quot;${java.library.path}:${basedir}/bin&quot; /&gt;
  1478. &lt;/exec&gt;
  1479. </pre></blockquote>
  1480. <p>adds <code>${basedir}/bin</code> to the <code>PATH</code> of the
  1481. system command.</p>
  1482. <hr>
  1483. <h2><a name="exec">ExecOn</a></h2>
  1484. <h3>Description</h3>
  1485. <p>Executes a system command. When the <i>os</i> attribute is specified, then
  1486. the command is only executed when Ant is run on one of the specified operating
  1487. systems.</p>
  1488. <p>The files of a number of <a href="#fileset">FileSet</a>s are passed
  1489. as arguments to the system command. At least one nested
  1490. <code>&lt;fileset&gt;</code> or <code>&lt;filesetref&gt;</code> is
  1491. required.</p>
  1492. <h3>Parameters</h3>
  1493. <table border="1" cellpadding="2" cellspacing="0">
  1494. <tr>
  1495. <td valign="top"><b>Attribute</b></td>
  1496. <td valign="top"><b>Description</b></td>
  1497. <td align="center" valign="top"><b>Required</b></td>
  1498. </tr>
  1499. <tr>
  1500. <td valign="top">executable</td>
  1501. <td valign="top">the command to execute without any command line
  1502. arguments.</b></td>
  1503. <td align="center" valign="top">Yes</td>
  1504. </tr>
  1505. <tr>
  1506. <td valign="top">dir</td>
  1507. <td valign="top">the directory in which the command should be executed.</td>
  1508. <td align="center" valign="top">No</td>
  1509. </tr>
  1510. <tr>
  1511. <td valign="top">os</td>
  1512. <td valign="top">list of Operating Systems on which the command may be
  1513. executed.</td>
  1514. <td align="center" valign="top">No</td>
  1515. </tr>
  1516. <tr>
  1517. <td valign="top">output</td>
  1518. <td valign="top">the file to which the output of the command should be
  1519. redirected.</td>
  1520. <td align="center" valign="top">No</td>
  1521. </tr>
  1522. <tr>
  1523. <td valign="top">timeout</td>
  1524. <td valign="top">Stop the command if it doesn't finish within the
  1525. specified time (given in milliseconds).</td>
  1526. <td align="center" valign="top">No</td>
  1527. </tr>
  1528. <tr>
  1529. <td valign="top">failonerror</td>
  1530. <td valign="top">Stop the buildprocess if the command exits with a
  1531. returncode other than 0.</td>
  1532. <td align="center" valign="top">No</td>
  1533. </tr>
  1534. <tr>
  1535. <td valign="top">parallel</td>
  1536. <td valign="top">Run the command only once, appending all files as
  1537. arguments. Defaults to true. If false, command will be executed
  1538. once for every file.</td>
  1539. <td align="center" valign="top">No</td>
  1540. </tr>
  1541. </table>
  1542. <h3>Parameters specified as nested elements</h3>
  1543. <h4>fileset and filesetref</h4>
  1544. <p>You can use any number of nested <code>&lt;fileset&gt;</code>
  1545. elements to define the files for this task and refer to
  1546. <code>&lt;fileset&gt;</code>s defined elsewhere via
  1547. <code>&lt;filesetref&gt;</code> elements.</p>
  1548. <h4>arg</h4>
  1549. <p>Command line arguments should be specified as nested
  1550. <code>&lt;arg&gt;</code> elements. See <a
  1551. href="index.html#arg">Command line arguments</a>.</p>
  1552. <h4>env</h4>
  1553. <p>It is possible to specify environment variables to pass to the
  1554. system command via nested <code>&lt;env&gt;</code> elements. See the
  1555. description in the section about <a href="#env">exec</a></p>
  1556. <p>Please note that the environment of the current Ant process is
  1557. <b>not</b> passed to the system command if you specify variables using
  1558. <code>&lt;env&gt;</code>.</p>
  1559. <h3>Examples</h3>
  1560. <blockquote><pre>
  1561. &lt;execon executable=&quot;ls&quot; &gt;
  1562. &lt;arg value=&quot;-l&quot; /&gt;
  1563. &lt;fileset dir=&quot;/tmp&quot;&gt;
  1564. &lt;patternset&gt;
  1565. &lt;exclude name=&quot;**/*.txt&quot; /&gt;
  1566. &lt;/patternset&gt;
  1567. &lt;/fileset&gt;
  1568. &lt;filesetref refid=&quot;other.files&quot; /&gt;
  1569. &lt;/execon&gt;
  1570. </pre></blockquote>
  1571. <p>invokes <code>ls -l</code>, adding the absolute filenames of all
  1572. files below <code>/tmp</code> not ending in <code>.txt</code> and all
  1573. files of the FileSet with <code>id</code> <code>other.files</code> to
  1574. the command line.</p>
  1575. <hr>
  1576. <h2><a name="filter">Filter</a></h2>
  1577. <h3>Description</h3>
  1578. <p>Sets a token filter for this project. Token filters are used by all tasks
  1579. that perform file copying operations through the Project commodity methods.</p>
  1580. <p>Note: the token string must not contain the separators chars (@).</p>
  1581. <h3>Parameters</h3>
  1582. <table border="1" cellpadding="2" cellspacing="0">
  1583. <tr>
  1584. <td valign="top"><b>Attribute</b></td>
  1585. <td valign="top"><b>Description</b></td>
  1586. <td align="center" valign="top"><b>Required</b></td>
  1587. </tr>
  1588. <tr>
  1589. <td valign="top">token</td>
  1590. <td valign="top">the token string without @</td>
  1591. <td align="center" valign="top">Yes</td>
  1592. </tr>
  1593. <tr>
  1594. <td valign="top">value</td>
  1595. <td valign="top">the string that should be put to replace the token when the
  1596. file is copied</td>
  1597. <td align="center" valign="top">Yes</td>
  1598. </tr>
  1599. </table>
  1600. <h3>Examples</h3>
  1601. <pre> &lt;filter token=&quot;year&quot; value=&quot;2000&quot; /&gt;
  1602. &lt;copydir src=&quot;${src.dir}&quot; dest=&quot;${dest.dir}&quot;/&gt;</pre>
  1603. <p>will copy recursively all the files from the <i>src.dir</i> directory into
  1604. the <i>dest.dir</i> directory replacing all the occurencies of the string <i>@year@</i>
  1605. with <i>2000.</i></p>
  1606. <hr>
  1607. <h2><a name="fixcrlf">FixCRLF</a></h2>
  1608. <h3>Description</h3>
  1609. <p>Adjusts a text file to local.</p>
  1610. <p>It is possible to refine the set of files that are being adjusted. This can be
  1611. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  1612. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  1613. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  1614. the files you want to have excluded. This is also done with patterns. And
  1615. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  1616. want to use default exclusions or not. See the section on <a
  1617. href="#directorybasedtasks">directory based tasks</a>, on how the
  1618. inclusion/exclusion of files works, and how to write patterns.</p>
  1619. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  1620. supports all attributes of <code>&lt;fileset&gt;</code>
  1621. (<code>dir</code> becomes <code>srcdir</code>) as well as the nested
  1622. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  1623. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  1624. elements.</p>
  1625. <h3>Parameters</h3>
  1626. <table border="1" cellpadding="2" cellspacing="0">
  1627. <tr>
  1628. <td valign="top"><b>Attribute</b></td>
  1629. <td valign="top"><b>Description</b></td>
  1630. <td align="center" valign="top"><b>Required</b></td>
  1631. </tr>
  1632. <tr>
  1633. <td valign="top">srcDir</td>
  1634. <td valign="top">Where to find the files to be fixed up.</td>
  1635. <td valign="top" align="center">Yes</td>
  1636. </tr>
  1637. <tr>
  1638. <td valign="top">destDir</td>
  1639. <td valign="top">Where to place the corrected files. Defaults to
  1640. srcDir (replacing the original file)</td>
  1641. <td valign="top" align="center">No</td>
  1642. </tr>
  1643. <tr>
  1644. <td valign="top">includes</td>
  1645. <td valign="top">comma separated list of patterns of files that must be
  1646. included. All files are included when omitted.</td>
  1647. <td valign="top" align="center">No</td>
  1648. </tr>
  1649. <tr>
  1650. <td valign="top">includesfile</td>
  1651. <td valign="top">the name of a file. Each line of this file is
  1652. taken to be an include pattern</td>
  1653. <td valign="top" align="center">No</td>
  1654. </tr>
  1655. <tr>
  1656. <td valign="top">excludes</td>
  1657. <td valign="top">comma separated list of patterns of files that must be
  1658. excluded. No files (except default excludes) are excluded when omitted.</td>
  1659. <td valign="top" align="center">No</td>
  1660. </tr>
  1661. <tr>
  1662. <td valign="top">excludesfile</td>
  1663. <td valign="top">the name of a file. Each line of this file is
  1664. taken to be an exclude pattern</td>
  1665. <td valign="top" align="center">No</td>
  1666. </tr>
  1667. <tr>
  1668. <td valign="top">defaultexcludes</td>
  1669. <td valign="top">indicates whether default excludes should be used or not
  1670. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  1671. <td valign="top" align="center">No</td>
  1672. </tr>
  1673. <tr>
  1674. <td valign="top">cr</td>
  1675. <td valign="top">Specifies how carriage return (CR) characters are to
  1676. be handled. Valid values for this property are:
  1677. <ul>
  1678. <li>add: ensure that there is a CR before every LF
  1679. <li>asis: leave CR characters alone
  1680. <li>remove: remove all CR characters
  1681. </ul>
  1682. Default is based on the platform on which you are running this task.
  1683. For Unix platforms, the default is remove. For DOS based systems
  1684. (including Windows), the default is add.
  1685. <p>
  1686. Note: Unless this property is specified as "asis", extra CR characters
  1687. which do not precede a LF will be removed.
  1688. </td>
  1689. <td valign="top" align="center">No</td>
  1690. </tr>
  1691. <tr>
  1692. <td valign="top">tab</td>
  1693. <td valign="top">Specifies how tab characters are to be handled. Valid
  1694. values for this property are:
  1695. <ul>
  1696. <li>add: convert sequences of spaces which span a tab stop to tabs
  1697. <li>asis: leave tab and space characters alone
  1698. <li>remove: convert tabs to spaces
  1699. </ul>
  1700. Default for this parameter is "asis".
  1701. <p>
  1702. Note: Unless this property is specified as "asis", extra spaces and
  1703. tabs after the last non-whitespace character on the line will be removed.
  1704. </td>
  1705. <td valign="top" align="center">No</td>
  1706. </tr>
  1707. <tr>
  1708. <td valign="top">tablength</td>
  1709. <td valign="top">The number of characters a TAB stop corresponds to.
  1710. Must be a positive power of 2, default for this parameter is 8.</td>
  1711. <td valign="top" align="center">No</td>
  1712. </tr>
  1713. <tr>
  1714. <td valign="top">eof</td>
  1715. <td valign="top">Specifies how DOS end of file (control-Z) characters are
  1716. to be handled. Valid values for this property are:
  1717. <ul>
  1718. <li>add: ensure that there is an EOF character at the end of the file
  1719. <li>asis: leave EOF characters alone
  1720. <li>remove: remove any EOF character found at the end
  1721. </ul>
  1722. Default is based on the platform on which you are running this task.
  1723. For Unix platforms, the default is remove. For DOS based systems
  1724. (including Windows), the default is asis.
  1725. </td>
  1726. <td valign="top" align="center">No</td>
  1727. </tr>
  1728. </table>
  1729. <h3>Examples</h3>
  1730. <pre> &lt;fixcrlf srcdir=&quot;${src}&quot;
  1731. cr=&quot;remove&quot; eof=&quot;remove&quot;
  1732. includes=&quot;**/*.sh&quot;
  1733. /&gt;</pre>
  1734. <p>Removes carriage return and eof characters from the shell scripts. Tabs and
  1735. spaces are left as is.
  1736. <pre> &lt;fixcrlf srcdir=&quot;${src}&quot;
  1737. cr=&quot;add&quot;
  1738. includes=&quot;**/*.bat&quot;
  1739. /&gt;</pre>
  1740. <p>Ensures that there are carriage return characters prior to evey line feed.
  1741. Tabs and spaces are left as is.
  1742. EOF characters are left alone if run on
  1743. DOS systems, and are removed if run on Unix systems.</p>
  1744. <pre> &lt;fixcrlf srcdir=&quot;${src}&quot;
  1745. tabs=&quot;add&quot;
  1746. includes=&quot;**/Makefile&quot;
  1747. /&gt;</pre>
  1748. <p>Adds or removes CR characters to match local OS conventions, and
  1749. converts spaces to tabs when appropriate. EOF characters are left alone if
  1750. run on DOS systems, and are removed if run on Unix systems.
  1751. Many versions of make require tabs prior to commands.</p>
  1752. <pre> &lt;fixcrlf srcdir=&quot;${src}&quot;
  1753. tabs=&quot;remove&quot;
  1754. includes=&quot;**/README*&quot;
  1755. /&gt;</pre>
  1756. <p>Adds or removes CR characters to match local OS conventions, and
  1757. converts all tabs to spaces. EOF characters are left alone if run on
  1758. DOS systems, and are removed if run on Unix systems.
  1759. You never know what editor a user will use to browse README's.</p>
  1760. <hr>
  1761. <h2><a name="genkey">GenKey</a></h2>
  1762. <h3>Description</h3>
  1763. <p>Generates a key in keystore.</p>
  1764. <h3>Parameters</h3>
  1765. <table border="1" cellpadding="2" cellspacing="0">
  1766. <tr>
  1767. <td valign="top"><b>Attribute</b></td>
  1768. <td valign="top"><b>Description</b></td>
  1769. <td align="center" valign="top"><b>Required</b></td>
  1770. </tr>
  1771. <tr>
  1772. <td valign="top">alias</td>
  1773. <td valign="top">the alias to add under</td>
  1774. <td valign="top" align="center">Yes.</td>
  1775. </tr>
  1776. <tr>
  1777. <td valign="top">storepass</td>
  1778. <td valign="top">password for keystore integrity.</td>
  1779. <td valign="top" align="center">Yes.</td>
  1780. </tr>
  1781. <tr>
  1782. <td valign="top">keystore</td>
  1783. <td valign="top">keystore location</td>
  1784. <td valign="top" align="center">No</td>
  1785. </tr>
  1786. <tr>
  1787. <td valign="top">storetype</td>
  1788. <td valign="top">keystore type</td>
  1789. <td valign="top" align="center">No</td>
  1790. </tr>
  1791. <tr>
  1792. <td valign="top">keypass</td>
  1793. <td valign="top">password for private key (if different)</td>
  1794. <td valign="top" align="center">No</td>
  1795. </tr>
  1796. <tr>
  1797. <td valign="top">sigalg</td>
  1798. <td valign="top">the algorithm to use in signing</td>
  1799. <td valign="top" align="center">No</td>
  1800. </tr>
  1801. <tr>
  1802. <td valign="top">keyalg</td>
  1803. <td valign="top">the method to use when generating name-value pair</td>
  1804. <td valign="top" align="center">No</td>
  1805. </tr>
  1806. <tr>
  1807. <td valign="top">verbose</td>
  1808. <td valign="top">(true | false) verbose output when signing</td>
  1809. <td valign="top" align="center">No</td>
  1810. </tr>
  1811. <tr>
  1812. <td valign="top">dname</td>
  1813. <td valign="top">The distinguished name for entity</td>
  1814. <td valign="top" align="center">Yes if dname element unspecified</td>
  1815. </tr>
  1816. <tr>
  1817. <td valign="top">validity</td>
  1818. <td valign="top">(integer) indicates how many days certificate is valid</td>
  1819. <td valign="top" align="center">No</td>
  1820. </tr>
  1821. <tr>
  1822. <td valign="top">keysize</td>
  1823. <td valign="top">(integer) indicates the size of key generated</td>
  1824. <td valign="top" align="center">No</td>
  1825. </tr>
  1826. </table>
  1827. <p>Alternatively you can specify the distinguished name by creating a sub-element named dname and populating it with param elements that have a name and a value. When using the subelement it is automatically encoded properly and , are replace
  1828. <p>The following two examples are identical: </p>
  1829. <h3>Examples</h3>
  1830. <blockquote>
  1831. <p><code>&lt;genkey alias=&quot;apache-group&quot; storepass=&quot;secret&quot;
  1832. dname=&quot;CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US&quot; /&gt;</code></p>
  1833. </blockquote>
  1834. <blockquote>
  1835. <pre><code>&lt;genkey alias=&quot;apache-group&quot; storepass=&quot;secret&quot; &gt;
  1836. &lt;dname&gt;
  1837. &lt;param name=&quot;CN&quot; value=&quot;Ant Group&quot;/&gt;
  1838. &lt;param name=&quot;OU&quot; value=&quot;Jakarta Division&quot;/&gt;
  1839. &lt;param name=&quot;O&quot; value=&quot;Apache.Org&quot;/&gt;
  1840. &lt;param name=&quot;C&quot; value=&quot;US&quot;/&gt;
  1841. &lt;/dname&gt;
  1842. &lt;/genkey&gt;</code></pre>
  1843. </blockquote>
  1844. <hr>
  1845. <h2><a name="get">Get</a></h2>
  1846. <h3>Description</h3>
  1847. <p>Gets a file from a URL. When the verbose option is &quot;on&quot;, this task
  1848. displays a '.' for every 100 Kb retrieved.</p>
  1849. <p>This task should be preferred above the <a href="#cvs">CVS task</a> when
  1850. doing automated builds. CVS is significantly slower than loading a compressed
  1851. archive with http/ftp.</p>
  1852. The <i>usetimestamps</i> option enables you to control downloads so that the remote file is
  1853. only fetched if newer than the local copy. If there is no local copy, the download always takes
  1854. place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp,
  1855. if the JVM is Java1.2 or later.
  1856. NB: This timestamp facility only works on downloads using the HTTP protocol.
  1857. <h3>Parameters</h3>
  1858. <table border="1" cellpadding="2" cellspacing="0">
  1859. <tr>
  1860. <td valign="top"><b>Attribute</b></td>
  1861. <td valign="top"><b>Description</b></td>
  1862. <td align="center" valign="top"><b>Required</b></td>
  1863. </tr>
  1864. <tr>
  1865. <td valign="top">src</td>
  1866. <td valign="top">the URL from which to retrieve a file.</td>
  1867. <td align="center" valign="top">Yes</td>
  1868. </tr>
  1869. <tr>
  1870. <td valign="top">dest</td>
  1871. <td valign="top">the file where to store the retrieved file.</td>
  1872. <td align="center" valign="top">Yes</td>
  1873. </tr>
  1874. <tr>
  1875. <td valign="top">verbose</td>
  1876. <td valign="top">show verbose progress information (&quot;on&quot;/&quot;off&quot;).</td>
  1877. <td align="center" valign="top">No</td>
  1878. </tr>
  1879. <tr>
  1880. <td valign="top">ignoreerrors</td>
  1881. <td valign="top">Log errors but don't treat as fatal.</td>
  1882. <td align="center" valign="top">No</td>
  1883. </tr>
  1884. <tr>
  1885. <td valign="top">usetimestamps</td>
  1886. <td valign="top">conditionally download a file based on the timestamp of the local copy.
  1887. HTTP only</td>
  1888. <td align="center" valign="top">No</td>
  1889. </tr>
  1890. </table>
  1891. <h3>Examples</h3>
  1892. <pre> &lt;get src=&quot;http://jakarta.apache.org/&quot; dest=&quot;help/index.html&quot; /&gt;</pre>
  1893. <p>Gets the index page of http://jakarta.apache.org/, and stores it in the file <code>help/index.html</code>.</p>
  1894. <pre> &lt;get src=&quot;http://jakarta.apache.org/builds/tomcat/nightly/ant.zip&quot;
  1895. dest=&quot;optional.jar&quot;
  1896. verbose=&quot;true&quot;
  1897. usetimestamps=&quot;true&quot;/&gt;</pre>
  1898. <p>
  1899. Gets the nightly ant build from the tomcat distribution, if the local copy
  1900. is missing or out of date. Uses the verbose option
  1901. for progress information.
  1902. </p>
  1903. <hr>
  1904. <h2><a name="gunzip">GUnzip</a></h2>
  1905. <h3>Description</h3>
  1906. <p>Expands a GZip file.</p>
  1907. <p>If <i>dest</i> is a directory the name of the destination file is
  1908. the same as <i>src</i> (with the &quot;.gz&quot; extension removed if
  1909. present). If <i>dest</i> is omitted, the parent dir of <i>src</i> is
  1910. taken. The file is only expanded if the source file is newer than the
  1911. destination file, or when the destination file does not exist.</p>
  1912. <h3>Parameters</h3>
  1913. <table border="1" cellpadding="2" cellspacing="0">
  1914. <tr>
  1915. <td valign="top"><b>Attribute</b></td>
  1916. <td valign="top"><b>Description</b></td>
  1917. <td align="center" valign="top"><b>Required</b></td>
  1918. </tr>
  1919. <tr>
  1920. <td valign="top">src</td>
  1921. <td valign="top">the file to expand.</td>
  1922. <td align="center" valign="top">Yes</td>
  1923. </tr>
  1924. <tr>
  1925. <td valign="top">dest</td>
  1926. <td valign="top">the destination file or directory.</td>
  1927. <td align="center" valign="top">No</td>
  1928. </tr>
  1929. </table>
  1930. <h3>Examples</h3>
  1931. <blockquote>
  1932. <p><code>&lt;gunzip src=&quot;test.tar.gz&quot;/&gt;</code></p>
  1933. </blockquote>
  1934. <p>expands <i>test.tar.gz</i> to <i>test.tar</i></p>
  1935. <blockquote>
  1936. <p><code>&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;test2.tar&quot;/&gt;</code></p>
  1937. </blockquote>
  1938. <p>expands <i>test.tar.gz</i> to <i>test2.tar</i></p>
  1939. <blockquote>
  1940. <p><code>&lt;gunzip src=&quot;test.tar.gz&quot; dest=&quot;subdir&quot;/&gt;</code></p>
  1941. </blockquote>
  1942. <p>expands <i>test.tar.gz</i> to <i>subdir/test.tar</i> (assuming
  1943. subdir is a directory).</p>
  1944. <hr>
  1945. <h2><a name="gzip">GZip</a></h2>
  1946. <h3>Description</h3>
  1947. <p>GZips a file.</p>
  1948. <h3>Parameters</h3>
  1949. <table border="1" cellpadding="2" cellspacing="0">
  1950. <tr>
  1951. <td valign="top"><b>Attribute</b></td>
  1952. <td valign="top"><b>Description</b></td>
  1953. <td align="center" valign="top"><b>Required</b></td>
  1954. </tr>
  1955. <tr>
  1956. <td valign="top">src</td>
  1957. <td valign="top">the file to gzip.</td>
  1958. <td align="center" valign="top">Yes</td>
  1959. </tr>
  1960. <tr>
  1961. <td valign="top">zipfile</td>
  1962. <td valign="top">the destination file.</td>
  1963. <td align="center" valign="top">Yes</td>
  1964. </tr>
  1965. </table>
  1966. <h3>Examples</h3>
  1967. <blockquote>
  1968. <p><code>&lt;gzip src=&quot;test.tar&quot; zipfile=&quot;test.tar.gz&quot;
  1969. /&gt;</code></p>
  1970. </blockquote>
  1971. <hr>
  1972. <h2><a name="jar">Jar</a></h2>
  1973. <h3>Description</h3>
  1974. <p>Jars a set of files.</p>
  1975. <p>The <i>basedir</i> attribute is the reference directory from where to jar.</p>
  1976. <p>Note that file permissions will not be stored in the resulting jarfile.</p>
  1977. <p>It is possible to refine the set of files that are being jarred. This can be
  1978. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  1979. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  1980. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  1981. the files you want to have excluded. This is also done with patterns. And
  1982. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  1983. want to use default exclusions or not. See the section on <a
  1984. href="#directorybasedtasks">directory based tasks</a>, on how the
  1985. inclusion/exclusion of files works, and how to write patterns.</p>
  1986. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  1987. supports all attributes of <code>&lt;fileset&gt;</code>
  1988. (<code>dir</code> becomes <code>basedir</code>) as well as the nested
  1989. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  1990. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  1991. elements.</p>
  1992. <p>You can also use nested file sets for more flexibility, and specify
  1993. multiple ones to merge together different trees of files into one JAR.
  1994. See the <a href="#zip">Zip</a> task for more details and examples.</p>
  1995. <p>If the manifest is omitted, a simple one will be supplied by Ant.
  1996. You should not include <samp>META-INF/MANIFEST.MF</samp> in your set of files.
  1997. <p>The <code>whenempty</code> parameter controls what happens when no files match.
  1998. If <code>create</code> (the default), the JAR is created anyway with only a manifest.
  1999. If <code>skip</code>, the JAR is not created and a warning is issued.
  2000. If <code>fail</code>, the JAR is not created and the build is halted with an error.
  2001. <h3>Parameters</h3>
  2002. <table border="1" cellpadding="2" cellspacing="0">
  2003. <tr>
  2004. <td valign="top"><b>Attribute</b></td>
  2005. <td valign="top"><b>Description</b></td>
  2006. <td align="center" valign="top"><b>Required</b></td>
  2007. </tr>
  2008. <tr>
  2009. <td valign="top">jarfile</td>
  2010. <td valign="top">the jar-file to create.</td>
  2011. <td valign="top" align="center">Yes</td>
  2012. </tr>
  2013. <tr>
  2014. <td valign="top">basedir</td>
  2015. <td valign="top">the directory from which to jar the files.</td>
  2016. <td valign="top" align="center">No</td>
  2017. </tr>
  2018. <tr>
  2019. <td valign="top">compress</td>
  2020. <td valign="top">Not only store data but also compress them, defaults to true</td>
  2021. <td align="center" valign="top">No</td>
  2022. </tr>
  2023. <tr>
  2024. <td valign="top">includes</td>
  2025. <td valign="top">comma separated list of patterns of files that must be
  2026. included. All files are included when omitted.</td>
  2027. <td valign="top" align="center">No</td>
  2028. </tr>
  2029. <tr>
  2030. <td valign="top">includesfile</td>
  2031. <td valign="top">the name of a file. Each line of this file is
  2032. taken to be an include pattern</td>
  2033. <td valign="top" align="center">No</td>
  2034. </tr>
  2035. <tr>
  2036. <td valign="top">excludes</td>
  2037. <td valign="top">comma separated list of patterns of files that must be
  2038. excluded. No files (except default excludes) are excluded when omitted.</td>
  2039. <td valign="top" align="center">No</td>
  2040. </tr>
  2041. <tr>
  2042. <td valign="top">excludesfile</td>
  2043. <td valign="top">the name of a file. Each line of this file is
  2044. taken to be an exclude pattern</td>
  2045. <td valign="top" align="center">No</td>
  2046. </tr>
  2047. <tr>
  2048. <td valign="top">defaultexcludes</td>
  2049. <td valign="top">indicates whether default excludes should be used or not
  2050. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  2051. <td valign="top" align="center">No</td>
  2052. </tr>
  2053. <tr>
  2054. <td valign="top">manifest</td>
  2055. <td valign="top">the manifest file to use.</td>
  2056. <td valign="top" align="center">No</td>
  2057. </tr>
  2058. <tr>
  2059. <td valign="top">whenempty</td>
  2060. <td valign="top">Behavior to use if no files match.</td>
  2061. <td valign="top" align="center">No</td>
  2062. </tr>
  2063. </table>
  2064. <h3>Examples</h3>
  2065. <pre> &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot; basedir=&quot;${build}/classes&quot; /&gt;</pre>
  2066. <p>jars all files in the <code>${build}/classes</code> directory in a file
  2067. called <code>app.jar</code> in the <code>${dist}/lib</code> directory.</p>
  2068. <pre> &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot;
  2069. basedir=&quot;${build}/classes&quot;
  2070. excludes=&quot;**/Test.class&quot;
  2071. /&gt;</pre>
  2072. <p>jars all files in the <code>${build}/classes</code> directory in a file
  2073. called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Files
  2074. with the name <code>Test.class</code> are excluded.</p>
  2075. <pre> &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot;
  2076. basedir=&quot;${build}/classes&quot;
  2077. includes=&quot;mypackage/test/**&quot;
  2078. excludes=&quot;**/Test.class&quot;
  2079. /&gt;</pre>
  2080. <p>jars all files in the <code>${build}/classes</code> directory in a file
  2081. called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Only
  2082. files under the directory <code>mypackage/test</code> are used, and files with
  2083. the name <code>Test.class</code> are excluded.</p>
  2084. <pre> &lt;jar jarfile=&quot;${dist}/lib/app.jar&quot;&gt;
  2085. &lt;fileset dir=&quot;${build}/classes&quot;
  2086. excludes=&quot;**/Test.class&quot;
  2087. /&gt;
  2088. &lt;fileset dir=&quot;${src}/resources&quot;/&gt;
  2089. &lt;/jar&gt;</pre>
  2090. <p>jars all files in the <code>${build}/classes</code> directory and also
  2091. in the <code>${src}/resources</code> directory together in a file
  2092. called <code>app.jar</code> in the <code>${dist}/lib</code> directory.
  2093. Files with the name <code>Test.class</code> are excluded.
  2094. If there are files such as <code>${build}/classes/mypackage/MyClass.class</code>
  2095. and <code>${src}/resources/mypackage/image.gif</code>, they will appear
  2096. in the same directory in the JAR (and thus be considered in the same package
  2097. by Java).</p>
  2098. <hr>
  2099. <h2><a name="java">Java</a></h2>
  2100. <h3>Description</h3>
  2101. <p>Executes a Java class within the running (Ant) VM or forks another VM if
  2102. specified.</p>
  2103. <p>Be careful that the executed class doesn't call System.exit(), because it
  2104. will terminate the VM and thus Ant. In case this happens, it's highly suggested
  2105. that you set the fork attribute so that System.exit() stops the other VM and not
  2106. the one that is currently running Ant.</p>
  2107. <h3>Parameters</h3>
  2108. <table border="1" cellpadding="2" cellspacing="0">
  2109. <tr>
  2110. <td valign="top"><b>Attribute</b></td>
  2111. <td valign="top"><b>Description</b></td>
  2112. <td align="center" valign="top"><b>Required</b></td>
  2113. </tr>
  2114. <tr>
  2115. <td valign="top">classname</td>
  2116. <td valign="top">the Java class to execute.</td>
  2117. <td align="center" valign="top">Yes</td>
  2118. </tr>
  2119. <tr>
  2120. <td valign="top">args</td>
  2121. <td valign="top">the arguments for the class that is
  2122. executed. <b>deprecated, use nested <code>&lt;arg&gt;</code>
  2123. elements instead.</b></td>
  2124. <td align="center" valign="top">No</td>
  2125. </tr>
  2126. <tr>
  2127. <td valign="top">classpath</td>
  2128. <td valign="top">the classpath to use.</td>
  2129. <td align="center" valign="top">No</td>
  2130. </tr>
  2131. <tr>
  2132. <td valign="top">classpathref</td>
  2133. <td valign="top">the classpath to use, given as <a
  2134. href="#references">reference</a> to a PATH defined elsewhere.</td>
  2135. <td align="center" valign="top">No</td>
  2136. </tr>
  2137. <tr>
  2138. <td valign="top">fork</td>
  2139. <td valign="top">if enabled triggers the class execution in another VM
  2140. (disabled by default)</td>
  2141. <td align="center" valign="top">No</td>
  2142. </tr>
  2143. <tr>
  2144. <td valign="top">jvm</td>
  2145. <td valign="top">the command used to invoke the Java Virtual Machine,
  2146. default is 'java'. The command is resolved by java.lang.Runtime.exec().
  2147. Ignored if fork is disabled.
  2148. </td>
  2149. <td align="center" valign="top">No</td>
  2150. </tr>
  2151. <tr>
  2152. <td valign="top">jvmargs</td>
  2153. <td valign="top">the arguments to pass to the forked VM (ignored
  2154. if fork is disabled). <b>deprecated, use nested
  2155. <code>&lt;jvmarg&gt;</code> elements instead.</b></td>
  2156. <td align="center" valign="top">No</td>
  2157. </tr>
  2158. <tr>
  2159. <td valign="top">maxmemory</td>
  2160. <td valign="top">Max amount of memory to allocate to the forked VM
  2161. (ignored if fork is disabled)</td>
  2162. <td align="center" valign="top">No</td>
  2163. </tr>
  2164. <tr>
  2165. <td valign="top">failonerror</td>
  2166. <td valign="top">Stop the buildprocess if the command exits with a
  2167. returncode other than 0. Only available if fork is true.</td>
  2168. <td align="center" valign="top">No</td>
  2169. </tr>
  2170. </table>
  2171. <h3>Parameters specified as nested elements</h3>
  2172. <h4>arg and jvmarg</h4>
  2173. <p>Use nested <code>&lt;arg&gt;</code> and <code>&lt;jvmarg&gt;</code>
  2174. elements to specify arguments for the or the forked VM. See <a
  2175. href="index.html#arg">Command line arguments</a>.</p>
  2176. <h4>classpath and classpathref</h4>
  2177. <p><code>Java</code>'s <em>classpath</em> attribute is a <a
  2178. href="#path">PATH like structure</a> and can also be set via a nested
  2179. <em>classpath</em> element. PATHs defined elsewhere can be
  2180. <a href="#references">referred</a> to via nested <em>classpathref</em>
  2181. elements.</p>
  2182. <h5>Example</h5>
  2183. <pre>
  2184. &lt;java classname=&quot;test.Main&quot; &gt;
  2185. &lt;arg value=&quot;-h&quot; /&gt;
  2186. &lt;classpath&gt;
  2187. &lt;pathelement location=&quot;\test.jar&quot; /&gt;
  2188. &lt;pathelement path=&quot;${java.class.path}&quot; /&gt;
  2189. &lt;/classpath&gt;
  2190. &lt;/java&gt;
  2191. </pre>
  2192. <h3>Examples</h3>
  2193. <pre> &lt;java classname=&quot;test.Main&quot; /&gt;</pre>
  2194. <pre> &lt;java classname=&quot;test.Main&quot;
  2195. fork=&quot;yes&quot; &gt;
  2196. &lt;arg value=&quot;-h&quot; /&gt;
  2197. &lt;jvmarg value=&quot;-Xrunhprof:cpu=samples,file=log.txt,depth=3&quot; /&gt;
  2198. &lt;/java&gt;
  2199. </pre>
  2200. <hr>
  2201. <h2><a name="javac">Javac</a></h2>
  2202. <h3>Description</h3>
  2203. <p>Compiles a source tree within the running (Ant) VM.</p>
  2204. <p>The source and destination directory will be recursively scanned for Java
  2205. source files to compile. Only Java files that have no corresponding class file
  2206. or where the class file is older than the java file will be compiled.</p>
  2207. <p>The directory structure of the source tree should follow the package
  2208. hierarchy.</p>
  2209. <p>It is possible to refine the set of files that are being compiled/copied.
  2210. This can be done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  2211. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  2212. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  2213. the files you want to have excluded. This is also done with patterns. And
  2214. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  2215. want to use default exclusions or not. See the section on <a
  2216. href="#directorybasedtasks">directory based tasks</a>, on how the
  2217. inclusion/exclusion of files works, and how to write patterns.</p>
  2218. <p>It is possible to use different compilers. This can be selected with the
  2219. &quot;build.compiler&quot; property. There are three choices:</p>
  2220. <ul>
  2221. <li>classic (the standard compiler of JDK 1.1/1.2)</li>
  2222. <li>modern (the new compiler of JDK 1.3)</li>
  2223. <li>jikes (the <a
  2224. href="http://oss.software.ibm.com/developerworks/opensource/jikes/project">Jikes</a>
  2225. compiler)</li>
  2226. <li>jvc (the Command-Line Compiler from Microsoft's SDK for Java /
  2227. Visual J++)</li>
  2228. </ul>
  2229. <p>For JDK 1.1/1.2 is classic the default. For JDK 1.3 is modern the default.</p>
  2230. <h3>Parameters</h3>
  2231. <table border="1" cellpadding="2" cellspacing="0">
  2232. <tr>
  2233. <td valign="top"><b>Attribute</b></td>
  2234. <td valign="top"><b>Description</b></td>
  2235. <td align="center" valign="top"><b>Required</b></td>
  2236. </tr>
  2237. <tr>
  2238. <td valign="top">srcdir</td>
  2239. <td valign="top">location of the java files.</td>
  2240. <td align="center" valign="top">Yes, unless nested <code>&lt;src&gt;</code> elements are present.</td>
  2241. </tr>
  2242. <tr>
  2243. <td valign="top">destdir</td>
  2244. <td valign="top">location where to store the class files.</td>
  2245. <td align="center" valign="top">Yes</td>
  2246. </tr>
  2247. <tr>
  2248. <td valign="top">includes</td>
  2249. <td valign="top">comma separated list of patterns of files that must be
  2250. included. All files are included when omitted.</td>
  2251. <td valign="top" align="center">No</td>
  2252. </tr>
  2253. <tr>
  2254. <td valign="top">includesfile</td>
  2255. <td valign="top">the name of a file. Each line of this file is
  2256. taken to be an include pattern</td>
  2257. <td valign="top" align="center">No</td>
  2258. </tr>
  2259. <tr>
  2260. <td valign="top">excludes</td>
  2261. <td valign="top">comma separated list of patterns of files that must be
  2262. excluded. No files (except default excludes) are excluded when omitted.</td>
  2263. <td valign="top" align="center">No</td>
  2264. </tr>
  2265. <tr>
  2266. <td valign="top">excludesfile</td>
  2267. <td valign="top">the name of a file. Each line of this file is
  2268. taken to be an exclude pattern</td>
  2269. <td valign="top" align="center">No</td>
  2270. </tr>
  2271. <tr>
  2272. <td valign="top">defaultexcludes</td>
  2273. <td valign="top">indicates whether default excludes should be used or not
  2274. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  2275. <td valign="top" align="center">No</td>
  2276. </tr>
  2277. <tr>
  2278. <td valign="top">classpath</td>
  2279. <td valign="top">the classpath to use.</td>
  2280. <td align="center" valign="top">No</td>
  2281. </tr>
  2282. <tr>
  2283. <td valign="top">bootclasspath</td>
  2284. <td valign="top">location of bootstrap class files.</td>
  2285. <td align="center" valign="top">No</td>
  2286. </tr>
  2287. <tr>
  2288. <td valign="top">classpathref</td>
  2289. <td valign="top">the classpath to use, given as <a
  2290. href="#references">reference</a> to a PATH defined elsewhere.</td>
  2291. <td align="center" valign="top">No</td>
  2292. </tr>
  2293. <tr>
  2294. <td valign="top">bootclasspathref</td>
  2295. <td valign="top">location of bootstrap class files, given as by <a
  2296. href="#references">reference</a> to a PATH defined elsewhere.</td>
  2297. <td align="center" valign="top">No</td>
  2298. </tr>
  2299. <tr>
  2300. <td valign="top">extdirs</td>
  2301. <td valign="top">location of installed extensions.</td>
  2302. <td align="center" valign="top">No</td>
  2303. </tr>
  2304. <tr>
  2305. <td valign="top">encoding</td>
  2306. <td valign="top">encoding of source files.</td>
  2307. <td align="center" valign="top">No</td>
  2308. </tr>
  2309. <tr>
  2310. <td valign="top">debug</td>
  2311. <td valign="top">indicates whether there should be compiled with debug
  2312. information (&quot;on&quot;).</td>
  2313. <td align="center" valign="top">No</td>
  2314. </tr>
  2315. <tr>
  2316. <td valign="top">optimize</td>
  2317. <td valign="top">indicates whether there should be compiled with
  2318. optimization (&quot;on&quot;).</td>
  2319. <td align="center" valign="top">No</td>
  2320. </tr>
  2321. <tr>
  2322. <td valign="top">deprecation</td>
  2323. <td valign="top">indicates whether there should be compiled with deprecation
  2324. information (&quot;on&quot;).</td>
  2325. <td align="center" valign="top">No</td>
  2326. </tr>
  2327. <tr>
  2328. <td valign="top">target</td>
  2329. <td valign="top">Generate class files for specific VM version, e.g. "1.1" or "1.2".</td>
  2330. <td align="center" valign="top">No</td>
  2331. </tr>
  2332. </table>
  2333. <h3>Parameters specified as nested elements</h3>
  2334. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  2335. supports all attributes of <code>&lt;fileset&gt;</code>
  2336. (<code>dir</code> becomes <code>srcdir</code>) as well as the nested
  2337. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  2338. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  2339. elements.</p>
  2340. <h4>src, classpath, classpathref, bootclasspath, bootclasspathref and extdirs</h4>
  2341. <p><code>Javac</code>'s <em>srcdir</em>, <em>classpath</em>,
  2342. <em>bootclasspath</em> and <em>extdirs</em> attributes are <a
  2343. href="#path">PATH like structure</a> and can also be set via nested
  2344. <em>src</em>, <em>classpath</em>, <em>bootclasspath</em> and
  2345. <em>extdirs</em> elements respectively. PATHs defined elsewhere can be
  2346. <a href="#references">referred</a> to via nested <em>classpathref</em>
  2347. and <em>bootclasspathref</em> elements.</p>
  2348. <h3>Examples</h3>
  2349. <pre> &lt;javac srcdir=&quot;${src}&quot;
  2350. destdir=&quot;${build}&quot;
  2351. classpath=&quot;xyz.jar&quot;
  2352. debug=&quot;on&quot;
  2353. /&gt;</pre>
  2354. <p>compiles all .java files under the directory <code>${src}</code>, and stores
  2355. the .class files in the directory <code>${build}</code>.
  2356. The classpath used contains <code>xyz.jar</code>, and debug information is on.</p>
  2357. <pre> &lt;javac srcdir=&quot;${src}&quot;
  2358. destdir=&quot;${build}&quot;
  2359. includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;
  2360. excludes=&quot;mypackage/p1/testpackage/**&quot;
  2361. classpath=&quot;xyz.jar&quot;
  2362. debug=&quot;on&quot;
  2363. /&gt;</pre>
  2364. <p>compiles .java files under the directory <code>${src}</code>, and stores the
  2365. .class files in the directory <code>${build}</code>.
  2366. The classpath used contains <code>xyz.jar</code>, and debug information is on.
  2367. Only files under <code>mypackage/p1</code> and <code>mypackage/p2</code> are
  2368. used. Files in the <code>mypackage/p1/testpackage</code> directory are excluded
  2369. form compilation and copy.</p>
  2370. <pre> &lt;javac srcdir=&quot;${src}:${src2}&quot;
  2371. destdir=&quot;${build}&quot;
  2372. includes=&quot;mypackage/p1/**,mypackage/p2/**&quot;
  2373. excludes=&quot;mypackage/p1/testpackage/**&quot;
  2374. classpath=&quot;xyz.jar&quot;
  2375. debug=&quot;on&quot;
  2376. /&gt;</pre>
  2377. <p>is the same as the previous example with the addition of a second source path, defined by
  2378. the propery <code>src2</code>. This can also be represented using nested elements as follows
  2379. <pre> &lt;javac destdir=&quot;${build}&quot;
  2380. classpath=&quot;xyz.jar&quot;
  2381. debug=&quot;on&quot;&gt;
  2382. &lt;src path=&quot;${src}&quot; /&gt;
  2383. &lt;src path=&quot;${src2}&quot; /&gt;
  2384. &lt;include name=&quot;mypackage/p1/**,mypackage/p2/**&quot; /&gt;
  2385. &lt;exclude name=&quot;mypackage/p1/testpackage/**&quot; /&gt;
  2386. &lt;/javac&gt;</pre>
  2387. <hr>
  2388. <h2><a name="javadoc">Javadoc/Javadoc2</a></h2>
  2389. <h3>Description</h3>
  2390. <p>Generates code documentation using the javadoc tool.</p>
  2391. <p>The source directory will be recursively scanned for Java source files to process
  2392. but only those matching the inclusion rules will be passed to the javadoc tool. This
  2393. allows wildcards to be used to choose between package names, reducing verbosity
  2394. and management costs over time. This task, however, has no notion of
  2395. &quot;changed&quot; files, unlike the <a href="#javac">javac</a> task. This means
  2396. all packages will be processed each time this task is run. In general, however,
  2397. this task is used much less frequently.</p>
  2398. <p>This task works seamlessly between different javadoc versions (1.1 and 1.2),
  2399. with the obvious restriction that the 1.2 attributes will be ignored if run in a
  2400. 1.1 VM.</p>
  2401. <p>NOTE: since javadoc calls System.exit(), javadoc cannot be run inside the
  2402. same VM as ant without breaking functionality. For this reason, this task
  2403. always forks the VM. This overhead is not significant since javadoc is normally a heavy
  2404. application and will be called infrequently.</p>
  2405. <p>NOTE: the packagelist attribute allows you to specify the list of packages to
  2406. document outside of the Ant file. It's a much better practice to include everything
  2407. inside the build.xml file. This option was added in order to make it easier to
  2408. migrate from regular makefiles, where you would use this option of javadoc.
  2409. The packages listed in packagelist are not checked, so the task performs even
  2410. if some packages are missing or broken. Use this option if you wish to convert from
  2411. an existing makefile. Once things are running you should then switch to the regular
  2412. notation.
  2413. <p>DEPRECATION: the javadoc2 task simply points to the javadoc task and it's
  2414. there for back compatibility reasons. Since this task will be removed in future
  2415. versions, you are strongly encouraged to use <a href="#javadoc">javadoc</a>
  2416. instead.</p>
  2417. <h3>Parameters</h3>
  2418. <table border="1" cellpadding="2" cellspacing="0">
  2419. <tr>
  2420. <td valign="top"><b>Attribute</b></td>
  2421. <td valign="top"><b>Description</b></td>
  2422. <td align="center" valign="top"><b>Availability</b></td>
  2423. <td align="center" valign="top"><b>Required</b></td>
  2424. </tr>
  2425. <tr>
  2426. <td valign="top">sourcepath</td>
  2427. <td valign="top">Specify where to find source files</td>
  2428. <td align="center" valign="top">all</td>
  2429. <td align="center" rowspan="2">At least one of the two or nested
  2430. <code>&lt;sourcepath&gt;</code> or
  2431. <code>&lt;sourcepathref&gt;</code></td>
  2432. </tr>
  2433. <tr>
  2434. <td valign="top">sourcepathref</td>
  2435. <td valign="top">Specify where to find source files by <a
  2436. href="#references">reference</a> to a PATH defined elsewhere.</td>
  2437. <td align="center" valign="top">all</td>
  2438. </tr>
  2439. <tr>
  2440. <td valign="top">destdir</td>
  2441. <td valign="top">Destination directory for output files</td>
  2442. <td align="center" valign="top">all</td>
  2443. <td align="center" valign="top">Yes</td>
  2444. </tr>
  2445. <tr>
  2446. <td valign="top">maxmemory</td>
  2447. <td valign="top">Max amount of memory to allocate to the javadoc VM</td>
  2448. <td align="center" valign="top">all</td>
  2449. <td align="center" valign="top">No</td>
  2450. </tr>
  2451. <tr>
  2452. <td valign="top">sourcefiles</td>
  2453. <td valign="top">Space separated list of source files</td>
  2454. <td align="center" valign="top">all</td>
  2455. <td align="center" valign="middle" rowspan="2">at least one of the two</td>
  2456. </tr>
  2457. <tr>
  2458. <td valign="top">packagenames</td>
  2459. <td valign="top">Comma separated list of package files (with terminating
  2460. wildcard)</td>
  2461. <td align="center" valign="top">all</td>
  2462. </tr>
  2463. <tr>
  2464. <td valign="top">packageList</td>
  2465. <td valign="top">The name of a file containing the packages to process</td>
  2466. <td align="center" valign="top">all</td>
  2467. <td align="center" valign="top">No</td>
  2468. </tr>
  2469. <tr>
  2470. <td valign="top">classpath</td>
  2471. <td valign="top">Specify where to find user class files</td>
  2472. <td align="center" valign="top">all</td>
  2473. <td align="center" valign="top">No</td>
  2474. </tr>
  2475. <tr>
  2476. <td valign="top">Bootclasspath</td>
  2477. <td valign="top">Override location of class files loaded by the bootstrap
  2478. class loader</td>
  2479. <td align="center" valign="top">1.2</td>
  2480. <td align="center" valign="top">No</td>
  2481. </tr>
  2482. <tr>
  2483. <td valign="top">classpathref</td>
  2484. <td valign="top">Specify where to find user class files by <a
  2485. href="#references">reference</a> to a PATH defined elsewhere.</td>
  2486. <td align="center" valign="top">all</td>
  2487. <td align="center" valign="top">No</td>
  2488. </tr>
  2489. <tr>
  2490. <td valign="top">bootclasspathref</td>
  2491. <td valign="top">Override location of class files loaded by the
  2492. bootstrap class loader by <a href="#references">reference</a> to a
  2493. PATH defined elsewhere.</td>
  2494. <td align="center" valign="top">1.2</td>
  2495. <td align="center" valign="top">No</td>
  2496. </tr>
  2497. <tr>
  2498. <td valign="top">Extdirs</td>
  2499. <td valign="top">Override location of installed extensions</td>
  2500. <td align="center" valign="top">1.2</td>
  2501. <td align="center" valign="top">No</td>
  2502. </tr>
  2503. <tr>
  2504. <td valign="top">Overview</td>
  2505. <td valign="top">Read overview documentation from HTML file</td>
  2506. <td align="center" valign="top">1.2</td>
  2507. <td align="center" valign="top">No</td>
  2508. </tr>
  2509. <tr>
  2510. <td valign="top">Public</td>
  2511. <td valign="top">Show only public classes and members</td>
  2512. <td align="center" valign="top">all</td>
  2513. <td align="center" valign="top">No</td>
  2514. </tr>
  2515. <tr>
  2516. <td valign="top">Protected</td>
  2517. <td valign="top">Show protected/public classes and members (default)</td>
  2518. <td align="center" valign="top">all</td>
  2519. <td align="center" valign="top">No</td>
  2520. </tr>
  2521. <tr>
  2522. <td valign="top">Package</td>
  2523. <td valign="top">Show package/protected/public classes and members</td>
  2524. <td align="center" valign="top">all</td>
  2525. <td align="center" valign="top">No</td>
  2526. </tr>
  2527. <tr>
  2528. <td valign="top">Private</td>
  2529. <td valign="top">Show all classes and members</td>
  2530. <td align="center" valign="top">all</td>
  2531. <td align="center" valign="top">No</td>
  2532. </tr>
  2533. <tr>
  2534. <td valign="top">Old</td>
  2535. <td valign="top">Generate output using JDK 1.1 emulating doclet</td>
  2536. <td align="center" valign="top">1.2</td>
  2537. <td align="center" valign="top">No</td>
  2538. </tr>
  2539. <tr>
  2540. <td valign="top">Verbose</td>
  2541. <td valign="top">Output messages about what Javadoc is doing</td>
  2542. <td align="center" valign="top">1.2</td>
  2543. <td align="center" valign="top">No</td>
  2544. </tr>
  2545. <tr>
  2546. <td valign="top">Locale</td>
  2547. <td valign="top">Locale to be used, e.g. en_US or en_US_WIN</td>
  2548. <td align="center" valign="top">1.2</td>
  2549. <td align="center" valign="top">No</td>
  2550. </tr>
  2551. <tr>
  2552. <td valign="top">Encoding</td>
  2553. <td valign="top">Source file encoding name</td>
  2554. <td align="center" valign="top">all</td>
  2555. <td align="center" valign="top">No</td>
  2556. </tr>
  2557. <tr>
  2558. <td valign="top">Version</td>
  2559. <td valign="top">Include @version paragraphs</td>
  2560. <td align="center" valign="top">all</td>
  2561. <td align="center" valign="top">No</td>
  2562. </tr>
  2563. <tr>
  2564. <td valign="top">Use</td>
  2565. <td valign="top">Create class and package usage pages</td>
  2566. <td align="center" valign="top">1.2</td>
  2567. <td align="center" valign="top">No</td>
  2568. </tr>
  2569. <tr>
  2570. <td valign="top">Author</td>
  2571. <td valign="top">Include @author paragraphs</td>
  2572. <td align="center" valign="top">all</td>
  2573. <td align="center" valign="top">No</td>
  2574. </tr>
  2575. <tr>
  2576. <td valign="top">Splitindex</td>
  2577. <td valign="top">Split index into one file per letter</td>
  2578. <td align="center" valign="top">1.2</td>
  2579. <td align="center" valign="top">No</td>
  2580. </tr>
  2581. <tr>
  2582. <td valign="top">Windowtitle</td>
  2583. <td valign="top">Browser window title for the documentation (text)</td>
  2584. <td align="center" valign="top">1.2</td>
  2585. <td align="center" valign="top">No</td>
  2586. </tr>
  2587. <tr>
  2588. <td valign="top">Doctitle</td>
  2589. <td valign="top">Include title for the package index(first) page (html-code)</td>
  2590. <td align="center" valign="top">1.2</td>
  2591. <td align="center" valign="top">No</td>
  2592. </tr>
  2593. <tr>
  2594. <td valign="top">Header</td>
  2595. <td valign="top">Include header text for each page (html-code)</td>
  2596. <td align="center" valign="top">1.2</td>
  2597. <td align="center" valign="top">No</td>
  2598. </tr>
  2599. <tr>
  2600. <td valign="top">Footer</td>
  2601. <td valign="top">Include footer text for each page (html-code)</td>
  2602. <td align="center" valign="top">1.2</td>
  2603. <td align="center" valign="top">No</td>
  2604. </tr>
  2605. <tr>
  2606. <td valign="top">bottom</td>
  2607. <td valign="top">Include bottom text for each page (html-code)</td>
  2608. <td align="center" valign="top">1.2</td>
  2609. <td align="center" valign="top">No</td>
  2610. </tr>
  2611. <tr>
  2612. <td valign="top">link</td>
  2613. <td valign="top">Create links to javadoc output at the given URL</td>
  2614. <td align="center" valign="top">1.2</td>
  2615. <td align="center" valign="top">No</td>
  2616. </tr>
  2617. <tr>
  2618. <td valign="top">linkoffline</td>
  2619. <td valign="top">Link to docs at &lt;url&gt; using package list at
  2620. &lt;url2&gt;</td>
  2621. <td align="center" valign="top">1.2</td>
  2622. <td align="center" valign="top">No</td>
  2623. </tr>
  2624. <tr>
  2625. <td valign="top">group</td>
  2626. <td valign="top">Group specified packages together in overview page</td>
  2627. <td align="center" valign="top">1.2</td>
  2628. <td align="center" valign="top">No</td>
  2629. </tr>
  2630. <tr>
  2631. <td valign="top">nodeprecated</td>
  2632. <td valign="top">Do not include @deprecated information</td>
  2633. <td align="center" valign="top">all</td>
  2634. <td align="center" valign="top">No</td>
  2635. </tr>
  2636. <tr>
  2637. <td valign="top">nodeprecatedlist</td>
  2638. <td valign="top">Do not generate deprecated list</td>
  2639. <td align="center" valign="top">1.2</td>
  2640. <td align="center" valign="top">No</td>
  2641. </tr>
  2642. <tr>
  2643. <td valign="top">notree</td>
  2644. <td valign="top">Do not generate class hierarchy</td>
  2645. <td align="center" valign="top">all</td>
  2646. <td align="center" valign="top">No</td>
  2647. </tr>
  2648. <tr>
  2649. <td valign="top">noindex</td>
  2650. <td valign="top">Do not generate index</td>
  2651. <td align="center" valign="top">all</td>
  2652. <td align="center" valign="top">No</td>
  2653. </tr>
  2654. <tr>
  2655. <td valign="top">nohelp</td>
  2656. <td valign="top">Do not generate help link</td>
  2657. <td align="center" valign="top">1.2</td>
  2658. <td align="center" valign="top">No</td>
  2659. </tr>
  2660. <tr>
  2661. <td valign="top">nonavbar</td>
  2662. <td valign="top">Do not generate navigation bar</td>
  2663. <td align="center" valign="top">1.2</td>
  2664. <td align="center" valign="top">No</td>
  2665. </tr>
  2666. <tr>
  2667. <td valign="top">serialwarn</td>
  2668. <td valign="top">FUTURE: Generate warning about @serial tag</td>
  2669. <td align="center" valign="top">1.2</td>
  2670. <td align="center" valign="top">No</td>
  2671. </tr>
  2672. <tr>
  2673. <td valign="top">helpfile</td>
  2674. <td valign="top">FUTURE: Specifies the HTML help file to use</td>
  2675. <td align="center" valign="top">1.2</td>
  2676. <td align="center" valign="top">No</td>
  2677. </tr>
  2678. <tr>
  2679. <td valign="top">stylesheetfile</td>
  2680. <td valign="top">Specifies the CSS stylesheet to use</td>
  2681. <td align="center" valign="top">1.2</td>
  2682. <td align="center" valign="top">No</td>
  2683. </tr>
  2684. <tr>
  2685. <td valign="top">charset</td>
  2686. <td valign="top">FUTURE: Charset for cross-platform viewing of generated
  2687. documentation</td>
  2688. <td align="center" valign="top">1.2</td>
  2689. <td align="center" valign="top">No</td>
  2690. </tr>
  2691. <tr>
  2692. <td valign="top">docencoding</td>
  2693. <td valign="top">Output file encoding name</td>
  2694. <td align="center" valign="top">1.1</td>
  2695. <td align="center" valign="top">No</td>
  2696. </tr>
  2697. <tr>
  2698. <td valign="top">doclet</td>
  2699. <td valign="top">Specifies the class file that starts the doclet used in generating the documentation.</td>
  2700. <td align="center" valign="top">1.2</td>
  2701. <td align="center" valign="top">No</td>
  2702. </tr>
  2703. <tr>
  2704. <td valign="top">docletpath</td>
  2705. <td valign="top">Specifies the path to the doclet class file that is specified with the -doclet option.</td>
  2706. <td align="center" valign="top">1.2</td>
  2707. <td align="center" valign="top">No</td>
  2708. </tr>
  2709. <tr>
  2710. <td valign="top">docletpathref</td>
  2711. <td valign="top">Specifies the path to the doclet class file that
  2712. is specified with the -doclet option by <a
  2713. href="#references">reference</a> to a PATH defined elsewhere.</td>
  2714. <td align="center" valign="top">1.2</td>
  2715. <td align="center" valign="top">No</td>
  2716. </tr>
  2717. <tr>
  2718. <td valign="top">additionalparam</td>
  2719. <td valign="top">Lets you add additional parameters to the javadoc command line. Useful for doclets</td>
  2720. <td align="center" valign="top">1.2</td>
  2721. <td align="center" valign="top">No</td>
  2722. </tr>
  2723. <tr>
  2724. <td valign="top">failonerror</td>
  2725. <td valign="top">Stop the buildprocess if the command exits with a
  2726. returncode other than 0.</td>
  2727. <td align="center" valign="top">all</td>
  2728. <td align="center" valign="top">No</td>
  2729. </tr>
  2730. </table>
  2731. <h3>Parameters specified as nested elements</h3>
  2732. <h4>link</h4>
  2733. <p>Create link to javadoc output at the given URL. This performs the
  2734. same role as the link and linkoffline attributes. You can use either
  2735. syntax (or both at once), but with the nested elements you can easily
  2736. specify multiple occurrences of the arguments.</p>
  2737. <h4>Parameters</h4>
  2738. <table width="60%" border="1" cellpadding="2" cellspacing="0">
  2739. <tr>
  2740. <td valign="top"><b>Attribute</b></td>
  2741. <td valign="top"><b>Description</b></td>
  2742. <td align="center" valign="top"><b>Required</b></td>
  2743. </tr>
  2744. <tr>
  2745. <td valign="top">href</td>
  2746. <td valign="top">The URL for the external documentation you wish to link to</td>
  2747. <td align="center" valign="top">Yes</td>
  2748. </tr>
  2749. <tr>
  2750. <td valign="top">offline</td>
  2751. <td valign="top">True if this link is not available online at the time of
  2752. generating the documentation</td>
  2753. <td align="center" valign="top">No</td>
  2754. </tr>
  2755. <tr>
  2756. <td valign="top">packagelistLoc</td>
  2757. <td valign="top">The location to the directory containing the package-list file for
  2758. the external documentation</td>
  2759. <td align="center" valign="top">Only if the offline attribute is true</td>
  2760. </tr>
  2761. </table>
  2762. <h4>groups</h4>
  2763. <p>Separates packages on the overview page into whatever groups you
  2764. specify, one group per table. This performs the same role as the group
  2765. attribute. You can use either syntax (or both at once), but with the
  2766. nested elements you can easily specify multiple occurrences of the
  2767. arguments.</p>
  2768. <table width="60%" border="1" cellpadding="2" cellspacing="0">
  2769. <tr>
  2770. <td valign="top"><b>Attribute</b></td>
  2771. <td valign="top"><b>Description</b></td>
  2772. <td align="center" valign="top"><b>Required</b></td>
  2773. </tr>
  2774. <tr>
  2775. <td valign="top">title</td>
  2776. <td valign="top">Title of the group</td>
  2777. <td align="center" valign="top">Yes</td>
  2778. </tr>
  2779. <tr>
  2780. <td valign="top">packages</td>
  2781. <td valign="top">List of packages to include in that group</td>
  2782. <td align="center" valign="top">Yes</td>
  2783. </tr>
  2784. </table>
  2785. <h4>sourcepath, classpath, bootclasspath, sourcepathref, classpathref
  2786. and bootclasspathref</h4>
  2787. <p><code>Javadoc</code>'s <em>sourcepath</em>, <em>classpath</em> and
  2788. <em>bootclasspath</em> attributes are <a href="#path">PATH like
  2789. structure</a> and can also be set via nested <em>sourcepath</em>,
  2790. <em>classpath</em> and <em>bootclasspath</em> elements
  2791. respectively. PATHs defined elsewhere can be <a
  2792. href="#references">referred</a> to via nested <em>sourcepathref</em>,
  2793. <em>classpathref</em> and <em>bootclasspathref</em> elements.</p>
  2794. <h3>Example</h3>
  2795. <pre> &lt;javadoc packagenames=&quot;com.dummy.test.*&quot;
  2796. sourcepath=&quot;src&quot;
  2797. destdir=&quot;docs/api&quot;
  2798. author=&quot;true&quot;
  2799. version=&quot;true&quot;
  2800. use=&quot;true&quot;
  2801. windowtitle=&quot;Test API&quot;
  2802. doctitle=&quot;&lt;h1&gt;Test&lt;/h1&gt;&quot;
  2803. bottom=&quot;&lt;i&gt;Copyright &amp;#169; 2000 Dummy Corp. All Rights Reserved.&lt;/i&gt;&quot;&gt;
  2804. &lt;group title=&quot;Group 1 Packages&quot; packages=&quot;com.dummy.test.a*&quot;/&gt;
  2805. &lt;group title=&quot;Group 2 Packages&quot; packages=&quot;com.dummy.test.b*&quot;/&gt;
  2806. &lt;link offline=&quot;true&quot; href=&quot;http://java.sun.com/products/jdk/1.2/docs/api/&quot; packagelistLoc=&quot;C:\tmp&quot;/&gt;
  2807. &lt;link href=&quot;http://developer.java.sun.com/developer/products/xml/docs/api/&quot;/&gt;
  2808. &lt/javadoc&gt;</pre>
  2809. <hr>
  2810. <h2><a name="mkdir">Mkdir</a></h2>
  2811. <h3>Description</h3>
  2812. <p>Creates a directory. Also non-existent parent directories are created, when
  2813. necessary.</p>
  2814. <h3>Parameters</h3>
  2815. <table border="1" cellpadding="2" cellspacing="0">
  2816. <tr>
  2817. <td valign="top"><b>Attribute</b></td>
  2818. <td valign="top"><b>Description</b></td>
  2819. <td align="center" valign="top"><b>Required</b></td>
  2820. </tr>
  2821. <tr>
  2822. <td valign="top">dir</td>
  2823. <td valign="top">the directory to create.</td>
  2824. <td align="center" valign="top">Yes</td>
  2825. </tr>
  2826. </table>
  2827. <h3>Examples</h3>
  2828. <pre>&lt;mkdir dir=&quot;${dist}&quot; /&gt;</pre>
  2829. <p>creates a directory <code>${dist}</code>.</p>
  2830. <pre>&lt;mkdir dir=&quot;${dist}/lib&quot; /&gt;</pre>
  2831. <p>creates a directory <code>${dist}/lib</code>.</p>
  2832. <hr>
  2833. <h2><a name="patch">Patch</a></h2>
  2834. <h3>Description</h3>
  2835. <p>Applies a diff file to originals.
  2836. <h3>Parameters</h3>
  2837. <table border="1" cellpadding="2" cellspacing="0">
  2838. <tr>
  2839. <td valign="top"><b>Attribute</b></td>
  2840. <td valign="top"><b>Description</b></td>
  2841. <td align="center" valign="top"><b>Required</b></td>
  2842. </tr>
  2843. <tr>
  2844. <td valign="top">patchfile</td>
  2845. <td valign="top">the file that includes the diff output</td>
  2846. <td align="center" valign="top">Yes</td>
  2847. </tr>
  2848. <tr>
  2849. <td valign="top">originalfile</td>
  2850. <td valign="top">the file to patch</td>
  2851. <td align="center" valign="top">No, tries to guess it from the diff
  2852. file</td>
  2853. </tr>
  2854. <tr>
  2855. <td valign="top">backups</td>
  2856. <td valign="top">Keep backups of the unpatched files</td>
  2857. <td align="center" valign="top">No</td>
  2858. </tr>
  2859. <tr>
  2860. <td valign="top">quiet</td>
  2861. <td valign="top">Work silently unless an error occurs</td>
  2862. <td align="center" valign="top">No</td>
  2863. </tr>
  2864. <tr>
  2865. <td valign="top">reverse</td>
  2866. <td valign="top">Assume patch was created with old and new files
  2867. swapped.</td>
  2868. <td align="center" valign="top">No</td>
  2869. </tr>
  2870. <tr>
  2871. <td valign="top">ignorewhitespace</td>
  2872. <td valign="top">Ignore whitespace differences.</td>
  2873. <td align="center" valign="top">No</td>
  2874. </tr>
  2875. <tr>
  2876. <td valign="top">strip</td>
  2877. <td valign="top">Strip the smallest prefix containing <i>num</i> leading
  2878. slashes from filenames.</td>
  2879. <td align="center" valign="top">No</td>
  2880. </tr>
  2881. </table>
  2882. <h3>Examples</h3>
  2883. <pre> &lt;patch patchfile=&quot;module.1.0-1.1.patch&quot; /&gt;</pre>
  2884. <p>applies the diff included in <i>module.1.0-1.1.patch</i> to the
  2885. files in base directory guessing the filename(s) from the diff output.
  2886. <pre> &lt;patch patchfile=&quot;module.1.0-1.1.patch&quot; strip="1" /&gt;</pre>
  2887. <p>like above but one leading directory part will be removed. i.e. if
  2888. the diff output looked like
  2889. <pre>
  2890. --- a/mod1.0/A Mon Jun 5 17:28:41 2000
  2891. +++ a/mod1.1/A Mon Jun 5 17:28:49 2000
  2892. </pre>
  2893. the leading <i>a/</i> will be stripped.
  2894. <hr>
  2895. <h2><a name="property">Property</a></h2>
  2896. <h3>Description</h3>
  2897. <p>Sets a property (by name and value), or set of properties (from file or
  2898. resource) in the project.</p>
  2899. <p>When a property was set by the user, or was a property in a parent project
  2900. (that started this project with the <a href="#ant">ant task</a>), then this
  2901. property cannot be set, and will be ignored. This means that properties set
  2902. outside the current project always override the properties of the current
  2903. project.</p>
  2904. <p>There are three ways to set properties:</p>
  2905. <ul>
  2906. <li>By supplying both the <i>name</i> and <i>value</i> attribute.</li>
  2907. <li>By setting the <i>file</i> attribute with the filename of the property
  2908. file to load. This property file has the format as defined by the file used
  2909. in the class java.util.Properties.</li>
  2910. <li>By setting the <i>resource</i> attribute with the resource name of the
  2911. property file to load. This property file has the format as defined by the
  2912. file used in the class java.util.Properties.</li>
  2913. </ul>
  2914. <p>Although combinations of the three ways are possible, only one should be used
  2915. at a time. Problems might occur with the order in which properties are set, for
  2916. instance.</p>
  2917. <p>The value part of the properties being set, might contain references to other
  2918. properties. These references are resolved at the time these properties are set.
  2919. This also holds for properties loaded from a property file.</p>
  2920. <h3>Parameters</h3>
  2921. <table border="1" cellpadding="2" cellspacing="0">
  2922. <tr>
  2923. <td valign="top"><b>Attribute</b></td>
  2924. <td valign="top"><b>Description</b></td>
  2925. <td align="center" valign="top"><b>Required</b></td>
  2926. </tr>
  2927. <tr>
  2928. <td valign="top">name</td>
  2929. <td valign="top">the name of the property to set.</td>
  2930. <td valign="top" align="center">Yes</td>
  2931. </tr>
  2932. <tr>
  2933. <td valign="top">value</td>
  2934. <td valign="top">the value of the property.</td>
  2935. <td valign="middle" align="center" rowspan="3">Yes</td>
  2936. </tr>
  2937. <tr>
  2938. <td valign="top">resource</td>
  2939. <td valign="top">the resource name of the property file.</td>
  2940. </tr>
  2941. <tr>
  2942. <td valign="top">file</td>
  2943. <td valign="top">the filename of the property file .</td>
  2944. </tr>
  2945. </table>
  2946. <h3>Examples</h3>
  2947. <pre> &lt;property name=&quot;foo.dist&quot; value=&quot;dist&quot; /&gt;</pre>
  2948. <p>sets the property <code>foo.dist</code> to the value &quot;dist&quot;.</p>
  2949. <pre> &lt;property file=&quot;foo.properties&quot; /&gt;</pre>
  2950. <p>reads a set of properties from a file called &quot;foo.properties&quot;.</p>
  2951. <pre> &lt;property resource=&quot;foo.properties&quot; /&gt;</pre>
  2952. <p>reads a set of properties from a resource called &quot;foo.properties&quot;.</p>
  2953. <p>Note that you can reference a global properties file for all of your Ant
  2954. builds using the following:
  2955. <pre> &lt;property file=&quot;${user.home}/.ant-global.properties&quot; /&gt;</pre>
  2956. <p>since the &quot;user.home&quot; property is defined by the Java virtual machine
  2957. to be your home directory. This technique is more appropriate for Unix than
  2958. Windows since the notion of a home directory doesn't exist on Windows. On the
  2959. JVM that I tested, the home directory on Windows is &quot;C:\&quot;. Different JVM
  2960. implementations may use other values for the home directory on Windows.
  2961. <hr>
  2962. <h2><a name="rename">Rename</a></h2>
  2963. <h3>Description</h3>
  2964. <p>Renames a given file.</p>
  2965. <h3>Parameters</h3>
  2966. <table border="1" cellpadding="2" cellspacing="0">
  2967. <tr>
  2968. <td valign="top"><b>Attribute</b></td>
  2969. <td valign="top"><b>Description</b></td>
  2970. <td align="center" valign="top"><b>Required</b></td>
  2971. </tr>
  2972. <tr>
  2973. <td valign="top">src</td>
  2974. <td valign="top">file to rename.</td>
  2975. <td valign="top" align="center">Yes</td>
  2976. </tr>
  2977. <tr>
  2978. <td valign="top">dest</td>
  2979. <td valign="top">new name of the file.</td>
  2980. <td valign="top" align="center">Yes</td>
  2981. </tr>
  2982. <tr>
  2983. <td valign="top">replace</td>
  2984. <td valign="top">Enable replacing of existing file (default: on).</td>
  2985. <td valign="top" align="center">No</td>
  2986. </tr>
  2987. </table>
  2988. <h3>Examples</h3>
  2989. <pre> &lt;rename src=&quot;foo.jar&quot; dest=&quot;${name}-${version}.jar&quot; /&gt;</pre>
  2990. <p>Renames the file <code>foo.jar</code> to <code>${name}-${version}.jar</code> (assuming <code>name</code>
  2991. and <code>version</code> being predefined properties). If a file named <code>${name}-${version}.jar</code>
  2992. already exists, it will be removed prior to renaming <code>foo.jar</code>.</p>
  2993. <hr>
  2994. <h2><a name="replace">Replace</a></h2>
  2995. <h3>Description</h3>
  2996. <p>Replace is a directory based task for replacing the occurrence of a given string with another string
  2997. in selected file.</p>
  2998. <p>If you want to replace a text that crosses line boundaries, you
  2999. must use a nested <code>&lt;replacetoken&gt;</code> element.</p>
  3000. <h3>Parameters</h3>
  3001. <table border="1" cellpadding="2" cellspacing="0">
  3002. <tr>
  3003. <td valign="top"><b>Attribute</b></td>
  3004. <td valign="top"><b>Description</b></td>
  3005. <td align="center" valign="top"><b>Required</b></td>
  3006. </tr>
  3007. <tr>
  3008. <td valign="top">file</td>
  3009. <td valign="top">file for which the token should be replaced.</td>
  3010. <td align="center" rowspan=2">Exactly one of the two.</td>
  3011. </tr>
  3012. <tr>
  3013. <td valign="top">dir</td>
  3014. <td valign="top">The base directory to use when replacing a token in
  3015. multiple files.</td>
  3016. </tr>
  3017. <tr>
  3018. <td valign="top">token</td>
  3019. <td valign="top">the token which must be replaced.</td>
  3020. <td valign="top" align="center">Yes, unless a nested <code>replacetoken</code>
  3021. element is used.</td>
  3022. </tr>
  3023. <tr>
  3024. <td valign="top">value</td>
  3025. <td valign="top">the new value for the token. When omitted, an empty string
  3026. (&quot;&quot;) is used.</td>
  3027. <td valign="top" align="center">No</td>
  3028. </tr>
  3029. <tr>
  3030. <td valign="top">includes</td>
  3031. <td valign="top">comma separated list of patterns of files that must be
  3032. included. All files are included when omitted.</td>
  3033. <td valign="top" align="center">No</td>
  3034. </tr>
  3035. <tr>
  3036. <td valign="top">includesfile</td>
  3037. <td valign="top">the name of a file. Each line of this file is
  3038. taken to be an include pattern</td>
  3039. <td valign="top" align="center">No</td>
  3040. </tr>
  3041. <tr>
  3042. <td valign="top">excludes</td>
  3043. <td valign="top">comma separated list of patterns of files that must be
  3044. excluded. No files (except default excludes) are excluded when omitted.</td>
  3045. <td valign="top" align="center">No</td>
  3046. </tr>
  3047. <tr>
  3048. <td valign="top">excludesfile</td>
  3049. <td valign="top">the name of a file. Each line of this file is
  3050. taken to be an exclude pattern</td>
  3051. <td valign="top" align="center">No</td>
  3052. </tr>
  3053. <tr>
  3054. <td valign="top">defaultexcludes</td>
  3055. <td valign="top">indicates whether default excludes should be used or not
  3056. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  3057. <td valign="top" align="center">No</td>
  3058. </tr>
  3059. </table>
  3060. <h3>Examples</h3>
  3061. <pre> &lt;replace file=&quot;${src}/index.html&quot; token=&quot;@@@&quot; value=&quot;wombat&quot; /&gt;</pre>
  3062. <p>replaces occurrences of the string &quot;@@@&quot; with the string
  3063. &quot;wombat&quot;, in the file <code>${src}/index.html</code>.</p>
  3064. <h3>Parameters specified as nested elements</h3>
  3065. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  3066. supports all attributes of <code>&lt;fileset&gt;</code> as well as the
  3067. nested <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  3068. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  3069. elements.</p>
  3070. <p>If either the text you want to replace or the replacement text
  3071. cross line boundaries, you can use nested elements to specify
  3072. them.</p>
  3073. <h3>Examples</h3>
  3074. <blockquote><pre>
  3075. &lt;replace dir=&quot;${src}&quot; value=&quot;wombat&quot;&gt;
  3076. &lt;include name=&quot;**/*.html&quot; /&gt;
  3077. &lt;replacetoken&gt;&lt;[CDATA[multi line
  3078. token]]>&lt;/replacetoken&gt;
  3079. &lt;/replace&gt;
  3080. </pre></blockquote>
  3081. <p>replaces occurrences of the string &quot;multi
  3082. line<em>\n</em>token&quot; with the string &quot;wombat&quot;, in all
  3083. HTML files in the directory <code>${src}</code>.Where <em>\n</em> is
  3084. the platform specific line separator.</p>
  3085. <blockquote><pre>
  3086. &lt;replace file=&quot;${src}/index.html&quot;&gt;
  3087. &lt;replacetoken&gt;&lt;[CDATA[two line
  3088. token]]>&lt;/replacetoken&gt;
  3089. &lt;replacevalue&gt;&lt;[CDATA[two line
  3090. token]]>&lt;/replacevalue&gt;
  3091. &lt;/replace&gt;
  3092. </pre></blockquote>
  3093. <hr>
  3094. <h2><a name="rmic">Rmic</a></h2>
  3095. <h3>Description</h3>
  3096. <p>Runs the rmic compiler for a certain class.</p>
  3097. <p>Rmic can be run on a single class (as specified with the classname
  3098. attribute) or a number of classes at once (all classes below base that
  3099. are neither _Stub nor _Skel classes).</p>
  3100. <p>It is possible to refine the set of files that are being rmiced. This can be
  3101. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  3102. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  3103. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  3104. the files you want to have excluded. This is also done with patterns. And
  3105. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  3106. want to use default exclusions or not. See the section on <a
  3107. href="#directorybasedtasks">directory based tasks</a>, on how the
  3108. inclusion/exclusion of files works, and how to write patterns.</p>
  3109. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  3110. supports all attributes of <code>&lt;fileset&gt;</code>
  3111. (<code>dir</code> becomes <code>base</code>) as well as the nested
  3112. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  3113. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  3114. elements.</p>
  3115. <h3>Parameters</h3>
  3116. <table border="1" cellpadding="2" cellspacing="0">
  3117. <tr>
  3118. <td valign="top"><b>Attribute</b></td>
  3119. <td valign="top"><b>Description</b></td>
  3120. <td align="center" valign="top"><b>Required</b></td>
  3121. </tr>
  3122. <tr>
  3123. <td valign="top">base</td>
  3124. <td valign="top">the location to store the compiled files.</td>
  3125. <td valign="top" align="center">Yes</td>
  3126. </tr>
  3127. <tr>
  3128. <td valign="top">classname</td>
  3129. <td valign="top">the class for which to run <code>rmic</code>.</td>
  3130. <td valign="top" align="center">No</td>
  3131. </tr>
  3132. <tr>
  3133. <td valign="top">filtering</td>
  3134. <td valign="top">indicates whether token filtering should take place</td>
  3135. <td valign="top" align="center">No</td>
  3136. </tr>
  3137. <tr>
  3138. <td valign="top">sourcebase</td>
  3139. <td valign="top">Pass the "-keepgenerated" flag to rmic and
  3140. move the generated source file to the base directory.</td>
  3141. <td align="center" valign="top">No</td>
  3142. </tr>
  3143. <tr>
  3144. <td valign="top">stubversion</td>
  3145. <td valign="top">Specify the JDK version for the generated stub code.
  3146. Specify "1.1" to pass the "-v1.1" option to rmic.</td>
  3147. <td align="center" valign="top">No</td>
  3148. </tr>
  3149. <tr>
  3150. <td valign="top">classpath</td>
  3151. <td valign="top">The classpath to use during compilation</td>
  3152. <td align="center" valign="top">No</td>
  3153. </tr>
  3154. <tr>
  3155. <td valign="top">classpathref</td>
  3156. <td valign="top">The classpath to use during compilation, given as <a
  3157. href="#references">reference</a> to a PATH defined elsewhere</td>
  3158. <td align="center" valign="top">No</td>
  3159. </tr>
  3160. <tr>
  3161. <td valign="top">includes</td>
  3162. <td valign="top">comma separated list of patterns of files that must be
  3163. included. All files are included when omitted.</td>
  3164. <td valign="top" align="center">No</td>
  3165. </tr>
  3166. <tr>
  3167. <td valign="top">includesfile</td>
  3168. <td valign="top">the name of a file. Each line of this file is
  3169. taken to be an include pattern</td>
  3170. <td valign="top" align="center">No</td>
  3171. </tr>
  3172. <tr>
  3173. <td valign="top">excludes</td>
  3174. <td valign="top">comma separated list of patterns of files that must be
  3175. excluded. No files (except default excludes) are excluded when omitted.</td>
  3176. <td valign="top" align="center">No</td>
  3177. </tr>
  3178. <tr>
  3179. <td valign="top">excludesfile</td>
  3180. <td valign="top">the name of a file. Each line of this file is
  3181. taken to be an exclude pattern</td>
  3182. <td valign="top" align="center">No</td>
  3183. </tr>
  3184. <tr>
  3185. <td valign="top">defaultexcludes</td>
  3186. <td valign="top">indicates whether default excludes should be used or not
  3187. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  3188. <td valign="top" align="center">No</td>
  3189. </tr>
  3190. <tr>
  3191. <td valign="top">verify</td>
  3192. <td valign="top">check that classes implement Remote before handing them
  3193. to rmic (default is false)</td>
  3194. <td align="center" valign="top">No</td>
  3195. </tr>
  3196. </table>
  3197. <h3>Parameters specified as nested elements</h3>
  3198. <h4>classpath and classpathref</h4>
  3199. <p><code>Rmic</code>'s <em>classpath</em> attribute is a <a
  3200. href="#path">PATH like structure</a> and can also be set via a nested
  3201. <em>classpath</em> elements. PATHs defined elsewhere can be
  3202. <a href="#references">referred</a> to via nested <em>classpathref</em>
  3203. elements.</p>
  3204. <h3>Examples</h3>
  3205. <pre> &lt;rmic classname=&quot;com.xyz.FooBar&quot; base=&quot;${build}/classes&quot; /&gt;</pre>
  3206. <p>runs the rmic compiler for the class <code>com.xyz.FooBar</code>. The
  3207. compiled files will be stored in the directory <code>${build}/classes</code>.</p>
  3208. <pre> &lt;rmic base=&quot;${build}/classes&quot; includes=&quot;**/Remote*.class&quot; /&gt;</pre>
  3209. <p>runs the rmic compiler for all classes with <code>.class</code>
  3210. files below <code>${build}/classes</code> whose classname starts with
  3211. <i>Remote</i>. The compiled files will be stored in the directory
  3212. <code>${build}/classes</code>.</p>
  3213. <hr>
  3214. <h2><a name="signjar">SignJar</a></h2>
  3215. <h3>Description</h3>
  3216. <p>Signs a jar or zip file with the javasign command line tool.</p>
  3217. <h3>Parameters</h3>
  3218. <table border="1" cellpadding="2" cellspacing="0">
  3219. <tr>
  3220. <td valign="top"><b>Attribute</b></td>
  3221. <td valign="top"><b>Description</b></td>
  3222. <td align="center" valign="top"><b>Required</b></td>
  3223. </tr>
  3224. <tr>
  3225. <td valign="top">jar</td>
  3226. <td valign="top">the jar file to sign</td>
  3227. <td valign="top" align="center">Yes.</td>
  3228. </tr>
  3229. <tr>
  3230. <td valign="top">alias</td>
  3231. <td valign="top">the alias to sign under</td>
  3232. <td valign="top" align="center">Yes.</td>
  3233. </tr>
  3234. <tr>
  3235. <td valign="top">storepass</td>
  3236. <td valign="top">password for keystore integrity.</td>
  3237. <td valign="top" align="center">Yes.</td>
  3238. </tr>
  3239. <tr>
  3240. <td valign="top">keystore</td>
  3241. <td valign="top">keystore location</td>
  3242. <td valign="top" align="center">No</td>
  3243. </tr>
  3244. <tr>
  3245. <td valign="top">storetype</td>
  3246. <td valign="top">keystore type</td>
  3247. <td valign="top" align="center">No</td>
  3248. </tr>
  3249. <tr>
  3250. <td valign="top">keypass</td>
  3251. <td valign="top">password for private key (if different)</td>
  3252. <td valign="top" align="center">No</td>
  3253. </tr>
  3254. <tr>
  3255. <td valign="top">sigfile</td>
  3256. <td valign="top">name of .SF/.DSA file</td>
  3257. <td valign="top" align="center">No</td>
  3258. </tr>
  3259. <tr>
  3260. <td valign="top">signedjar</td>
  3261. <td valign="top">name of signed JAR file</td>
  3262. <td valign="top" align="center">No</td>
  3263. </tr>
  3264. <tr>
  3265. <td valign="top">verbose</td>
  3266. <td valign="top">(true | false) verbose output when signing</td>
  3267. <td valign="top" align="center">No</td>
  3268. </tr>
  3269. <tr>
  3270. <td valign="top">internalsf</td>
  3271. <td valign="top">(true | false) include the .SF file inside the signature
  3272. block</td>
  3273. <td valign="top" align="center">No</td>
  3274. </tr>
  3275. <tr>
  3276. <td valign="top">sectionsonly</td>
  3277. <td valign="top">(true | false) don't compute hash of entire manifest</td>
  3278. <td valign="top" align="center">No</td>
  3279. </tr>
  3280. </table>
  3281. <h3>Examples</h3>
  3282. <blockquote>
  3283. <p><code>&lt;signjar jar=&quot;${dist}/lib/ant.jar&quot;
  3284. alias=&quot;apache-group&quot; storepass=&quot;secret&quot; /&gt;</code></p>
  3285. </blockquote>
  3286. <p>signs the ant.jar with alias &quot;apache-group&quot; accessing the
  3287. keystore and private key via &quot;secret&quot; password.</p>
  3288. <hr>
  3289. <h2><a name="tar">Tar</a></h2>
  3290. <h3>Description</h3>
  3291. <p>Creates a tar archive.</p>
  3292. <p>The <i>basedir</i> attribute is the reference directory from where to tar.</p>
  3293. <p>It is possible to refine the set of files that are being tarred. This can be
  3294. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  3295. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  3296. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  3297. the files you want to have excluded. This is also done with patterns. And
  3298. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  3299. want to use default exclusions or not. See the section on <a
  3300. href="#directorybasedtasks">directory based tasks</a>, on how the
  3301. inclusion/exclusion of files works, and how to write patterns.</p>
  3302. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  3303. supports all attributes of <code>&lt;fileset&gt;</code>
  3304. (<code>dir</code> becomes <code>basedir</code>) as well as the nested
  3305. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  3306. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  3307. elements.</p>
  3308. <p>Note that this task does not perform compression. You might want to use the <a href="#gzip">GZip</a>
  3309. task to come up with a .tar.gz package.</p>
  3310. <h3>Parameters</h3>
  3311. <table border="1" cellpadding="2" cellspacing="0">
  3312. <tr>
  3313. <td valign="top"><b>Attribute</b></td>
  3314. <td valign="top"><b>Description</b></td>
  3315. <td valign="top" align="center"><b>Required</b></td>
  3316. </tr>
  3317. <tr>
  3318. <td valign="top">tarfile</td>
  3319. <td valign="top">the tar-file to create.</td>
  3320. <td align="center" valign="top">Yes</td>
  3321. </tr>
  3322. <tr>
  3323. <td valign="top">basedir</td>
  3324. <td valign="top">the directory from which to zip the files.</td>
  3325. <td align="center" valign="top">Yes</td>
  3326. </tr>
  3327. <tr>
  3328. <td valign="top">includes</td>
  3329. <td valign="top">comma separated list of patterns of files that must be
  3330. included. All files are included when omitted.</td>
  3331. <td valign="top" align="center">No</td>
  3332. </tr>
  3333. <tr>
  3334. <td valign="top">includesfile</td>
  3335. <td valign="top">the name of a file. Each line of this file is
  3336. taken to be an include pattern</td>
  3337. <td valign="top" align="center">No</td>
  3338. </tr>
  3339. <tr>
  3340. <td valign="top">excludes</td>
  3341. <td valign="top">comma separated list of patterns of files that must be
  3342. excluded. No files (except default excludes) are excluded when omitted.</td>
  3343. <td valign="top" align="center">No</td>
  3344. </tr>
  3345. <tr>
  3346. <td valign="top">excludesfile</td>
  3347. <td valign="top">the name of a file. Each line of this file is
  3348. taken to be an exclude pattern</td>
  3349. <td valign="top" align="center">No</td>
  3350. </tr>
  3351. <tr>
  3352. <td valign="top">defaultexcludes</td>
  3353. <td valign="top">indicates whether default excludes should be used or not
  3354. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  3355. <td valign="top" align="center">No</td>
  3356. </tr>
  3357. </table>
  3358. <h3>Examples</h3>
  3359. <pre> &lt;tar tarfile=&quot;${dist}/manual.tar&quot; basedir=&quot;htdocs/manual&quot; /&gt;
  3360. &lt;gzip zipfile=&quot;${dist}/manual.tar.gz&quot; src=&quot;${dist}/manual.tar&quot; /&gt;</pre>
  3361. <p>tars all files in the <code>htdocs/manual</code> directory in a file called <code>manual.tar</code>
  3362. in the <code>${dist}</code> directory, then applies the gzip task to compress
  3363. it.</p>
  3364. <pre> &lt;tar tarfile=&quot;${dist}/manual.tar&quot;
  3365. basedir=&quot;htdocs/manual&quot;
  3366. excludes=&quot;mydocs/**, **/todo.html&quot;
  3367. /&gt;</pre>
  3368. <p>tars all files in the <code>htdocs/manual</code> directory in a file called <code>manual.tar</code>
  3369. in the <code>${dist}</code> directory. Files in the directory <code>mydocs</code>,
  3370. or files with the name <code>todo.html</code> are excluded.</p>
  3371. <hr>
  3372. <h2><a name="taskdef">Taskdef</a></h2>
  3373. <h3>Description</h3>
  3374. <p>Adds a task definition to the current project, such that this new task can be
  3375. used in the current project. Two attributes are needed, the name that identifies
  3376. this task uniquely, and the full name of the class (including the packages) that
  3377. implements this task.</p>
  3378. <p>Taskdef should be used to add your own tasks to the system. See also &quot;<a
  3379. href="#writingowntask">Writing your own task</a>&quot;.</p>
  3380. <h3>Parameters</h3>
  3381. <table border="1" cellpadding="2" cellspacing="0">
  3382. <tr>
  3383. <td valign="top"><b>Attribute</b></td>
  3384. <td valign="top"><b>Description</b></td>
  3385. <td align="center" valign="top"><b>Required</b></td>
  3386. </tr>
  3387. <tr>
  3388. <td valign="top">name</td>
  3389. <td valign="top">the name of the task</td>
  3390. <td valign="top" align="center">Yes</td>
  3391. </tr>
  3392. <tr>
  3393. <td valign="top">classname</td>
  3394. <td valign="top">the full class name implementing the task</td>
  3395. <td valign="top" align="center">Yes</td>
  3396. </tr>
  3397. </table>
  3398. <h3>Examples</h3>
  3399. <pre> &lt;taskdef name=&quot;myjavadoc&quot; classname=&quot;com.mydomain.JavadocTask&quot; /&gt;</pre>
  3400. <p>makes a task called <code>myjavadoc</code> available to Ant. The class <code>com.mydomain.JavadocTask</code>
  3401. implements the task.</p>
  3402. <hr>
  3403. <h2><a name="touch">Touch</a></h2>
  3404. <h3>Description</h3>
  3405. <p>Changes the modification time of a file and possibly creates it at
  3406. the same time.</p>
  3407. <p>For JDK 1.1 only the creation of new files with a modification time
  3408. of now works, all other cases will emit a warning.</p>
  3409. <h3>Parameters</h3>
  3410. <table border="1" cellpadding="2" cellspacing="0">
  3411. <tr>
  3412. <td valign="top"><b>Attribute</b></td>
  3413. <td valign="top"><b>Description</b></td>
  3414. <td align="center" valign="top"><b>Required</b></td>
  3415. </tr>
  3416. <tr>
  3417. <td valign="top">file</td>
  3418. <td valign="top">the name of the file</td>
  3419. <td valign="top" align="center">Yes</td>
  3420. </tr>
  3421. <tr>
  3422. <td valign="top">millis</td>
  3423. <td valign="top">specifies the new modification time of the file
  3424. in milliseconds since midnight Jan 1 1970</td>
  3425. <td valign="top" align="center">No</td>
  3426. </tr>
  3427. <tr>
  3428. <td valign="top">datetime</td>
  3429. <td valign="top">specifies the new modification time of the file
  3430. in the format MM/DD/YYYY HH:MM AM_or_PM.</td>
  3431. <td valign="top" align="center">No</td>
  3432. </tr>
  3433. </table>
  3434. <p>If both <code>millis</code> and <code>datetime</code> are omitted
  3435. the current time is assumed.</p>
  3436. <h3>Examples</h3>
  3437. <pre> &lt;touch file=&quot;myfile&quot; /&gt;</pre>
  3438. <p>creates <code>myfile</code> if it doesn't exist and changes the
  3439. modification time to the current time.</p>
  3440. <pre> &lt;touch file=&quot;myfile&quot; datetime=&quot;06/28/2000 2:02 pm&quot; /&gt;</pre>
  3441. <p>creates <code>myfile</code> if it doesn't exist and changes the
  3442. modification time to Jun, 28 2000 2:02 pm (14:02 for those used to 24
  3443. hour times).</p>
  3444. <hr>
  3445. <h2><a name="tstamp">Tstamp</a></h2>
  3446. <h3>Description</h3>
  3447. <p>Sets the DSTAMP, TSTAMP and TODAY properties in the current project. The
  3448. DSTAMP is in the &quot;yyyymmdd&quot; format, the TSTAMP is in the &quot;hhmm&quot;
  3449. format and TODAY is &quot;month day year&quot;.</p>
  3450. <p>These properties can be used in the buildfile, for instance, to create
  3451. timestamped filenames or used to replace placeholder tags inside documents to
  3452. indicate, for example, the release date. The best place for this task is in your
  3453. initialization target.</p>
  3454. <h3>Parameters</h3>
  3455. <table border="1" cellpadding="2" cellspacing="0">
  3456. <tr>
  3457. <td valign="top"><b>Attribute</b></td>
  3458. <td valign="top"><b>Description</b></td>
  3459. <td align="center" valign="top"><b>Required</b></td>
  3460. </tr>
  3461. </table>
  3462. <h3>Examples</h3>
  3463. <pre> &lt;tstamp/&gt;</pre>
  3464. <hr>
  3465. <h2><a name="style">Style</a></h2>
  3466. <h3>Description</h3>
  3467. <p>Process a set of documents via XSLT.</p>
  3468. <p>This is useful for building views of XML based documentation,
  3469. or in generating code.</p>
  3470. <p>It is possible to refine the set of files that are being copied. This can be
  3471. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  3472. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  3473. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  3474. the files you want to have excluded. This is also done with patterns. And
  3475. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  3476. want to use default exclusions or not. See the section on <a
  3477. href="#directorybasedtasks">directory based tasks</a>, on how the
  3478. inclusion/exclusion of files works, and how to write patterns.</p>
  3479. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  3480. supports all attributes of <code>&lt;fileset&gt;</code>
  3481. (<code>dir</code> becomes <code>basedir</code>) as well as the nested
  3482. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  3483. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  3484. elements.</p>
  3485. <h3>Parameters</h3>
  3486. <table border="1" cellpadding="2" cellspacing="0">
  3487. <tr>
  3488. <td valign="top"><b>Attribute</b></td>
  3489. <td valign="top"><b>Description</b></td>
  3490. <td align="center" valign="top"><b>Required</b></td>
  3491. </tr>
  3492. <tr>
  3493. <td valign="top">basedir</td>
  3494. <td valign="top">where to find the source xml file.</td>
  3495. <td align="center" valign="top">Yes</td>
  3496. </tr>
  3497. <tr>
  3498. <td valign="top">destdir</td>
  3499. <td valign="top">directory where to store the results.</td>
  3500. <td align="center" valign="top">Yes</td>
  3501. </tr>
  3502. <tr>
  3503. <td valign="top">extension</td>
  3504. <td valign="top">desired file extension to be used for the targets.
  3505. If not specified, the default is "html".</td>
  3506. <td align="center" valign="top">No</td>
  3507. </tr>
  3508. <tr>
  3509. <td valign="top">style</td>
  3510. <td valign="top">name of the stylesheet to use.</td>
  3511. <td align="center" valign="top">Yes</td>
  3512. </tr>
  3513. <tr>
  3514. <td valign="top">processor</td>
  3515. <td valign="top">name of the XSLT processor to use. Permissible
  3516. values are "xslp" for the XSL:P processor, "xalan" for the Apache XML Xalan
  3517. processor, or the name of an arbitrary XSLTLiaison class.
  3518. Defaults to xslp or xalan (in that order), if one is found in your
  3519. class path</td>
  3520. <td align="center" valign="top">No</td>
  3521. </tr>
  3522. <tr>
  3523. <td valign="top">includes</td>
  3524. <td valign="top">comma separated list of patterns of files that must be
  3525. included. All files are included when omitted.</td>
  3526. <td valign="top" align="center">No</td>
  3527. </tr>
  3528. <tr>
  3529. <td valign="top">includesfile</td>
  3530. <td valign="top">the name of a file. Each line of this file is
  3531. taken to be an include pattern</td>
  3532. <td valign="top" align="center">No</td>
  3533. </tr>
  3534. <tr>
  3535. <td valign="top">excludes</td>
  3536. <td valign="top">comma separated list of patterns of files that must be
  3537. excluded. No files (except default excludes) are excluded when omitted.</td>
  3538. <td valign="top" align="center">No</td>
  3539. </tr>
  3540. <tr>
  3541. <td valign="top">excludesfile</td>
  3542. <td valign="top">the name of a file. Each line of this file is
  3543. taken to be an exclude pattern</td>
  3544. <td valign="top" align="center">No</td>
  3545. </tr>
  3546. <tr>
  3547. <td valign="top">defaultexcludes</td>
  3548. <td valign="top">indicates whether default excludes should be used or not
  3549. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  3550. <td valign="top" align="center">No</td>
  3551. </tr>
  3552. </table>
  3553. <h3>Examples</h3>
  3554. <blockquote>
  3555. <p><pre>
  3556. &lt;style basedir=&quot;doc&quot; destdir=&quot;build/doc&quot;
  3557. extension=&quot;html&quot; style=&quot;style/apache.xml&quot;/&gt;
  3558. </pre></p>
  3559. </blockquote>
  3560. <hr>
  3561. <h2><a name="unzip">Unjar/Unzip</a></h2>
  3562. <h3>Description</h3>
  3563. <p>Unzips a zip- or jarfile.</p>
  3564. <p>For JDK 1.1 "last modified time" field is set to current time instead of being
  3565. carried from zipfile.</p>
  3566. <p>File permissions will not be restored on extracted files.</a>
  3567. <h3>Parameters</h3>
  3568. <table border="1" cellpadding="2" cellspacing="0">
  3569. <tr>
  3570. <td valign="top"><b>Attribute</b></td>
  3571. <td valign="top"><b>Description</b></td>
  3572. <td align="center" valign="top"><b>Required</b></td>
  3573. </tr>
  3574. <tr>
  3575. <td valign="top">src</td>
  3576. <td valign="top">zipfile to expand.</td>
  3577. <td align="center" valign="top">Yes</td>
  3578. </tr>
  3579. <tr>
  3580. <td valign="top">dest</td>
  3581. <td valign="top">directory where to store the expanded files.</td>
  3582. <td align="center" valign="top">Yes</td>
  3583. </tr>
  3584. </table>
  3585. <h3>Examples</h3>
  3586. <blockquote>
  3587. <p><code>&lt;unzip src=&quot;${tomcat_src}/tools-src.zip&quot; dest=&quot;${tools.home}&quot;
  3588. /&gt;</code></p>
  3589. </blockquote>
  3590. <hr>
  3591. <h2><a name="untar">Untar</a></h2>
  3592. <h3>Description</h3>
  3593. <p>Untars a tarfile.</p>
  3594. <p>File permissions will not be restored on extracted files.</a>
  3595. <p>For JDK 1.1 "last modified time" field is set to current time instead of being
  3596. carried from tarfile.</p>
  3597. <h3>Parameters</h3>
  3598. <table border="1" cellpadding="2" cellspacing="0">
  3599. <tr>
  3600. <td valign="top"><b>Attribute</b></td>
  3601. <td valign="top"><b>Description</b></td>
  3602. <td align="center" valign="top"><b>Required</b></td>
  3603. </tr>
  3604. <tr>
  3605. <td valign="top">src</td>
  3606. <td valign="top">tarfile to expand.</td>
  3607. <td align="center" valign="top">Yes</td>
  3608. </tr>
  3609. <tr>
  3610. <td valign="top">dest</td>
  3611. <td valign="top">directory where to store the expanded files.</td>
  3612. <td align="center" valign="top">Yes</td>
  3613. </tr>
  3614. </table>
  3615. <h3>Examples</h3>
  3616. <blockquote>
  3617. <p><code>
  3618. &lt;gunzip src=&quot;tools.tar.gz&quot;/&gt;<br>
  3619. &lt;untar src=&quot;tools.tar&quot; dest=&quot;${tools.home}&quot;/&gt;
  3620. </code></p>
  3621. </blockquote>
  3622. <hr>
  3623. <h2><a name="zip">Zip</a></h2>
  3624. <h3>Description</h3>
  3625. <p>Creates a zipfile.</p>
  3626. <p>The <i>basedir</i> attribute is the reference directory from where to zip.</p>
  3627. <p>Note that file permissions will not be stored in the resulting zipfile.</p>
  3628. <p>It is possible to refine the set of files that are being zipped. This can be
  3629. done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and <i>defaultexcludes</i>
  3630. attributes. With the <i>includes</i> or <i>includesfile</i> attribute you specify the files you want to
  3631. have included by using patterns. The <i>exclude</i> or <i>excludesfile</i> attribute is used to specify
  3632. the files you want to have excluded. This is also done with patterns. And
  3633. finally with the <i>defaultexcludes</i> attribute, you can specify whether you
  3634. want to use default exclusions or not. See the section on <a
  3635. href="#directorybasedtasks">directory based tasks</a>, on how the
  3636. inclusion/exclusion of files works, and how to write patterns.
  3637. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  3638. supports all attributes of <code>&lt;fileset&gt;</code>
  3639. (<code>dir</code> becomes <code>basedir</code>) as well as the nested
  3640. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  3641. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  3642. elements.</p>
  3643. <p>Or, you may place within it nested file sets, or references to file sets.
  3644. In this case <code>basedir</code> is optional; the implicit file set is <em>only used</em>
  3645. if <code>basedir</code> is set. You may use any mixture of the implicit file set
  3646. (with <code>basedir</code> set, and optional attributes like <code>includes</code>
  3647. and optional subelements like <code>&lt;include&gt;</code>); explicit nested
  3648. <code>&lt;fileset&gt;</code> elements; and nested <code>&lt;filesetref&gt;</code>
  3649. elements; so long as at least one fileset total is specified. The ZIP file will
  3650. only reflect the relative paths of files <em>within</em> each fileset.</p>
  3651. <p>The <code>whenempty</code> parameter controls what happens when no files match.
  3652. If <code>skip</code> (the default), the ZIP is not created and a warning is issued.
  3653. If <code>fail</code>, the ZIP is not created and the build is halted with an error.
  3654. If <code>create</code>, an empty ZIP file (explicitly zero entries) is created,
  3655. which should be recognized as such by compliant ZIP manipulation tools.</p>
  3656. <h3>Parameters</h3>
  3657. <table border="1" cellpadding="2" cellspacing="0">
  3658. <tr>
  3659. <td valign="top"><b>Attribute</b></td>
  3660. <td valign="top"><b>Description</b></td>
  3661. <td valign="top" align="center"><b>Required</b></td>
  3662. </tr>
  3663. <tr>
  3664. <td valign="top">zipfile</td>
  3665. <td valign="top">the zip-file to create.</td>
  3666. <td align="center" valign="top">Yes</td>
  3667. </tr>
  3668. <tr>
  3669. <td valign="top">basedir</td>
  3670. <td valign="top">the directory from which to zip the files.</td>
  3671. <td align="center" valign="top">No</td>
  3672. </tr>
  3673. <tr>
  3674. <td valign="top">compress</td>
  3675. <td valign="top">Not only store data but also compress them, defaults to true</td>
  3676. <td align="center" valign="top">No</td>
  3677. </tr>
  3678. <tr>
  3679. <td valign="top">includes</td>
  3680. <td valign="top">comma separated list of patterns of files that must be
  3681. included. All files are included when omitted.</td>
  3682. <td valign="top" align="center">No</td>
  3683. </tr>
  3684. <tr>
  3685. <td valign="top">includesfile</td>
  3686. <td valign="top">the name of a file. Each line of this file is
  3687. taken to be an include pattern</td>
  3688. <td valign="top" align="center">No</td>
  3689. </tr>
  3690. <tr>
  3691. <td valign="top">excludes</td>
  3692. <td valign="top">comma separated list of patterns of files that must be
  3693. excluded. No files (except default excludes) are excluded when omitted.</td>
  3694. <td valign="top" align="center">No</td>
  3695. </tr>
  3696. <tr>
  3697. <td valign="top">excludesfile</td>
  3698. <td valign="top">the name of a file. Each line of this file is
  3699. taken to be an exclude pattern</td>
  3700. <td valign="top" align="center">No</td>
  3701. </tr>
  3702. <tr>
  3703. <td valign="top">defaultexcludes</td>
  3704. <td valign="top">indicates whether default excludes should be used or not
  3705. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
  3706. <td valign="top" align="center">No</td>
  3707. </tr>
  3708. <tr>
  3709. <td valign="top">whenempty</td>
  3710. <td valign="top">Behavior when no files match.</td>
  3711. <td valign="top" align="center">No</td>
  3712. </tr>
  3713. </table>
  3714. <h3>Examples</h3>
  3715. <pre> &lt;zip zipfile=&quot;${dist}/manual.zip&quot;
  3716. basedir=&quot;htdocs/manual&quot;
  3717. /&gt;</pre>
  3718. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>
  3719. in the <code>${dist}</code> directory.</p>
  3720. <pre> &lt;zip zipfile=&quot;${dist}/manual.zip&quot;
  3721. basedir=&quot;htdocs/manual&quot;
  3722. excludes=&quot;mydocs/**, **/todo.html&quot;
  3723. /&gt;</pre>
  3724. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>
  3725. in the <code>${dist}</code> directory. Files in the directory <code>mydocs</code>,
  3726. or files with the name <code>todo.html</code> are excluded.</p>
  3727. <pre> &lt;zip zipfile=&quot;${dist}/manual.zip&quot;
  3728. basedir=&quot;htdocs/manual&quot;
  3729. includes=&quot;api/**/*.html&quot;
  3730. excludes=&quot;**/todo.html&quot;
  3731. /&gt;</pre>
  3732. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>
  3733. in the <code>${dist}</code> directory. Only html files under the directory <code>api</code>
  3734. are zipped, and files with the name <code>todo.html</code> are excluded.</p>
  3735. <pre> &lt;zip zipfile=&quot;${dist}/manual.zip&quot;&gt;
  3736. &lt;fileset dir=&quot;htdocs/manual&quot;/&gt;
  3737. &lt;fileset dir=&quot;.&quot; includes=&quot;ChangeLog.txt&quot;/&gt;
  3738. &lt;/zip&gt;</pre>
  3739. <p>zips all files in the <code>htdocs/manual</code> directory in a file called <code>manual.zip</code>
  3740. in the <code>${dist}</code> directory, and also adds the file <code>ChangeLog.txt</code> in the
  3741. current directory. <code>ChangeLog.txt</code> will be added to the top of the ZIP file, just as if
  3742. it had been located at <code>htdocs/manual/ChangeLog.txt</code>.</p>
  3743. <hr>
  3744. <h2><a name="optionaltasks">Optional tasks</a></h2>
  3745. <ul>
  3746. <li><a href="#cab">Cab</a></li>
  3747. <li><a href="#ftp">FTP</a></li>
  3748. <li><a href="junit.html">JUnit</a></li>
  3749. <li><a href="#netrexxc">NetRexxC</a></li>
  3750. <li><a href="#renameexts">RenameExtensions</a></li>
  3751. <li><a href="#script">Script</a></li>
  3752. <li><a href="#vssget">VssGet</a></li>
  3753. <li><a href="ejb.html">EJB Tasks</a></li>
  3754. </ul>
  3755. <hr>
  3756. <h2><a name="cab">Cab</a></h2>
  3757. <h3><b>Description:</b></h3>
  3758. <p>The cab task creates Microsoft cab archive files. It is invoked
  3759. similar to the <a href="#jar">jar</a> or <a href="#zip">zip</a> tasks.
  3760. This task will only work on Windows, and will be silently ignored on
  3761. other platforms. You must have the Microsoft cabarc tool available in
  3762. your executable path.</p>
  3763. <p>See the section on <a href="#directorybasedtasks">directory based
  3764. tasks</a>, on how the inclusion/exclusion of files works, and how to
  3765. write patterns.</p>
  3766. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  3767. supports all attributes of <code>&lt;fileset&gt;</code>
  3768. (<code>dir</code> becomes <code>basedir</code>) as well as the nested
  3769. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  3770. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  3771. elements.</p>
  3772. <h3>Parameters:</h3>
  3773. <table border="1" cellpadding="2" cellspacing="0">
  3774. <tr>
  3775. <td valign="top"><b>Attribute</b></td>
  3776. <td valign="top"><b>Description</b></td>
  3777. <td align="center" valign="top"><b>Required</b></td>
  3778. </tr>
  3779. <tr>
  3780. <td valign="top">cabfile</td>
  3781. <td valign="top">the name of the cab file to create.</td>
  3782. <td valign="top" align="center">Yes</td>
  3783. </tr>
  3784. <tr>
  3785. <td valign="top">basedir</td>
  3786. <td valign="top">the directory to start archiving files from.</td>
  3787. <td valign="top" align="center">Yes</td>
  3788. </tr>
  3789. <tr>
  3790. <td valign="top">verbose</td>
  3791. <td valign="top">set to "yes" if you want to see the output from
  3792. the cabarc tool. defaults to "no".</td>
  3793. <td valign="top" align="center">No</td>
  3794. </tr>
  3795. <tr>
  3796. <td valign="top">compress</td>
  3797. <td valign="top">set to "no" to store files without compressing.
  3798. defaults to "yes".</td>
  3799. <td valign="top" align="center">No</td>
  3800. </tr>
  3801. <tr>
  3802. <td valign="top">options</td>
  3803. <td valign="top">use to set additional command-line options for
  3804. the cabarc tool. should not normally be necessary.</td>
  3805. <td valign="top" align="center">No</td>
  3806. </tr>
  3807. <tr>
  3808. <td valign="top">includes</td>
  3809. <td valign="top">comma separated list of patterns of files that
  3810. must be included. All files are included when omitted.</td>
  3811. <td valign="top" align="center">No</td>
  3812. </tr>
  3813. <tr>
  3814. <td valign="top">includesfile</td>
  3815. <td valign="top">the name of a file. Each line of this file is
  3816. taken to be an include pattern</td>
  3817. <td valign="top" align="center">No</td>
  3818. </tr>
  3819. <tr>
  3820. <td valign="top">excludes</td>
  3821. <td valign="top">comma separated list of patterns of files that
  3822. must be excluded. No files (except default excludes) are excluded
  3823. when omitted.</td>
  3824. <td valign="top" align="center">No</td>
  3825. </tr>
  3826. <tr>
  3827. <td valign="top">excludesfile</td>
  3828. <td valign="top">the name of a file. Each line of this file is
  3829. taken to be an exclude pattern</td>
  3830. <td valign="top" align="center">No</td>
  3831. </tr>
  3832. <tr>
  3833. <td valign="top">defaultexcludes</td>
  3834. <td valign="top">indicates whether default excludes should be used
  3835. or not ("yes"/"no"). Default excludes are used when omitted.</td>
  3836. <td valign="top" align="center">No</td>
  3837. </tr>
  3838. </table>
  3839. <h3>Examples</h3>
  3840. <blockquote><pre>
  3841. &lt;cab cabfile="${dist}/manual.cab"
  3842. basedir="htdocs/manual"
  3843. /&gt;
  3844. </pre></blockquote>
  3845. <p>cabs all files in the htdocs/manual directory in a file called
  3846. manual.cab in the ${dist} directory.</p>
  3847. <blockquote><pre>
  3848. &lt;cab cabfile="${dist}/manual.cab"
  3849. basedir="htdocs/manual"
  3850. excludes="mydocs/**, **/todo.html"
  3851. /&gt;
  3852. </pre></blockquote>
  3853. <p>cabs all files in the htdocs/manual directory in a file called
  3854. manual.cab in the ${dist} directory. Files in the directory mydocs,
  3855. or files with the name todo.html are excluded.</p>
  3856. <blockquote><pre>
  3857. &lt;cab cabfile="${dist}/manual.cab"
  3858. basedir="htdocs/manual"
  3859. includes="api/**/*.html"
  3860. excludes="**/todo.html"
  3861. verbose="yes"
  3862. /&gt;
  3863. </pre></blockquote>
  3864. <p>cab all files in the htdocs/manual directory in a file called
  3865. manual.cab in the ${dist} directory. Only html files under the
  3866. directory api are archived, and files with the name todo.html are
  3867. excluded. Output from the cabarc tool is displayed in the build
  3868. output.</p>
  3869. <hr>
  3870. <h2><a name="ftp">FTP</a></h2>
  3871. <h3><b>Description:</b></h3>
  3872. <p>The ftp task implements a basic FTP client that can send, receive,
  3873. list, and delete files. See below for descriptions and examples of how
  3874. to perform each task.</p>
  3875. <p>The ftp task makes no attempt to determine what file system syntax is
  3876. required by the remote server, and defaults to Unix standards.
  3877. <i>remotedir</i> must be specified in the exact syntax required by the ftp
  3878. server. If the usual Unix conventions are not supported by the server,
  3879. <i>separator</i> can be used to set the file separator that should be used
  3880. instead.</p>
  3881. <p>See the section on <a href="#directorybasedtasks">directory based
  3882. tasks</a>, on how the inclusion/exclusion of files works, and how to
  3883. write patterns.</p>
  3884. <h3>Parameters:</h3>
  3885. <table border="1" cellpadding="2" cellspacing="0">
  3886. <tr>
  3887. <td valign="top"><b>Attribute</b></td>
  3888. <td valign="top"><b>Description</b></td>
  3889. <td align="center" valign="top"><b>Required</b></td>
  3890. </tr>
  3891. <tr>
  3892. <td valign="top">server</td>
  3893. <td valign="top">the address of the remote ftp server.</td>
  3894. <td valign="top" align="center">Yes</td>
  3895. </tr>
  3896. <tr>
  3897. <td valign="top">port</td>
  3898. <td valign="top">the port number of the remote ftp server.
  3899. Defaults to port 21.</td>
  3900. <td valign="top" align="center">No</td>
  3901. </tr>
  3902. <tr>
  3903. <td valign="top">userid</td>
  3904. <td valign="top">the login id to use on the ftp server.</td>
  3905. <td valign="top" align="center">Yes</td>
  3906. </tr>
  3907. <tr>
  3908. <td valign="top">password</td>
  3909. <td valign="top">the login password to use on the ftp server.</td>
  3910. <td valign="top" align="center">Yes</td>
  3911. </tr>
  3912. <tr>
  3913. <td valign="top">remotedir</td>
  3914. <td valign="top">the directory to which to upload files on the
  3915. ftp server.</td>
  3916. <td valign="top" align="center">No</td>
  3917. </tr>
  3918. <tr>
  3919. <td valign="top">action</td>
  3920. <td valign="top">the ftp action to perform, defaulting to &quot;send&quot;.
  3921. Currently supports&quot;put&quot;, &quot;get&quot;,
  3922. &quot;del&quot;, and &quot;list&quot;.</td>
  3923. <td valign="top" align="center">No</td>
  3924. </tr>
  3925. <tr>
  3926. <td valign="top">binary</td>
  3927. <td valign="top">selects binary-mode (&quot;yes&quot;) or text-mode
  3928. (&quot;no&quot;) transfers.
  3929. Defaults to &quot;yes&quot;</td>
  3930. <td valign="top" align="center">No</td>
  3931. </tr>
  3932. <tr>
  3933. <td valign="top">verbose</td>
  3934. <td valign="top">displays information on each file transferred if set
  3935. to &quot;yes&quot;. Defaults to &quot;no&quot;.</td>
  3936. <td valign="top" align="center">No</td>
  3937. </tr>
  3938. <tr>
  3939. <td valign="top">depends</td>
  3940. <td valign="top">transfers only new or changed files if set to
  3941. &quot;yes&quot;. Defaults to &quot;no&quot;.</td>
  3942. <td valign="top" align="center">No</td>
  3943. </tr>
  3944. <tr>
  3945. <td valign="top">newer</td>
  3946. <td valign="top">a synonym for <i>depends</i>.</td>
  3947. <td valign="top" align="center">No</td>
  3948. </tr>
  3949. <tr>
  3950. <td valign="top">separator</td>
  3951. <td valign="top">sets the file separator used on the ftp server.
  3952. Defaults to &quot;/&quot;.</td>
  3953. <td valign="top" align="center">No</td>
  3954. </tr>
  3955. <tr>
  3956. <td valign="top">listing</td>
  3957. <td valign="top">the file to write results of the &quot;list&quot; action.
  3958. Required for the &quot;list&quot; action, ignored otherwise.</td>
  3959. <td valign="top" align="center">No</td>
  3960. </tr>
  3961. </table>
  3962. <h3>Sending Files</h3>
  3963. <p>The easiest way to describe how to send files is with a couple of examples:</p>
  3964. <pre>
  3965. &lt;ftp server=&quot;ftp.apache.org&quot;
  3966. userid=&quot;anonymous&quot;
  3967. password=&quot;me@myorg.com&quot;&gt;
  3968. &lt;fileset dir=&quot;htdocs/manual&quot; /&gt;
  3969. &lt;/ftp&gt;
  3970. </pre>
  3971. <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
  3972. uploads all files in the <code>htdocs/manual</code> directory
  3973. to the default directory for that user.</p>
  3974. <pre> &lt;ftp server=&quot;ftp.apache.org&quot;
  3975. remotedir=&quot;incoming&quot;
  3976. userid=&quot;anonymous&quot;
  3977. password=&quot;me@myorg.com&quot;
  3978. depends=&quot;yes&quot;
  3979. &gt;
  3980. &lt;fileset dir=&quot;htdocs/manual&quot; /&gt;
  3981. &lt;/ftp&gt;</pre>
  3982. <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
  3983. uploads all new or changed files in the <code>htdocs/manual</code> directory
  3984. to the <code>incoming</code> directory relative to the default directory
  3985. for <code>anonymous</code>.</p>
  3986. <pre> &lt;ftp server=&quot;ftp.apache.org&quot;
  3987. port=&quot;2121&quot;
  3988. remotedir=&quot;/pub/incoming&quot;
  3989. userid=&quot;coder&quot;
  3990. password=&quot;java1&quot;
  3991. depends=&quot;yes&quot;
  3992. binary=&quot;no&quot;
  3993. &gt;
  3994. &lt;fileset dir=&quot;htdocs/manual&quot;&gt;
  3995. &lt;include name=&quot;**/*.html&quot; /&gt;
  3996. &lt;/fileset&gt;
  3997. &lt;/ftp&gt;</pre>
  3998. <p>Logs in to <code>ftp.apache.org</code> at port <code>2121</code> as
  3999. <code>coder</code> with password <code>java1</code> and uploads all new or
  4000. changed HTML files in the <code>htdocs/manual</code> directory to the
  4001. <code>/pub/incoming</code> directory. The files are transferred in text
  4002. mode.</p>
  4003. <pre> &lt;ftp server=&quot;ftp.nt.org&quot;
  4004. remotedir=&quot;c:\uploads&quot;
  4005. userid=&quot;coder&quot;
  4006. password=&quot;java1&quot;
  4007. separator=&quot;\&quot;
  4008. verbose=&quot;yes&quot;
  4009. &gt;
  4010. &lt;fileset dir=&quot;htdocs/manual&quot;&gt;
  4011. &lt;include name=&quot;**/*.html&quot; /&gt;
  4012. &lt;/fileset&gt;
  4013. &lt;/ftp&gt;</pre>
  4014. <p>Logs in to the Windows-based <code>ftp.nt.org</code> as
  4015. <code>coder</code> with password <code>java1</code> and uploads all
  4016. HTML files in the <code>htdocs/manual</code> directory to the
  4017. <code>c:\uploads</code> directory. Progress messages are displayed as each
  4018. file is uploaded.</p>
  4019. <h3>Getting Files</h3>
  4020. <p>Getting files from an FTP server works pretty much the same way as
  4021. sending them does. The only difference is that the nested filesets
  4022. use the remotedir attribute as the base directory for the files on the
  4023. FTP server, and the dir attribute as the local directory to put the files
  4024. into. The file structure from the FTP site is preserved on the local machine.</p>
  4025. <pre>
  4026. &lt;ftp action="get"
  4027. server=&quot;ftp.apache.org&quot;
  4028. userid=&quot;anonymous&quot;
  4029. password=&quot;me@myorg.com&quot;&gt;
  4030. &lt;fileset dir=&quot;htdocs/manual&quot; &gt;
  4031. &lt;include name=&quot;**/*.html&quot; /&gt;
  4032. &lt;/fileset&gt;
  4033. &lt;/ftp&gt;
  4034. </pre>
  4035. <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
  4036. recursively downloads all .html files from default directory for that user
  4037. into the <code>htdocs/manual</code> directory on the local machine.</p>
  4038. <h3>Deleting Files</h3>
  4039. As you've probably guessed by now, you use nested fileset elements to
  4040. select the files to delete from the remote FTP server. Again, the
  4041. filesets are relative to the remote directory, not a local directory. In
  4042. fact, the dir attribute of the fileset is ignored completely.
  4043. <pre>
  4044. &lt;ftp action="del"
  4045. server=&quot;ftp.apache.org&quot;
  4046. userid=&quot;anonymous&quot;
  4047. password=&quot;me@myorg.com&quot; &gt;
  4048. &lt;fileset&gt;
  4049. &lt;include name=&quot;**/*.tmp&quot; /&gt;
  4050. &lt;/fileset&gt;
  4051. &lt;/ftp&gt;
  4052. </pre>
  4053. <p>Logs in to <code>ftp.apache.org</code> as <code>anonymous</code> and
  4054. tries to delete all *.tmp files from the default directory for that user.
  4055. If you don't have permission to delete a file, a BuildException is thrown.</p>
  4056. <h3>Listing Files</h3>
  4057. <pre>
  4058. &lt;ftp action="list"
  4059. server=&quot;ftp.apache.org&quot;
  4060. userid=quot;anonymous&quot;
  4061. password=&quot;me@myorg.com&quot;
  4062. listing=&quot;data/ftp.listing&quot; &gt;
  4063. &lt;fileset&gt;
  4064. &lt;include name=&quot;**&quot; /&gt;
  4065. &lt;/fileset&gt;
  4066. &lt;/ftp&gt;
  4067. </pre>
  4068. <p>This provides a file listing in <code>data/ftp.listing</code> of all the files on
  4069. the FTP server relative to the default directory of the <code>anonymous</code>
  4070. user. �The listing is in whatever format the FTP server normally lists files.</p>
  4071. <hr>
  4072. <h2><a name="netrexxc">NetRexxC</a></h2>
  4073. <h3><b>Description:</b></h3>
  4074. <p>Compiles a <a href="http://www2.hursley.ibm.com/netrexx">NetRexx</a>
  4075. source tree within the running (Ant) VM.</p>
  4076. <p>The source and destination directory will be recursively scanned for
  4077. NetRexx source files to compile. Only NetRexx files that have no corresponding
  4078. class file or where the class file is older than the java file will be compiled.</p>
  4079. <p>Files in the source tree are copied to the destination directory,
  4080. allowing support files to be located properly in the classpath. The source
  4081. files are copied because the NetRexx compiler cannot produce class files in a
  4082. specific directory via parameters</p>
  4083. <p>The directory structure of the source tree should follow the package
  4084. hierarchy.</p>
  4085. <p>It is possible to refine the set of files that are being compiled/copied.
  4086. This can be done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>, <i>excludesfile</i> and
  4087. <i>defaultexcludes</i> attributes. With the <i>includes</i> or <i>includesfile</i> attribute you
  4088. specify the files you want to have included by using patterns. The
  4089. <i>exclude</i> or <i>excludesfile</i> attribute is used to specify the files you want to have
  4090. excluded. This is also done with patterns. And finally with the
  4091. <i>defaultexcludes</i> attribute, you can specify whether you
  4092. want to use default exclusions or not. See the section on <a
  4093. href="#directorybasedtasks">directory based tasks</a>, on how the
  4094. inclusion/exclusion of files works, and how to write patterns.</p>
  4095. <p>This task forms an implicit <a href="#fileset">FileSet</a> and
  4096. supports all attributes of <code>&lt;fileset&gt;</code>
  4097. (<code>dir</code> becomes <code>srcdir</code>) as well as the nested
  4098. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  4099. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  4100. elements.</p>
  4101. <h3>Parameters:</h3>
  4102. <table border="1" cellpadding="2" cellspacing="0">
  4103. <tr>
  4104. <td valign="top"><b>Attribute</b></td>
  4105. <td valign="top"><b>Description</b></td>
  4106. <td align="center" valign="top"><b>Required</b></td>
  4107. </tr>
  4108. <tr>
  4109. <td valign="top">binary</td>
  4110. <td valign="top">Whether literals are treated as the java binary
  4111. type rather than the NetRexx types</td>
  4112. <td valign="top" align="center">No</td>
  4113. </tr>
  4114. <tr>
  4115. <td valign="top">classpath</td>
  4116. <td valign="top">The classpath to use during compilation</td>
  4117. <td valign="top" align="center">No</td>
  4118. </tr>
  4119. <tr>
  4120. <td valign="top">comments</td>
  4121. <td valign="top">Whether comments are passed through to the
  4122. generated java source</td>
  4123. <td valign="top" align="center">No</td>
  4124. </tr>
  4125. <tr>
  4126. <td valign="top">compact</td>
  4127. <td valign="top">Whether error messages come out in compact or
  4128. verbose format</td>
  4129. <td valign="top" align="center">No</td>
  4130. </tr>
  4131. <tr>
  4132. <td valign="top">compile</td>
  4133. <td valign="top">Whether the NetRexx compiler should compile the
  4134. generated java code</td>
  4135. <td valign="top" align="center">No</td>
  4136. </tr>
  4137. <tr>
  4138. <td valign="top">console</td>
  4139. <td valign="top">Whether or not messages should be displayed on the
  4140. 'console'</td>
  4141. <td valign="top" align="center">No</td>
  4142. </tr>
  4143. <tr>
  4144. <td valign="top">crossref</td>
  4145. <td valign="top">Whether variable cross references are generated</td>
  4146. <td valign="top" align="center">No</td>
  4147. </tr>
  4148. <tr>
  4149. <td valign="top">decimal</td>
  4150. <td valign="top">Whether decimal arithmetic should be used for the
  4151. NetRexx code</td>
  4152. <td valign="top" align="center">No</td>
  4153. </tr>
  4154. <tr>
  4155. <td valign="top">defaultexcludes</td>
  4156. <td valign="top">indicates whether default excludes should be used or not
  4157. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when
  4158. omitted.</td>
  4159. <td valign="top" align="center">No</td>
  4160. </tr>
  4161. <tr>
  4162. <td valign="top">destDir</td>
  4163. <td valign="top">the destination directory into which the NetRexx
  4164. source files should be copied and then compiled</td>
  4165. <td valign="top" align="center">Yes</td>
  4166. </tr>
  4167. <tr>
  4168. <td valign="top">diag</td>
  4169. <td valign="top">Whether diagnostic information about the compile is
  4170. generated</td>
  4171. <td valign="top" align="center">No</td>
  4172. </tr>
  4173. <tr>
  4174. <td valign="top">excludes</td>
  4175. <td valign="top">comma separated list of patterns of files that must be
  4176. excluded. No files (except default excludes) are excluded when
  4177. omitted.</td>
  4178. <td valign="top" align="center">No</td>
  4179. </tr>
  4180. <tr>
  4181. <td valign="top">excludesfile</td>
  4182. <td valign="top">the name of a file. Each line of this file is
  4183. taken to be an exclude pattern</td>
  4184. <td valign="top" align="center">No</td>
  4185. </tr>
  4186. <tr>
  4187. <td valign="top">explicit</td>
  4188. <td valign="top">Whether variables must be declared explicitly
  4189. before use</td>
  4190. <td valign="top" align="center">No</td>
  4191. </tr>
  4192. <tr>
  4193. <td valign="top">format</td>
  4194. <td valign="top">Whether the generated java code is formatted nicely
  4195. or left to match NetRexx line numbers for call stack debugging</td>
  4196. <td valign="top" align="center">No</td>
  4197. </tr>
  4198. <tr>
  4199. <td valign="top">includes</td>
  4200. <td valign="top">comma separated list of patterns of files that must be
  4201. included. All files are included when omitted.</td>
  4202. <td valign="top" align="center">No</td>
  4203. </tr>
  4204. <tr>
  4205. <td valign="top">includesfile</td>
  4206. <td valign="top">the name of a file. Each line of this file is
  4207. taken to be an include pattern</td>
  4208. <td valign="top" align="center">No</td>
  4209. </tr>
  4210. <tr>
  4211. <td valign="top">java</td>
  4212. <td valign="top">Whether the generated java code is produced</td>
  4213. <td valign="top" align="center">No</td>
  4214. </tr>
  4215. <tr>
  4216. <td valign="top">keep</td>
  4217. <td valign="top">Sets whether the generated java source file should be kept
  4218. after compilation. The generated files will have an extension of
  4219. .java.keep, <b>not</b> .java</td>
  4220. <td valign="top" align="center">No</td>
  4221. </tr>
  4222. <tr>
  4223. <td valign="top">logo</td>
  4224. <td valign="top">Whether the compiler text logo is displayed when
  4225. compiling</td>
  4226. <td valign="top" align="center">No</td>
  4227. </tr>
  4228. <tr>
  4229. <td valign="top">replace</td>
  4230. <td valign="top">Whether the generated .java file should be replaced
  4231. when compiling</td>
  4232. <td valign="top" align="center">No</td>
  4233. </tr>
  4234. <tr>
  4235. <td valign="top">savelog</td>
  4236. <td valign="top">Whether the compiler messages will be written to
  4237. NetRexxC.log as well as to the console</td>
  4238. <td valign="top" align="center">No</td>
  4239. </tr>
  4240. <tr>
  4241. <td valign="top">sourcedir</td>
  4242. <td valign="top">Tells the NetRexx compiler to store the class files in the
  4243. same directory as the source files. The alternative is the working
  4244. directory</td>
  4245. <td valign="top" align="center">No</td>
  4246. </tr>
  4247. <tr>
  4248. <td valign="top">srcDir</td>
  4249. <td valign="top">Set the source dir to find the source Netrexx
  4250. files</td>
  4251. <td valign="top" align="center">Yes</td>
  4252. </tr>
  4253. <tr>
  4254. <td valign="top">strictargs</td>
  4255. <td valign="top">Tells the NetRexx compiler that method calls always
  4256. need parentheses, even if no arguments are needed, e.g.
  4257. <code>aStringVar.getBytes</code> vs.
  4258. <code>aStringVar.getBytes()</code></td>
  4259. <td valign="top" align="center">No</td>
  4260. </tr>
  4261. <tr>
  4262. <td valign="top">strictassign</td>
  4263. <td valign="top">Tells the NetRexx compile that assignments must
  4264. match exactly on type</td>
  4265. <td valign="top" align="center">No</td>
  4266. </tr>
  4267. <tr>
  4268. <td valign="top">strictcase</td>
  4269. <td valign="top">Specifies whether the NetRexx compiler should be
  4270. case sensitive or not</td>
  4271. <td valign="top" align="center">No</td>
  4272. </tr>
  4273. <tr>
  4274. <td valign="top">strictimport</td>
  4275. <td valign="top">Whether classes need to be imported explicitly using an
  4276. <code>import</code> statement. By default the NetRexx compiler will
  4277. import certain packages automatically</td>
  4278. <td valign="top" align="center">No</td>
  4279. </tr>
  4280. <tr>
  4281. <td valign="top">strictprops</td>
  4282. <td valign="top">Whether local properties need to be qualified
  4283. explicitly using <code>this</code></td>
  4284. <td valign="top" align="center">No</td>
  4285. </tr>
  4286. <tr>
  4287. <td valign="top">strictsignal</td>
  4288. <td valign="top">Whether the compiler should force catching of
  4289. exceptions by explicitly named types</td>
  4290. <td valign="top" align="center">No</td>
  4291. </tr>
  4292. <tr>
  4293. <td valign="top">symbols</td>
  4294. <td valign="top">Whether debug symbols should be generated into the
  4295. class file</td>
  4296. <td valign="top" align="center">No</td>
  4297. </tr>
  4298. <tr>
  4299. <td valign="top">time</td>
  4300. <td valign="top">Asks the NetRexx compiler to print compilation
  4301. times to the console</td>
  4302. <td valign="top" align="center">No</td>
  4303. </tr>
  4304. <tr>
  4305. <td valign="top">trace</td>
  4306. <td valign="top">Turns on or off tracing and directs the resultant
  4307. trace output</td>
  4308. <td valign="top" align="center">No</td>
  4309. </tr>
  4310. <tr>
  4311. <td valign="top">utf8</td>
  4312. <td valign="top">Tells the NetRexx compiler that the source is in UTF8</td>
  4313. <td valign="top" align="center">No</td>
  4314. </tr>
  4315. <tr>
  4316. <td valign="top">verbose</td>
  4317. <td valign="top">Whether lots of warnings and error messages should
  4318. be generated</td>
  4319. <td valign="top" align="center">Yes</td>
  4320. </tr>
  4321. </table>
  4322. <h3>Examples</h3>
  4323. <blockquote>
  4324. <p><code>&lt;netrexxc srcDir=&quot;/source/project&quot;
  4325. includes=&quot;vnr/util/*&quot;
  4326. destDir=&quot;/source/project/build&quot;
  4327. classpath=&quot;/source/project2/proj.jar&quot;
  4328. comments=&quot;true&quot;
  4329. crossref=&quot;false&quot; replace=&quot;true&quot;
  4330. keep=&quot;true&quot; /&gt;</code>
  4331. </p>
  4332. </blockquote>
  4333. <hr>
  4334. <h2><a name="renameexts">RenameExtensions</a></h2>
  4335. <h3><b>Description:</b></h3>
  4336. <p>Renames files in the <code>srcDir</code> directory ending with the
  4337. <code>fromExtension</code> string so that they end with the
  4338. <code>toExtension</code> string. Files are only replaced if
  4339. <code>replace</code> is true
  4340. </p>
  4341. <p>See the section on
  4342. <a href="#directorybasedtasks">directory based tasks</a>, on how the
  4343. inclusion/exclusion of files works, and how to write patterns.
  4344. This task forms an implicit <a href="#fileset">FileSet</a> and
  4345. supports all attributes of <code>&lt;fileset&gt;</code>
  4346. (<code>dir</code> becomes <code>srcDir</code>) as well as the nested
  4347. <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>,
  4348. <code>&lt;patternset&gt;</code> and <code>&lt;patternsetref&gt;</code>
  4349. elements.</p>
  4350. <h3>Parameters:</h3>
  4351. <table border="1" cellpadding="2" cellspacing="0">
  4352. <tr>
  4353. <td valign="top"><b>Attribute</b></td>
  4354. <td valign="top"><b>Description</b></td>
  4355. <td align="center" valign="top"><b>Required</b></td>
  4356. </tr>
  4357. <tr>
  4358. <td valign="top">defaultexcludes</td>
  4359. <td valign="top">indicates whether default excludes should be used or not
  4360. (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when
  4361. omitted.</td>
  4362. <td valign="top" align="center">No</td>
  4363. </tr>
  4364. <tr>
  4365. <td valign="top">excludes</td>
  4366. <td valign="top">comma separated list of patterns of files that must be
  4367. excluded. No files (except default excludes) are excluded when
  4368. omitted.</td>
  4369. <td valign="top" align="center">No</td>
  4370. </tr>
  4371. <tr>
  4372. <td valign="top">excludesfile</td>
  4373. <td valign="top">the name of a file. Each line of this file is
  4374. taken to be an exclude pattern</td>
  4375. <td valign="top" align="center">No</td>
  4376. </tr>
  4377. <tr>
  4378. <td valign="top">fromExtention</td>
  4379. <td valign="top">The string that files must end in to be renamed</td>
  4380. <td valign="top" align="center">Yes</td>
  4381. </tr>
  4382. <tr>
  4383. <td valign="top">includes</td>
  4384. <td valign="top">comma separated list of patterns of files that must be
  4385. included. All files are included when omitted.</td>
  4386. <td valign="top" align="center">No</td>
  4387. </tr>
  4388. <tr>
  4389. <td valign="top">includesfile</td>
  4390. <td valign="top">the name of a file. Each line of this file is
  4391. taken to be an include pattern</td>
  4392. <td valign="top" align="center">No</td>
  4393. </tr>
  4394. <tr>
  4395. <td valign="top">replace</td>
  4396. <td valign="top">Whether the file being renamed to should be
  4397. replaced if it already exists</td>
  4398. <td valign="top" align="center">No</td>
  4399. </tr>
  4400. <tr>
  4401. <td valign="top">srcDir</td>
  4402. <td valign="top">The starting directory for files to search in</td>
  4403. <td valign="top" align="center">Yes</td>
  4404. </tr>
  4405. <tr>
  4406. <td valign="top">toExtension</td>
  4407. <td valign="top">The string that renamed files will end with on
  4408. completion</td>
  4409. <td valign="top" align="center">Yes</td>
  4410. </tr>
  4411. </table>
  4412. <h3>Examples</h3>
  4413. <blockquote>
  4414. <p><code>&lt;renameext srcDir=&quot;/source/project1&quot;
  4415. includes=&quot;**&quot;
  4416. excludes=&quot;**/samples/*&quot;
  4417. fromExtension=&quot;.java.keep&quot;
  4418. toExtension=&quot;.java&quot;
  4419. replace=&quot;true&quot; /&gt;
  4420. </code>
  4421. </p>
  4422. </blockquote>
  4423. <hr>
  4424. <h2><a name="script">Script</a></h2>
  4425. <h3><b>Description:</b></h3>
  4426. <p>Execute a script in a
  4427. <a href="http://oss.software.ibm.com/developerworks/opensource/bsf/">BSF</a> supported language.
  4428. <p>All items (tasks, targets, etc) of the running project are
  4429. accessible from the script, using either their <code>name</code> or
  4430. <code>id</code> attributes.</p>
  4431. <p>Scripts can do almost anything a task written in Java could do.</p>
  4432. <h3>Parameters:</h3>
  4433. <table border="1" cellpadding="2" cellspacing="0">
  4434. <tr>
  4435. <td valign="top"><b>Attribute</b></td>
  4436. <td valign="top"><b>Description</b></td>
  4437. <td align="center" valign="top"><b>Required</b></td>
  4438. </tr>
  4439. <tr>
  4440. <td valign="top">language</td>
  4441. <td valign="top">The programming language the script is written in.
  4442. Must be a supported BSF language</td>
  4443. <td valign="top" align="center">No</td>
  4444. </tr>
  4445. <tr>
  4446. <td valign="top">src</td>
  4447. <td valign="top">The location of the script as a file, if not inline</td>
  4448. <td valign="top" align="center">No</td>
  4449. </tr>
  4450. </table>
  4451. <h3>Examples</h3>
  4452. <blockquote><pre>
  4453. &lt;project name=&quot;squares&quot; default=&quot;main&quot; basedir=&quot;.&quot;&gt;
  4454. &lt;target name=&quot;setup&quot;&gt;
  4455. &lt;script language=&quot;javascript&quot;&gt; &lt;![CDATA[
  4456. for (i=1; i&lt;=10; i++) {
  4457. echo = squares.createTask(&quot;echo&quot;);
  4458. main.addTask(echo);
  4459. echo.setMessage(i*i);
  4460. }
  4461. ]]&gt; &lt;/script&gt;
  4462. &lt;/target&gt;
  4463. &lt;target name=&quot;main&quot; depends=&quot;setup&quot; /&gt;
  4464. &lt;/project&gt;
  4465. </pre></blockquote>
  4466. <p>generates</p>
  4467. <blockquote><pre>
  4468. setup:
  4469. main:
  4470. 1
  4471. 4
  4472. 9
  4473. 16
  4474. 25
  4475. 36
  4476. 49
  4477. 64
  4478. 81
  4479. 100
  4480. BUILD SUCCESSFUL
  4481. </pre></blockquote>
  4482. <p>Another example, using <a href="#references">references by id</a>
  4483. and two different scripting languages:</p>
  4484. <blockquote><pre>
  4485. &lt;project name=&quot;testscript&quot; default=&quot;main&quot;&gt;
  4486. &lt;target name=&quot;sub&quot;&gt;
  4487. &lt;echo id=&quot;theEcho&quot; /&gt;
  4488. &lt;/target&gt;
  4489. &lt;target name=&quot;sub1&quot;&gt;
  4490. &lt;script language=&quot;netrexx&quot;&gt;&lt;![CDATA[
  4491. theEcho.setMessage(&quot;In sub1&quot;)
  4492. sub.execute
  4493. ]]&gt;&lt;/script&gt;
  4494. &lt;/target&gt;
  4495. &lt;target name=&quot;sub2&quot;&gt;
  4496. &lt;script language=&quot;javascript&quot;&gt;&lt;![CDATA[
  4497. theEcho.setMessage(&quot;In sub2&quot;);
  4498. sub.execute();
  4499. ]]&gt;&lt;/script&gt;
  4500. &lt;/target&gt;
  4501. &lt;target name=&quot;main&quot; depends=&quot;sub1,sub2&quot; /&gt;
  4502. &lt;/project&gt;
  4503. </pre></blockquote>
  4504. <p>generates</p>
  4505. <blockquote><pre>
  4506. sub1:
  4507. In sub1
  4508. sub2:
  4509. In sub2
  4510. main:
  4511. BUILD SUCCESSFUL
  4512. </pre></blockquote>
  4513. <hr>
  4514. <h2><a name="vssget">VssGet</a></h2>
  4515. <h3><b>Description:</b></h3>
  4516. Task to perform GET commands to Microsoft Visual Source Safe.
  4517. <p>
  4518. The following attributes are interpretted:
  4519. <h3>Parameters:</h3>
  4520. <table border="1" cellpadding="2" cellspacing="0">
  4521. <tr>
  4522. <th>Attribute</th>
  4523. <th>Values</th>
  4524. <th>Required</th>
  4525. </tr>
  4526. <tr>
  4527. <td>login</td>
  4528. <td>username,password</td>
  4529. <td>No</td>
  4530. </tr>
  4531. <tr>
  4532. <td>vsspath</td>
  4533. <td>SourceSafe path</td>
  4534. <td>Yes</td>
  4535. </tr>
  4536. <tr>
  4537. <td>localpath</td>
  4538. <td>Override the working directory and get to the specified path</td>
  4539. <td>No</td>
  4540. </tr>
  4541. <tr>
  4542. <td>writable</td>
  4543. <td>true or false</td>
  4544. <td>No</td>
  4545. </tr>
  4546. <tr>
  4547. <td>recursive</td>
  4548. <td>true or false</td>
  4549. <td>No</td>
  4550. </tr>
  4551. <tr>
  4552. <td>version</td>
  4553. <td>a version number to get</td>
  4554. <td>No</td>
  4555. </tr>
  4556. <tr>
  4557. <td>date</td>
  4558. <td>a date stamp to get at</td>
  4559. <td>No</td>
  4560. </tr>
  4561. <tr>
  4562. <td>label</td>
  4563. <td>a label to get for</td>
  4564. <td>No</td>
  4565. </tr>
  4566. <tr>
  4567. <td>ssdir</td>
  4568. <td>directory where <code>ss.exe</code> resides. By default the
  4569. task expects it to be in the PATH.</td>
  4570. <td>No</td>
  4571. </tr>
  4572. </table>
  4573. <p>Note that only one of version, date or label should be specified</p>
  4574. <h3>Examples</h3>
  4575. <blockquote>
  4576. <p>None yet available</p>
  4577. </blockquote>
  4578. <hr>
  4579. <h2><a name="buildevents">Build Events</a></h2>
  4580. Ant is capable of generating build events as it performs the tasks necessary to build a project.
  4581. Listeners can be attached to ant to receive these events. This capability could be used, for example,
  4582. to connect Ant to a GUI or to integrate Ant with an IDE.
  4583. <p>To use build events you need to create an ant <code>Project</code> object. You can then call the
  4584. <code>addBuildListener</code> method to add your listener to the project. Your listener must implement
  4585. the <code>org.apache.tools.antBuildListener</code> interface. The listener will receive BuildEvents
  4586. for the following events
  4587. <ul>
  4588. <li>Build started
  4589. <li>Build finished
  4590. <li>Target started
  4591. <li>Target finished
  4592. <li>Task started
  4593. <li>Task finished
  4594. <li>Message logged
  4595. </ul>
  4596. If you wish to attach a listener from the command line you may use the -listener option. For example
  4597. <blockquote>
  4598. <pre>ant -listener org.apache.tools.ant.XmlLogger</pre>
  4599. </blockquote>
  4600. will run ant with a listener which generates an XML representation of the build progress. This
  4601. listener is included with ant as is the default listener which generates the logging to standard
  4602. output.
  4603. <hr>
  4604. <h2><a name="writingowntask">Writing your own task</a></h2>
  4605. <p>It is very easy to write your own task:</p>
  4606. <ol>
  4607. <li>Create a Java class that extends <code>org.apache.tools.ant.Task</code>.</li>
  4608. <li>For each attribute, write a setter method. The setter method must be a
  4609. <code>public void</code> method that takes a single argument. The
  4610. name of the method must begin with &quot;set&quot;, followed by the
  4611. attribute name, with the first character in uppercase, and the rest in
  4612. lowercase. The type of the attribute can be <code>String</code>, any
  4613. primitive type, <code>Class</code>, <code>File</code> (in which case the
  4614. value of the attribute is interpreted relative to the project's basedir)
  4615. or any other type that has a constructor with a single <code>String</code>
  4616. argument</li>
  4617. <li>If your task has enumerated attributes, you should consider using
  4618. a subclass of org.apache.tools.ant.types.EnumeratedAttribute as argument
  4619. to your setter method. See org.apache.tools.ant.taskdefs.FixCRLF for
  4620. an example.</li>
  4621. <li>If the task should support character data, write a <code>public void
  4622. addText(String)</code> method.</li>
  4623. <li>For each nested element, write a create or add method. A create method
  4624. must be a <code>public</code> method that takes no arguments and returns
  4625. an Object type. The name of the create method must begin with
  4626. &quot;create&quot;, followed by the element name. An add method must be
  4627. a <code>public void</code> method that takes a single argument of an
  4628. Object type with a no argument constructor. The name of the add method
  4629. must begin with &quot;add&quot;, followed by the element name.
  4630. <li>Write a <code>public void execute</code> method, with no arguments, that
  4631. throws a <code>BuildException</code>. This method implements the task
  4632. itself.</li>
  4633. </ol>
  4634. <p>It is important to know that Ant first calls the setters for the attributes
  4635. it encounters for a specific task in the buildfile, before it executes is.</p>
  4636. <p>Let's write our own task, that prints a message on the System.out stream. The
  4637. task has one attribute called &quot;message&quot;.</p>
  4638. <blockquote>
  4639. <pre>package com.mydomain;
  4640. import org.apache.tools.ant.BuildException;
  4641. import org.apache.tools.ant.Task;
  4642. public class MyVeryOwnTask extends Task {
  4643. private String msg;
  4644. // The method executing the task
  4645. public void execute() throws BuildException {
  4646. System.out.println(msg);
  4647. }
  4648. // The setter for the &quot;message&quot; attribute
  4649. public void setMessage(String msg) {
  4650. this.msg = msg;
  4651. }
  4652. }</pre>
  4653. </blockquote>
  4654. <p>It's really this simple;-)</p>
  4655. <p>Adding your task to the system is rather simple too:</p>
  4656. <ol>
  4657. <li>Make sure the class that implements your task is in the classpath when
  4658. starting Ant.</li>
  4659. <li>Add a <i>taskdef</i> element to your project. This actually adds
  4660. your task to the system.</li>
  4661. <li>Use your task in the rest of the buildfile.</li>
  4662. </ol>
  4663. <h3>Example</h3>
  4664. <blockquote>
  4665. <pre>&lt;?xml version=&quot;1.0&quot;?&gt;
  4666. &lt;project name=&quot;OwnTaskExample&quot; default=&quot;main&quot; basedir=&quot;.&quot;&gt;
  4667. &lt;taskdef name=&quot;mytask&quot; classname=&quot;com.mydomain.MyVeryOwnTask&quot;/&gt;
  4668. &lt;target name=&quot;main&quot;&gt;
  4669. &lt;mytask message=&quot;Hello World! MyVeryOwnTask works!&quot; /&gt;
  4670. &lt;/target&gt;
  4671. &lt;/project&gt;
  4672. </pre>
  4673. </blockquote>
  4674. <p>Another way to add a task (more permanently), is to add the task name and
  4675. implementing class name to the <code>default.properties</code> file in the <code>org.apache.tools.ant.taskdefs</code>
  4676. package. Then you can use it as if it were a built in task.</p>
  4677. <hr>
  4678. <h2><a name="faq">FAQ, DTD, external resources</a></h2>
  4679. <p>There is an online FAQ for Ant at <a
  4680. href="http://jakarta.apache.org/jyve-faq/Turbine/screen/DisplayTopics/action/SetAll/project_id/2/faq_id/16">jakarta.apache.org</a>. This
  4681. FAQ is interactive, which means you can ask and answer questions
  4682. online.</p>
  4683. <p>One of the questions poping up quite often is "Is there a DTD for
  4684. buildfiles?". Please refer to the FAQ for an answer.</p>
  4685. <hr>
  4686. <h2><a name="feedback">Feedback</a></h2>
  4687. <p>To provide feedback on this software, please subscribe to the Ant User
  4688. Mail List (<a href="mailto:ant-user-subscribe@jakarta.apache.org">ant-user-subscribe@jakarta.apache.org</a>)</p>
  4689. <p>If you want to contribute to Ant or stay current with the latest
  4690. development, join the Ant Development Mail List (<a
  4691. href="mailto:ant-dev-subscribe@jakarta.apache.org">ant-dev-subscribe@jakarta.apache.org</a>)</p>
  4692. <hr>
  4693. <p align="center">Copyright � 2000 Apache Software Foundation. All rights
  4694. Reserved.</p>
  4695. </body>
  4696. </html>