Browse Source

Document the requirement for optional jar and how to install it

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269366 13f79535-47bb-0310-9956-ffa450edef68
master
Conor MacNeill 24 years ago
parent
commit
b38b7eee8e
1 changed files with 19 additions and 8 deletions
  1. +19
    -8
      docs/manual/install.html

+ 19
- 8
docs/manual/install.html View File

@@ -6,7 +6,6 @@
</head>

<body>

<h1>Installing Ant</h1>
<h2><a name="getting">Getting Ant</a></h2>
<h3>Binary edition</h3>
@@ -100,18 +99,27 @@ Windows NT/2000) - but it is better to not rely on this behavior.</li>
<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>If you are using Ant's optional tasks then you may need to add additional
jars to your <code>lib</code> directory or to your CLASSPATH.
See <a href="#librarydependencies">Library Dependencies</a>
for for a list of jar requirements for various optional tasks.
</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
directory is intended for JDK extensions. In particular there are security
restrictions on the classes which may be loaded by an extension.</p>

<h3>Optional Tasks</h3>
<p>Ant supports a number of optional tasks. An optional task is a task which
typically requires an external library to function. The optional tasks are
packaged separately from the core Ant tasks. This package is available in
the same download directory as the core ant distribution. The current
jar containing optional tasks is named <code>jakarta-ant-1.3-optional.jar</code>.
This jar should be downloaded and placed in the lib directory of your Ant
installation.</p>

<p>The external libraries required by each of the optional tasks is detailed
in the <a href="#librarydependencies">Library Dependencies</a> section. These external
libraries may either be placed in Ant's lib directory, where they will be picked up
automatically, or made available on the system CLASSPATH environment variable.
</p>

<h3>Windows</h3>
<p>Assume Ant is installed in <code>c:\ant\</code>. The following sets up the
environment:</p>
@@ -223,7 +231,10 @@ the current Ant version in <code>ANT_HOME</code>.</p>
<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>
needed for use with the mappers. You will also need to install the
Ant optional jar containing the task definitions to make these
tasks available. Please refer to the <a href="#installing">
Installing Ant</a> section above.</p>

<table border="1" cellpadding="2" cellspacing="0">
<tr>


Loading…
Cancel
Save