[dd5bdf3] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[dd5bdf3] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[5bd4ba6e] | 7 | <!ENTITY apache-ant-download-http "http://archive.apache.org/dist/ant/source/apache-ant-&apache-ant-version;-src.tar.bz2">
|
---|
[e8edecd] | 8 | <!ENTITY apache-ant-download-ftp " ">
|
---|
[debb88bf] | 9 | <!ENTITY apache-ant-md5sum "8f610c1a0183507c2beebbf230f456af">
|
---|
[ff53809] | 10 | <!ENTITY apache-ant-size "3.2 MB">
|
---|
[debb88bf] | 11 | <!ENTITY apache-ant-buildsize "120 MB">
|
---|
| 12 | <!ENTITY apache-ant-time "0.5 SBU">
|
---|
[dd5bdf3] | 13 | ]>
|
---|
| 14 |
|
---|
[ff53809] | 15 | <sect1 id="apache-ant" xreflabel="apache-ant-&apache-ant-version;">
|
---|
[514ef84d] | 16 | <?dbhtml filename="apache-ant.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[ff53809] | 23 | <title>apache-ant-&apache-ant-version;</title>
|
---|
[514ef84d] | 24 |
|
---|
| 25 | <indexterm zone="apache-ant">
|
---|
| 26 | <primary sortas="a-Apache-Ant">Apache Ant</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Apache Ant</title>
|
---|
| 31 |
|
---|
[539ace5] | 32 | <para>The <application>Apache Ant</application> package is a
|
---|
[e549304] | 33 | <application>Java</application>-based build tool. In theory, it is kind of
|
---|
| 34 | like <command>make</command>, but without <command>make</command>'s
|
---|
| 35 | wrinkles. <application>Ant</application> is different. Instead of a model
|
---|
| 36 | that is extended with shell-based commands, <application>Ant</application>
|
---|
| 37 | is extended using <application>Java</application> classes. Instead of
|
---|
| 38 | writing shell commands, the configuration files are XML-based, calling out
|
---|
| 39 | a target tree that executes various tasks. Each task is run by an object
|
---|
| 40 | that implements a particular task interface.</para>
|
---|
[514ef84d] | 41 |
|
---|
[e1e9a2a] | 42 | &lfs74_checked;
|
---|
[50929e8] | 43 |
|
---|
[514ef84d] | 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download (HTTP): <ulink url="&apache-ant-download-http;"/></para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download (FTP): <ulink url="&apache-ant-download-ftp;"/></para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Download MD5 sum: &apache-ant-md5sum;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Download size: &apache-ant-size;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Estimated disk space required: &apache-ant-buildsize;</para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>Estimated build time: &apache-ant-time;</para>
|
---|
| 63 | </listitem>
|
---|
| 64 | </itemizedlist>
|
---|
| 65 |
|
---|
| 66 | <bridgehead renderas="sect3">Apache Ant Dependencies</bridgehead>
|
---|
| 67 |
|
---|
| 68 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[ff53809] | 69 | <para role="required">
|
---|
[debb88bf] | 70 | A JDK (<xref linkend="java-bin"/> or <xref linkend="openjdk"/>)
|
---|
[ff53809] | 71 | </para>
|
---|
[66ab31e] | 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[ff53809] | 74 | <para role="recommended">
|
---|
| 75 | <xref linkend="junit"/>
|
---|
| 76 | </para>
|
---|
[514ef84d] | 77 |
|
---|
[1039de3] | 78 | <para condition="html" role="usernotes">User Notes:
|
---|
| 79 | <ulink url="&blfs-wiki;/apache-ant"/></para>
|
---|
| 80 |
|
---|
[514ef84d] | 81 | </sect2>
|
---|
| 82 |
|
---|
| 83 | <sect2 role="installation">
|
---|
| 84 | <title>Installation of Apache Ant</title>
|
---|
| 85 |
|
---|
| 86 | <note>
|
---|
[919683dc] | 87 | <para>You may need additional libraries to satisfy the build
|
---|
[539ace5] | 88 | requirements of various packages installed using
|
---|
| 89 | <application>Apache Ant</application>. Review the table at
|
---|
[0619e6d] | 90 | <ulink url="http://ant.apache.org/manual/install.html#librarydependencies"/>
|
---|
[debb88bf] | 91 | for any prerequisite libraries you may need. Place any needed libraries
|
---|
| 92 | in <filename>lib/optional</filename>.</para>
|
---|
[514ef84d] | 93 | </note>
|
---|
| 94 |
|
---|
[d414190] | 95 | <para>If it is not possible to install the recommended
|
---|
| 96 | <application>JUnit</application> package, install
|
---|
| 97 | <application>Apache Ant</application> by removing the reference to the test
|
---|
| 98 | instructions (note that the tests will not be performed):</para>
|
---|
[66ab31e] | 99 |
|
---|
[debb88bf] | 100 | <screen><userinput>sed -i 's/jars,test-jar/jars/' build.xml</userinput></screen>
|
---|
[66ab31e] | 101 |
|
---|
[0d7900a] | 102 | <para>otherwise copy the <application>junit</application> jar file to the
|
---|
[e8edecd] | 103 | local directory tree.</para>
|
---|
| 104 |
|
---|
[debb88bf] | 105 | <screen><userinput>cp -v /usr/share/java/junit-&junit-version;.jar lib/optional</userinput></screen>
|
---|
[e8edecd] | 106 |
|
---|
[539ace5] | 107 | <para>Install <application>Apache Ant</application> by running the following
|
---|
[514ef84d] | 108 | commands:</para>
|
---|
| 109 |
|
---|
[d414190] | 110 | <para>The unit regression tests are performed during the build step below
|
---|
| 111 | unless <application>JUnit</application> is not installed. Now, as the
|
---|
| 112 | <systemitem class="username">root</systemitem> user:</para>
|
---|
[514ef84d] | 113 |
|
---|
| 114 | <screen role="root"><userinput>./build.sh -Ddist.dir=/opt/ant-&apache-ant-version; dist &&
|
---|
[e8edecd] | 115 | ln -v -sfn ant-&apache-ant-version; /opt/ant</userinput></screen>
|
---|
| 116 |
|
---|
| 117 | <note><para>Make sure the JAVA_HOME environment variable is set for the
|
---|
| 118 | <systemitem class="username">root</systemitem> user.</para></note>
|
---|
[514ef84d] | 119 |
|
---|
| 120 | </sect2>
|
---|
| 121 |
|
---|
| 122 | <sect2 role="commands">
|
---|
| 123 | <title>Command Explanations</title>
|
---|
| 124 |
|
---|
[debb88bf] | 125 | <para><command>sed -i 's/jars...</command>: If the
|
---|
[d414190] | 126 | <application>JUnit</application> package is not installed, the regression
|
---|
| 127 | tests cannot be performed.</para>
|
---|
[66ab31e] | 128 |
|
---|
[e549304] | 129 | <para><command>cp -v
|
---|
[debb88bf] | 130 | /usr/share/java/junit-&junit-version;.jar ...</command>:
|
---|
[9b9be0d] | 131 | This command copies the JUnit jar file into the directory where Apache Ant
|
---|
| 132 | will look for it.</para>
|
---|
| 133 |
|
---|
[539ace5] | 134 | <para><command>./build.sh -Ddist.dir=/opt/ant-&apache-ant-version;
|
---|
[915403df] | 135 | dist</command>: This command does everything. It builds, tests, then
|
---|
[539ace5] | 136 | installs the package into
|
---|
[514ef84d] | 137 | <filename class='directory'>/opt/ant-&apache-ant-version;</filename>.</para>
|
---|
| 138 |
|
---|
[e8edecd] | 139 | <para><command>ln -v -sfn ant-&apache-ant-version; /opt/ant</command>: This
|
---|
[514ef84d] | 140 | command is optional, and creates a convenience symlink.</para>
|
---|
| 141 |
|
---|
| 142 | </sect2>
|
---|
| 143 |
|
---|
| 144 | <sect2 role="configuration">
|
---|
| 145 | <title>Configuring Apache Ant</title>
|
---|
| 146 |
|
---|
| 147 | <sect3 id="apache-ant-config">
|
---|
[30edc031] | 148 | <title>Config Files</title>
|
---|
[514ef84d] | 149 |
|
---|
[539ace5] | 150 | <para><filename>/etc/ant/ant.conf</filename>,
|
---|
| 151 | <filename>~/.ant/ant.conf</filename>, and
|
---|
[514ef84d] | 152 | <filename>~/.antrc</filename></para>
|
---|
| 153 |
|
---|
| 154 | <indexterm zone="apache-ant apache-ant-config">
|
---|
| 155 | <primary sortas="e-AA.ant-ant.conf">~/.ant/ant.conf</primary>
|
---|
| 156 | </indexterm>
|
---|
| 157 |
|
---|
| 158 | <indexterm zone="apache-ant apache-ant-config">
|
---|
| 159 | <primary sortas="e-AA.antrc">~/.antrc</primary>
|
---|
| 160 | </indexterm>
|
---|
| 161 |
|
---|
| 162 | <indexterm zone="apache-ant apache-ant-config">
|
---|
| 163 | <primary sortas="e-etc-ant-ant.conf">/etc/ant/ant.conf</primary>
|
---|
| 164 | </indexterm>
|
---|
| 165 |
|
---|
| 166 | </sect3>
|
---|
| 167 |
|
---|
| 168 | <sect3>
|
---|
| 169 | <title>Configuration Information</title>
|
---|
| 170 |
|
---|
[e549304] | 171 | <para>Some packages will require <command>ant</command> to be in the
|
---|
| 172 | search path and the <envar>$ANT_HOME</envar> environment variable
|
---|
| 173 | defined. Satisfy these requirements by adding the following lines to
|
---|
[539ace5] | 174 | <filename>/etc/profile</filename> or to individual user's
|
---|
[514ef84d] | 175 | <filename>~/.profile</filename> or <filename>~/.bashrc</filename> files:</para>
|
---|
| 176 |
|
---|
| 177 | <screen><literal>export PATH=$PATH:/opt/ant/bin
|
---|
| 178 | export ANT_HOME=/opt/ant</literal></screen>
|
---|
| 179 |
|
---|
| 180 | </sect3>
|
---|
| 181 |
|
---|
| 182 | </sect2>
|
---|
| 183 |
|
---|
| 184 | <sect2 role="content">
|
---|
| 185 | <title>Contents</title>
|
---|
| 186 |
|
---|
| 187 | <segmentedlist>
|
---|
| 188 | <segtitle>Installed Programs</segtitle>
|
---|
| 189 | <segtitle>Installed Libraries</segtitle>
|
---|
| 190 | <segtitle>Installed Directories</segtitle>
|
---|
| 191 |
|
---|
| 192 | <seglistitem>
|
---|
| 193 | <seg>ant, antRun, antRun.pl, complete-ant-cmd.pl, runant.pl, and runant.py</seg>
|
---|
[e8edecd] | 194 | <seg>ant*.jar</seg>
|
---|
| 195 | <seg>/opt/ant-&apache-ant-version;</seg>
|
---|
[514ef84d] | 196 | </seglistitem>
|
---|
| 197 | </segmentedlist>
|
---|
| 198 |
|
---|
| 199 | <variablelist>
|
---|
| 200 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 201 | <?dbfo list-presentation="list"?>
|
---|
| 202 | <?dbhtml list-presentation="table"?>
|
---|
| 203 |
|
---|
| 204 | <varlistentry id="ant">
|
---|
| 205 | <term><command>ant</command></term>
|
---|
| 206 | <listitem>
|
---|
[539ace5] | 207 | <para>is a <application>Java</application> based build tool used by
|
---|
[0619e6d] | 208 | many packages instead of the conventional <command>make</command>
|
---|
[514ef84d] | 209 | program.</para>
|
---|
| 210 | <indexterm zone="apache-ant ant">
|
---|
| 211 | <primary sortas="b-ant">ant</primary>
|
---|
| 212 | </indexterm>
|
---|
| 213 | </listitem>
|
---|
| 214 | </varlistentry>
|
---|
| 215 |
|
---|
| 216 | <varlistentry id="antRun">
|
---|
| 217 | <term><command>antRun</command></term>
|
---|
| 218 | <listitem>
|
---|
[0619e6d] | 219 | <para>is a support script used to start <command>ant</command>
|
---|
[514ef84d] | 220 | build scripts in a given directory.</para>
|
---|
| 221 | <indexterm zone="apache-ant antRun">
|
---|
| 222 | <primary sortas="b-antRun">antRun</primary>
|
---|
| 223 | </indexterm>
|
---|
| 224 | </listitem>
|
---|
| 225 | </varlistentry>
|
---|
| 226 |
|
---|
| 227 | <varlistentry id="antRun.pl">
|
---|
| 228 | <term><command>antRun.pl</command></term>
|
---|
| 229 | <listitem>
|
---|
[539ace5] | 230 | <para>is a <application>Perl</application> script that provides
|
---|
[514ef84d] | 231 | similar functionality offered by the <command>antRun</command> script.</para>
|
---|
| 232 | <indexterm zone="apache-ant antRun.pl">
|
---|
| 233 | <primary sortas="b-antRun.pl">antRun.pl</primary>
|
---|
| 234 | </indexterm>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
| 237 |
|
---|
| 238 | <varlistentry id="complete-ant-cmd.pl">
|
---|
| 239 | <term><command>complete-ant-cmd.pl</command></term>
|
---|
| 240 | <listitem>
|
---|
[539ace5] | 241 | <para>is a <application>Perl</application> script that allows
|
---|
[0619e6d] | 242 | <application>Bash</application> to complete an <command>ant</command>
|
---|
[514ef84d] | 243 | command-line.</para>
|
---|
| 244 | <indexterm zone="apache-ant complete-ant-cmd.pl">
|
---|
| 245 | <primary sortas="b-complete-ant-cmd.pl">complete-ant-cmd.pl</primary>
|
---|
| 246 | </indexterm>
|
---|
| 247 | </listitem>
|
---|
| 248 | </varlistentry>
|
---|
| 249 |
|
---|
| 250 | <varlistentry id="runant.pl">
|
---|
| 251 | <term><command>runant.pl</command></term>
|
---|
| 252 | <listitem>
|
---|
[539ace5] | 253 | <para>is a <application>Perl</application> wrapper script used to
|
---|
[514ef84d] | 254 | invoke <command>ant</command>.</para>
|
---|
| 255 | <indexterm zone="apache-ant runant.pl">
|
---|
| 256 | <primary sortas="b-runant.pl">runant.pl</primary>
|
---|
| 257 | </indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
| 260 |
|
---|
| 261 | <varlistentry id="runant.py">
|
---|
| 262 | <term><command>runant.py</command></term>
|
---|
| 263 | <listitem>
|
---|
[539ace5] | 264 | <para>is a <application>Python</application> wrapper script used to
|
---|
[514ef84d] | 265 | invoke <command>ant</command>.</para>
|
---|
| 266 | <indexterm zone="apache-ant runant.py">
|
---|
| 267 | <primary sortas="b-runant.py">runant.py</primary>
|
---|
| 268 | </indexterm>
|
---|
| 269 | </listitem>
|
---|
| 270 | </varlistentry>
|
---|
| 271 |
|
---|
| 272 | <varlistentry id="ant-star">
|
---|
[e8edecd] | 273 | <term><filename class='libraryfile'>ant*.jar</filename></term>
|
---|
[514ef84d] | 274 | <listitem>
|
---|
[0619e6d] | 275 | <para>files are the <application>Apache Ant</application>
|
---|
[514ef84d] | 276 | <application>Java</application> class libraries.</para>
|
---|
| 277 | <indexterm zone="apache-ant ant-star">
|
---|
| 278 | <primary sortas="c-ant-star">ant-*.jar</primary>
|
---|
| 279 | </indexterm>
|
---|
| 280 | </listitem>
|
---|
| 281 | </varlistentry>
|
---|
| 282 |
|
---|
| 283 | </variablelist>
|
---|
| 284 |
|
---|
| 285 | </sect2>
|
---|
[dd5bdf3] | 286 |
|
---|
| 287 | </sect1>
|
---|