Some changes to the manual to better explain install/build and corrected some minor typos and spelling errors. Also moved library dependencies from README file to the manual.
dave Index: lib/optional/README =================================================================== RCS file: /home/cvspublic/jakarta-ant/lib/optional/README,v retrieving revision 1.1 diff -u -r1.1 README --- lib/optional/README 2001/01/23 05:10:36 1.1 +++ lib/optional/README 2001/02/10 02:15:34 @@ -1,15 +1,4 @@ The required libraries should be placed here. -The dependencies are: - -junit.jar - required for junit tasks, available at www.junit.org -stylebook.jar - required by stylebook task, available in CVS repository of xml.apache.org -testlet.jar - required for test task, available with Avalon via java.apache.org/framework -jakarta-regexp-1.2.jar - required by some mappers, available at http://jakarta.apache.org/regexp/ -jakarta-oro-2.0.1.jar - required for some mappers and the perforce tasks, available at http://jakarta.apache.org/oro/ -???antlr.jar???- required for antlr task, available at www.antlr.org -bsf.jar - required for script task, available at http://oss.software.ibm.com/developerworks/opensource/bsf/ -netrexx.jar - required for netrexx task, available at http://www2.hursley.ibm.com/netrexx -rhino.jar - required for script task if you want to use javascript, available at www.mozilla.org -jpython.jar - required for script task if you want to use python, available at www.jpython.org -netcomponents.jar - required by ftp and telnet tasks, available at http://www.savarese.org/oro/downloads/index.html#NetComponents +See the manual under Installing Ant\Library Dependencies for a list of jar requirements for +various features. Index: docs/manual/install.html =================================================================== RCS file: /home/cvspublic/jakarta-ant/docs/manual/Attic/install.html,v retrieving revision 1.1.2.2 diff -u -r1.1.2.2 install.html --- docs/manual/install.html 2001/02/08 14:48:43 1.1.2.2 +++ docs/manual/install.html 2001/02/10 02:15:33 @@ -84,9 +84,14 @@ <li>Add the <code>bin</code> directory to your path.</li> <li>Set the <code>ANT_HOME</code> environment variable to the directory where you installed Ant.</li> -<li>Optionally, set the <code>JAVA_HOME</code> environment variable. -(See the <a href="#advanced">Advanced</a> section below.) +<li>Optionally, set the <code>JAVA_HOME</code> environment variable +(see the <a href="#advanced">Advanced</a> section below). This should be set to the directory where your JDK is installed.</li> +<li>Optionally, if you are using optional tasks then you may need to add additional +jars to your <code>lib</code> or CLASSPATH. +See <a href="#librarydependencies">Library Dependencies</a> +for for a list of jar requirements for various features. +</li> </ul> <p><strong>Note:</strong> Do not install Ant's ant.jar file into the lib/ext directory of the JDK/JRE. Ant is an application, whilst the extension @@ -145,11 +150,15 @@ See <a href="#installing">Installing Ant</a> for examples on how to do this for your operating system. </p> -<p>Make sure you have downloaded any auxilliary jars required to +<p>Make sure you have downloaded any auxiliary jars required to build tasks you are interested in. These should either be available -on the classpath or added to <code>lib/optional</code> -directory. The list of auxilliary tasks and requirements is in -<code>lib/README</code>.</p> +on the CLASSPATH or added to the <code>lib/optional</code> +directory. +See <a href="#librarydependencies">Library Dependencies</a> +for for a list of jar requirements for various features. +Note that this will make the auxiliary jars +available for the building of Ant only. For running Ant you will still need to +make the jars available as described under <a href="#installing">Installing Ant</a>.</p> <p>Your are now ready to build Ant:</p> <blockquote> @@ -293,6 +302,75 @@ <li>jars/classes for your XML parser <li>the JDK's required jar/zip files </ul> +<hr> +<h2><a name="librarydependencies">Library Dependencies</a></h2> +<p>The following libraries are needed in your CLASSPATH or in the install directory's <code>lib</code> directory if you are using the indicated feature. Note that only one of the regexp libraries is needed for use with the mappers.</p> +<p/> +<table border="2" width="849"> + <col width="131" style="mso-width-source:userset;mso-width-alt:4790;width:98pt"> + <col width="297" style="mso-width-source:userset;mso-width-alt:10861;width:223pt"> + <col width="407" style="mso-width-source:userset;mso-width-alt:14884;width:305pt"> + <tr height="17" style="height:12.75pt"> + <td height="17" class="xl24" width="135" style="height: 12.75pt"><b>Jar Name</b></td> + <td class="xl24" width="265"><b>Needed For</b></td> + <td class="xl24" width="425"><b>Available At</b></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">jakarta-regexp-1.2.jar</td> + <td width="265">regexp type with mappers</td> + <td class="xl23" width="425"><a href="http://jakarta.apache.org/regexp/"; target="_parent">jakarta.apache.org/regexp/</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">jakarta-oro-2.0.1.jar</td> + <td width="265">regexp type with mappers and the perforce tasks</td> + <td class="xl23" width="425"><a href="http://jakarta.apache.org/oro/"; target="_parent">jakarta.apache.org/oro/</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">junit.jar</td> + <td width="265">junit tasks</td> + <td class="xl23" width="425"><a href="http://www.junit.org/"; target="_parent">www.junit.org</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">stylebook.jar</td> + <td width="265">stylebook task</td> + <td width="425">CVS repository of <a href="http://xml.apache.org"; target="_parent">xml.apache.org</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">testlet.jar</td> + <td width="265">test task</td> + <td class="xl23" width="425"><a href="http://java.apache.org/framework"; target="_parent">java.apache.org/framework</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">???antlr.jar???</td> + <td width="265">antlr task</td> + <td class="xl23" width="425"><a href="http://www.antlr.org/"; target="_parent">www.antlr.org</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">bsf.jar</td> + <td width="265">script task</td> + <td class="xl23" width="425"><a href="http://oss.software.ibm.com/developerworks/projects/bsf"; target="_parent">oss.software.ibm.com/developerworks/projects/bsf</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">netrexx.jar</td> + <td width="265">netrexx task</td> + <td class="xl23" width="425"><a href="http://www2.hursley.ibm.com/netrexx"; target="_parent">www2.hursley.ibm.com/netrexx</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">rhino.jar</td> + <td width="265">javascript with script task</td> + <td class="xl23" width="425"><a href="http://www.mozilla.org/"; target="_parent">www.mozilla.org</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">jpython.jar</td> + <td width="265">python with script task</td> + <td class="xl23" width="425"><a href="http://www.jpython.org/"; target="_parent">www.jpython.org</a></td> + </tr> + <tr height="17" style="height:12.75pt"> + <td height="17" style="height: 12.75pt" width="135">netcomponents.jar</td> + <td width="265">ftp and telnet tasks</td> + <td class="xl23" width="425"><a href="http://www.savarese.org/oro/downloads/index.html#NetComponents"; target="_parent">www.savarese.org/oro/downloads</a></td> + </tr> +</table> <hr> <p align="center">Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.</p>
