2003-05-09 06:12:58 -04:00
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
2007-01-15 18:11:09 -05:00
|
|
|
<!--
|
|
|
|
|
====================================================================
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
====================================================================
|
|
|
|
|
-->
|
2008-03-20 18:31:15 -04:00
|
|
|
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "./dtd/document-v13.dtd">
|
2003-05-09 06:12:58 -04:00
|
|
|
|
|
|
|
|
<document>
|
|
|
|
|
<header>
|
|
|
|
|
<title>How To Build POI</title>
|
|
|
|
|
<authors>
|
2007-05-29 12:51:41 -04:00
|
|
|
<person email="user@poi.apache.org" name="Glen Stampoultzis" id="GS"/>
|
2003-06-20 00:02:31 -04:00
|
|
|
<person email="tetsuya@apache.org" name="Tetsuya Kitahata" id="TK"/>
|
2003-05-09 06:12:58 -04:00
|
|
|
</authors>
|
|
|
|
|
</header>
|
|
|
|
|
<body>
|
|
|
|
|
<section>
|
|
|
|
|
<title>Installing Ant</title>
|
|
|
|
|
<p>
|
|
|
|
|
The POI build system requires two components to perform a
|
|
|
|
|
build.
|
2007-05-29 12:51:41 -04:00
|
|
|
<link href="ext:ant.apache.org/">Ant</link> and
|
2003-05-09 06:12:58 -04:00
|
|
|
<link href="ext:xml.apache.org/forrest">forrest</link>.
|
|
|
|
|
</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>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Library</th>
|
|
|
|
|
<th>Location</th>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>junit</td>
|
|
|
|
|
<td>http://www.ibiblio.org/maven/junit/jars/</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>xerces</td>
|
|
|
|
|
<td>http://www.ibiblio.org/maven/xerces/jars/</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>jdepend</td>
|
|
|
|
|
<td>http://www.ibiblio.org/maven/jdepend/jars/</td>
|
|
|
|
|
</tr>
|
2003-07-25 15:51:38 -04:00
|
|
|
<tr>
|
|
|
|
|
<td>xalan</td>
|
|
|
|
|
<td>http://www.ibiblio.org/maven/xalan/jars/</td>
|
|
|
|
|
</tr>
|
2003-05-09 06:12:58 -04:00
|
|
|
</table>
|
|
|
|
|
<p>
|
|
|
|
|
Just pick the latest versions of these jars and place
|
2003-06-20 00:02:31 -04:00
|
|
|
them in ANT_HOME/lib and make sure that optional.jar is
|
|
|
|
|
in ANT_HOME/lib .
|
2003-05-09 06:12:58 -04:00
|
|
|
</p>
|
|
|
|
|
</section>
|
|
|
|
|
<section>
|
|
|
|
|
<title>Running the Build</title>
|
|
|
|
|
<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>
|
2003-05-10 20:52:25 -04:00
|
|
|
<table>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>JAR</th>
|
|
|
|
|
<th>Location</th>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>/commons-logging/jars/commons-logging-1.0.1.jar</td>
|
|
|
|
|
<td>lib</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>/log4j/jars/log4j-1.2.8.jar</td>
|
|
|
|
|
<td>lib</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>/commons-beanutils/jars/commons-beanutils-1.6.jar</td>
|
|
|
|
|
<td>src/contrib/lib</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>/commons-collections/jars/commons-collections-2.1.jar</td>
|
|
|
|
|
<td>src/contrib/lib</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>/commons-lang/jars/commons-lang-1.0-b1.jar</td>
|
|
|
|
|
<td>src/contrib/lib</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>/junit/jars/junit-3.8.1.jar</td>
|
|
|
|
|
<td>lib</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
2003-05-09 06:12:58 -04:00
|
|
|
<p>
|
|
|
|
|
The main targets of interest to our users are:
|
|
|
|
|
</p>
|
|
|
|
|
<table>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Target</th>
|
|
|
|
|
<th>Description</th>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>clean</td>
|
|
|
|
|
<td>Erase all build work products (ie, everything in the
|
|
|
|
|
build directory</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>compile</td>
|
|
|
|
|
<td>Compiles all files from main, contrib and scratchpad</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>test</td>
|
|
|
|
|
<td>Run all unit tests from main, contrib and scratchpad</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>docs</td>
|
|
|
|
|
<td>Generate all documentation for the system</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>generate-records</td>
|
|
|
|
|
<td>Generate records from the XML record defintitions</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>generate-types</td>
|
|
|
|
|
<td>Generate types from the XML type definitions (this is
|
2003-08-05 00:00:14 -04:00
|
|
|
for HWPF).</td>
|
2003-05-09 06:12:58 -04:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>jar</td>
|
|
|
|
|
<td>Produce jar files</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>dist</td>
|
|
|
|
|
<td>Create a distribution.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>clean-dist</td>
|
|
|
|
|
<td>Runs clean before creating the distribution.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</section>
|
|
|
|
|
</body>
|
|
|
|
|
</document>
|
|
|
|
|
|
|
|
|
|
|
