<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<!--*** This is a generated file. Do not edit. ***-->
<link rel="stylesheet" href="skin/tigris.css" type="text/css">
<link rel="stylesheet" href="skin/mysite.css" type="text/css">
<link rel="stylesheet" href="skin/site.css" type="text/css">
<link media="print" rel="stylesheet" href="skin/print.css" type="text/css">
<title>How To Build POI</title>
</head>
<body bgcolor="white" class="composite">
<!--================= start Banner ==================-->
<div id="banner">
<table width="100%" cellpadding="8" cellspacing="0" summary="banner" border="0">
<tbody>
<tr>
<!--================= start Group Logo ==================-->
<td align="left">
<div class="groupLogo">
<a href="http://poi.apache.org"><img border="0" class="logoImage" alt="Apache POI" src="resources/images/group-logo.jpg"></a>
</div>
</td>
<!--================= end Group Logo ==================-->
<!--================= start Project Logo ==================--><td align="right">
<div class="projectLogo">
<a href="http://poi.apache.org/"><img border="0" class="logoImage" alt="POI" src="resources/images/project-logo.jpg"></a>
</div>
</td>
<!--================= end Project Logo ==================-->
</tr>
</tbody>
</table>
</div>
<!--================= end Banner ==================-->
<!--================= start Main ==================-->
<table width="100%" cellpadding="0" cellspacing="0" border="0" summary="nav" id="breadcrumbs">
<tbody>
<!--================= start Status ==================-->
<tr class="status">
<td>
<!--================= start BreadCrumb ==================--><a href="http://www.apache.org/">Apache</a> | <a href="http://poi.apache.org/">POI</a><a href=""></a>
<!--================= end BreadCrumb ==================--></td><td id="tabs">
<!--================= start Tabs ==================-->
<div class="tab">
<span class="selectedTab"><a class="base-selected" href="index.html">Home</a></span> | <script language="Javascript" type="text/javascript">
function printit() {
if (window.print) {
window.print() ;
} else {
var WebBrowser = '<OBJECT ID="WebBrowser1" WIDTH="0" HEIGHT="0" CLASSID="CLSID:8856F961-340A-11D0-A96B-00C04FD705A2"></OBJECT>';
document.body.insertAdjacentHTML('beforeEnd', WebBrowser);
WebBrowser1.ExecWB(6, 2);//Use a 1 vs. a 2 for a prompting dialog box WebBrowser1.outerHTML = "";
}
}
</script><script language="Javascript" type="text/javascript">
var NS = (navigator.appName == "Netscape");
var VERSION = parseInt(navigator.appVersion);
if (VERSION > 3) {
document.write(' <a title="PRINT this page OUT" href="javascript:printit()">PRINT</a>');
}
</script> | <a title="PDF file of this page" href="howtobuild.pdf">PDF</a>
</div>
<!--================= end Tabs ==================-->
</td>
</tr>
</tbody>
</table>
<!--================= end Status ==================-->
<table id="main" width="100%" cellpadding="8" cellspacing="0" summary="" border="0">
<tbody>
<tr valign="top">
<!--================= start Menu ==================-->
<td id="leftcol">
<div id="navcolumn">
<div class="menuBar">
<div class="menu">
<span class="menuLabel">Apache POI</span>
<div class="menuItem">
<a href="index.html">TOP</a>
</div>
</div>
<div class="menu">
<span class="menuLabel">Marketing</span>
<div class="menuItem">
<a href="casestudies.html">Case Studies</a>
</div>
</div>
<div class="menu">
<span class="menuLabel">Project</span>
<div class="menuItem">
<a href="overview.html">Overview</a>
</div>
<div class="menuItem">
<a href="poifs/index.html">POIFS</a>
</div>
<div class="menuItem">
<a href="hssf/index.html">HSSF</a>
</div>
<div class="menuItem">
<a href="hwpf/index.html">HWPF</a>
</div>
<div class="menuItem">
<a href="hpsf/index.html">HPSF</a>
</div>
<div class="menuItem">
<a href="hslf/index.html">HSLF</a>
</div>
<div class="menuItem">
<a href="hsmf/index.html">HSMF</a>
</div>
<div class="menuItem">
<a href="hdgf/index.html">HDGF</a>
</div>
<div class="menuItem">
<a href="poi-ruby.html">POI-Ruby</a>
</div>
<div class="menuItem">
<a href="utils/index.html">POI-Utils</a>
</div>
<div class="menuItem">
<a href="text-extraction.html">Text Extraction</a>
</div>
<div class="menuItem">
<a href="http://www.apache.org/dyn/closer.cgi/poi/">Download</a>
</div>
</div>
<div class="menu">
<span class="menuLabel">Community</span>
<div class="menuItem">
<a href="news.html">News</a>
</div>
<div class="menuItem">
<a href="mirrors.html">Mirrors</a>
</div>
<div class="menuItem">
<a href="changes.html">Changes</a>
</div>
<div class="menuItem">
<a href="todo.html">To Do</a>
</div>
<div class="menuItem">
<a href="getinvolved/index.html">Get Involved</a>
</div>
<div class="menuItem">
<a href="mailinglists.html">Mailing Lists</a>
</div>
<div class="menuItem">
<a href="plan/POI20Vision.html">Vision</a>
</div>
<div class="menuItem">
<a href="historyandfuture.html">History and Future</a>
</div>
<div class="menuItem">
<a href="who.html">Who We Are</a>
</div>
<div class="menuItem">
<a href="resolutions/index.html">Resolutions</a>
</div>
<div class="menuItem">
<a href="http://www.apache.org/foundation/thanks.html">Sponsors</a>
</div>
</div>
<div class="menu">
<span class="menuLabel">Docs</span>
<div class="menuItem">
<a href="apidocs/index.html">Javadocs</a>
</div>
<div class="menuItem">
<a href="faq.html">FAQ</a>
</div>
<div class="menuItem">
<a href="legal.html">Legal</a>
</div>
<div class="menuItem">
<a href="references/index.html">References</a>
</div>
<div class="menuItem">
<span class="menuSelected">How to Build</span>
</div>
</div>
<div class="menu">
<span class="menuLabel">Translations</span>
<div class="menuItem">
<a href="trans/index.html">Index</a>
</div>
<div class="menuItem">
<a href="trans/guidelines.html">Guidelines</a>
</div>
<div class="menuItem">
<a href="trans/de/index.html">German (DE)</a>
</div>
<div class="menuItem">
<a href="trans/es/index.html">Spanish (ES)</a>
</div>
<div class="menuItem">
<a href="http://jakarta.terra-intl.com/poi/">Japanese (Web)</a>
</div>
<div class="menuItem">
<a href="http://jakarta.apache-korea.org/poi/">Korean (Web)</a>
</div>
</div>
<div class="menu">
<span class="menuLabel">Code</span>
<div class="menuItem">
<a href="subversion.html">Subversion (current source code)</a>
</div>
<div class="menuItem">
<a href="http://issues.apache.org/bugzilla/buglist.cgi?votes=1&product=POI&order=bugs.votes">Top Voted Bugs</a>
</div>
<div class="menuItem">
<a href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>
</div>
<div class="menuItem">
<a href="http://issues.apache.org/bugzilla/buglist.cgi?product=POI&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr">Patches</a>
</div>
<div class="menuItem">
<a href="junit/index.html">Junit Test Results</a>
</div>
<div class="menuItem">
<a href="jdepend/index.html">Dependency Metrics</a>
</div>
</div>
</div>
</div>
<form target="_blank" action="http://www.google.com/search" method="get">
<table summary="search" border="0" cellspacing="0" cellpadding="0">
<tr>
<td><img height="1" width="1" alt="" src="skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap"><input value="poi.apache.org" name="sitesearch" type="hidden"><input size="10" name="q" id="query" type="text"><img height="1" width="5" alt="" src="skin/images/spacer.gif" class="spacer"><input name="Search" value="GO" type="submit">
<br>
Search poi</td><td><img height="1" width="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td colspan="3"><img height="7" width="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td class="bottom-left-thick"></td><td bgcolor="#a5b6c6"><img height="1" width="1" alt="" src="skin/images/spacer.gif" class="spacer"></td><td class="bottom-right-thick"></td>
</tr>
</table>
</form>
</td>
<!--================= end Menu ==================-->
<!--================= start Content ==================--><td>
<div id="bodycol">
<div class="app">
<div align="center">
<h1>How To Build POI</h1>
</div>
<div class="h3">
<div class="h3">
<h3>Installing Ant</h3>
</div>
<p>
The POI build system requires two components to perform a
build.
<a href="ext:ant.apache.org/">Ant</a> and
<a href="http://xml.apache.org/forrest/">forrest</a>.
</p>
<p>
Specifically the build has been tested to work with Ant version
1.5.3 and Forrest 0.4. To install these products download
the distributions and follow the instructions in their
documentation. Make sure you don't forget to set the
environment variables FORREST_HOME and ANT_HOME. The
ANT_HOME/bin directory should be in the path.
</p>
<p>
One these products are installed you will also need to
download some extra jar files required by the build.
</p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr class="b">
<th colspan="1" rowspan="1">Library</th>
<th colspan="1" rowspan="1">Location</th>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">junit</td>
<td colspan="1" rowspan="1">http://www.ibiblio.org/maven/junit/jars/</td>
</tr>
<tr class="b">
<td colspan="1" rowspan="1">xerces</td>
<td colspan="1" rowspan="1">http://www.ibiblio.org/maven/xerces/jars/</td>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">jdepend</td>
<td colspan="1" rowspan="1">http://www.ibiblio.org/maven/jdepend/jars/</td>
</tr>
<tr class="b">
<td colspan="1" rowspan="1">xalan</td>
<td colspan="1" rowspan="1">http://www.ibiblio.org/maven/xalan/jars/</td>
</tr>
</table>
<p>
Just pick the latest versions of these jars and place
them in ANT_HOME/lib and make sure that optional.jar is
in ANT_HOME/lib .
</p>
<div class="h3">
<h3>Running the Build</h3>
</div>
<p>
On the first run the ant build system will download all
the jars required by the project to build ant. If you're
behind a firewall this may cause some problems. Should you
need to it's possible to manually put the jars in the
correct directories. These can be obtained from here:
</p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr class="b">
<th colspan="1" rowspan="1">JAR</th>
<th colspan="1" rowspan="1">Location</th>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">/commons-logging/jars/commons-logging-1.0.1.jar</td>
<td colspan="1" rowspan="1">lib</td>
</tr>
<tr class="b">
<td colspan="1" rowspan="1">/log4j/jars/log4j-1.2.8.jar</td>
<td colspan="1" rowspan="1">lib</td>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">/commons-beanutils/jars/commons-beanutils-1.6.jar</td>
<td colspan="1" rowspan="1">src/contrib/lib</td>
</tr>
<tr class="b">
<td colspan="1" rowspan="1">/commons-collections/jars/commons-collections-2.1.jar</td>
<td colspan="1" rowspan="1">src/contrib/lib</td>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">/commons-lang/jars/commons-lang-1.0-b1.jar</td>
<td colspan="1" rowspan="1">src/contrib/lib</td>
</tr>
<tr class="b">
<td colspan="1" rowspan="1">/junit/jars/junit-3.8.1.jar</td>
<td colspan="1" rowspan="1">lib</td>
</tr>
</table>
<p>
The main targets of interest to our users are:
</p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr class="b">
<th colspan="1" rowspan="1">Target</th>
<th colspan="1" rowspan="1">Description</th>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">clean</td>
<td colspan="1" rowspan="1">Erase all build work products (ie, everything in the
build directory</td>
</tr>
<tr class="b">
<td colspan="1" rowspan="1">compile</td>
<td colspan="1" rowspan="1">Compiles all files from main, contrib and scratchpad</td>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">test</td>
<td colspan="1" rowspan="1">Run all unit tests from main, contrib and scratchpad</td>
</tr>
<tr class="b">
<td colspan="1" rowspan="1">docs</td>
<td colspan="1" rowspan="1">Generate all documentation for the system</td>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">generate-records</td>
<td colspan="1" rowspan="1">Generate records from the XML record defintitions</td>
</tr>
<tr class="b">
<td colspan="1" rowspan="1">generate-types</td>
<td colspan="1" rowspan="1">Generate types from the XML type definitions (this is
for HWPF).</td>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">jar</td>
<td colspan="1" rowspan="1">Produce jar files</td>
</tr>
<tr class="b">
<td colspan="1" rowspan="1">dist</td>
<td colspan="1" rowspan="1">Create a distribution.</td>
</tr>
<tr class="a">
<td colspan="1" rowspan="1">clean-dist</td>
<td colspan="1" rowspan="1">Runs clean before creating the distribution.</td>
</tr>
</table>
<div id="authors" align="right">by Glen Stampoultzis, Tetsuya Kitahata</div>
</div>
</div>
</div>
</td>
<!--================= end Content ==================-->
</tr>
</tbody>
</table>
<!--================= end Main ==================-->
<!--================= start Footer ==================-->
<div id="footer">
<table summary="footer" cellspacing="0" cellpadding="4" width="100%" border="0">
<tbody>
<tr>
<!--================= start Copyright ==================-->
<td colspan="2">
<div align="center">
<div class="copyright">
Copyright © 2002-2007 The Apache Software Foundation. All rights reserved.
</div>
</div>
</td>
<!--================= end Copyright ==================-->
</tr>
<tr>
<td align="left">
<!--================= start Host ==================-->
<!--================= end Host ==================--></td><td align="right">
<!--================= start Credits ==================-->
<div align="right">
<div class="credit"></div>
</div>
<!--================= end Credits ==================-->
</td>
</tr>
</tbody>
</table>
</div>
<!--================= end Footer ==================-->
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
0a38b107381e947533adbb55ab5f647c
>
files
>
23
