| 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
|---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
|---|
| 5 | %general-entities;
|
|---|
| 6 |
|
|---|
| 7 | <!ENTITY apache-ant-download-http "http://archive.apache.org/dist/ant/source/apache-ant-&apache-ant-version;-src.tar.bz2">
|
|---|
| 8 | <!ENTITY apache-ant-download-ftp "ftp://anduin.linuxfromscratch.org/BLFS/svn/a/apache-ant-&apache-ant-version;-src.tar.bz2">
|
|---|
| 9 | <!ENTITY apache-ant-md5sum "d7e0bdd538481b7c15dfb7fbcdd81b0e">
|
|---|
| 10 | <!ENTITY apache-ant-size "3.2 MB">
|
|---|
| 11 | <!ENTITY apache-ant-buildsize "67 MB">
|
|---|
| 12 | <!ENTITY apache-ant-time "0.4 SBU">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="apache-ant" xreflabel="apache-ant-&apache-ant-version;">
|
|---|
| 16 | <?dbhtml filename="apache-ant.html"?>
|
|---|
| 17 |
|
|---|
| 18 | <sect1info>
|
|---|
| 19 | <othername>$LastChangedBy$</othername>
|
|---|
| 20 | <date>$Date$</date>
|
|---|
| 21 | </sect1info>
|
|---|
| 22 |
|
|---|
| 23 | <title>apache-ant-&apache-ant-version;</title>
|
|---|
| 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 |
|
|---|
| 32 | <para>The <application>Apache Ant</application> package is a
|
|---|
| 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>
|
|---|
| 41 |
|
|---|
| 42 | &lfs71_checked;
|
|---|
| 43 |
|
|---|
| 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>
|
|---|
| 69 | <para role="required">
|
|---|
| 70 | <xref linkend="openjdk"/> <!-- or <xref linkend="jdk"/> -->
|
|---|
| 71 | </para>
|
|---|
| 72 |
|
|---|
| 73 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 74 | <para role="recommended">
|
|---|
| 75 | <xref linkend="junit"/>
|
|---|
| 76 | </para>
|
|---|
| 77 |
|
|---|
| 78 | <para condition="html" role="usernotes">User Notes:
|
|---|
| 79 | <ulink url="&blfs-wiki;/apache-ant"/></para>
|
|---|
| 80 |
|
|---|
| 81 | </sect2>
|
|---|
| 82 |
|
|---|
| 83 | <sect2 role="installation">
|
|---|
| 84 | <title>Installation of Apache Ant</title>
|
|---|
| 85 |
|
|---|
| 86 | <note>
|
|---|
| 87 | <para>You may need additional libraries to satisfy the build
|
|---|
| 88 | requirements of various packages installed using
|
|---|
| 89 | <application>Apache Ant</application>. Review the table at
|
|---|
| 90 | <ulink url="http://ant.apache.org/manual/install.html#librarydependencies"/>
|
|---|
| 91 | for any prerequisite libraries you may need.</para>
|
|---|
| 92 | </note>
|
|---|
| 93 |
|
|---|
| 94 | <para>If it is not possible to install the recommended
|
|---|
| 95 | <application>JUnit</application> package, install
|
|---|
| 96 | <application>Apache Ant</application> by removing the reference to the test
|
|---|
| 97 | instructions (note that the tests will not be performed):</para>
|
|---|
| 98 |
|
|---|
| 99 | <screen><userinput>sed -i 's;jars,test-jar;jars;' build.xml</userinput></screen>
|
|---|
| 100 |
|
|---|
| 101 | <para>Install <application>Apache Ant</application> by running the following
|
|---|
| 102 | commands:</para>
|
|---|
| 103 |
|
|---|
| 104 | <screen><userinput>sed -i 's|${dist.dir}/etc|/etc/ant|' build.xml &&
|
|---|
| 105 | sed -i 's|/etc/ant.conf|/etc/ant/ant.conf|' src/script/ant &&
|
|---|
| 106 | cp -v /usr/share/junit-&junit-version;/junit-&junit-version;.jar lib/optional/junit.jar</userinput></screen>
|
|---|
| 107 |
|
|---|
| 108 | <para>The unit regression tests are performed during the build step below
|
|---|
| 109 | unless <application>JUnit</application> is not installed. Now, as the
|
|---|
| 110 | <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 111 |
|
|---|
| 112 | <screen role="root"><userinput>./build.sh -Ddist.dir=/opt/ant-&apache-ant-version; dist &&
|
|---|
| 113 | ln -v -sf /etc/ant /opt/ant-&apache-ant-version;/etc &&
|
|---|
| 114 | ln -v -sf ant-&apache-ant-version; /opt/ant</userinput></screen>
|
|---|
| 115 |
|
|---|
| 116 | </sect2>
|
|---|
| 117 |
|
|---|
| 118 | <sect2 role="commands">
|
|---|
| 119 | <title>Command Explanations</title>
|
|---|
| 120 |
|
|---|
| 121 | <para><command>sed -i 's;jars...</command>: If the
|
|---|
| 122 | <application>JUnit</application> package is not installed, the regression
|
|---|
| 123 | tests cannot be performed.</para>
|
|---|
| 124 |
|
|---|
| 125 | <para><command>sed ...</command>: These commands change the configuration
|
|---|
| 126 | directory to <filename class='directory'>/etc/ant</filename> to conform
|
|---|
| 127 | with FHS guidelines.</para>
|
|---|
| 128 |
|
|---|
| 129 | <para><command>cp -v
|
|---|
| 130 | /usr/share/junit-&junit-version;/&junit-version;.jar ...</command>:
|
|---|
| 131 | This command copies the JUnit jar file into the directory where Apache Ant
|
|---|
| 132 | will look for it.</para>
|
|---|
| 133 |
|
|---|
| 134 | <para><command>./build.sh -Ddist.dir=/opt/ant-&apache-ant-version;
|
|---|
| 135 | dist</command>: This command does everything. It builds, tests, then
|
|---|
| 136 | installs the package into
|
|---|
| 137 | <filename class='directory'>/opt/ant-&apache-ant-version;</filename>.</para>
|
|---|
| 138 |
|
|---|
| 139 | <para><command>ln -v -sf /etc/ant /opt/ant-&apache-ant-version;/etc</command>:
|
|---|
| 140 | The <command>sed</command> commands change the configuration directory to
|
|---|
| 141 | <filename class='directory'>/etc/ant</filename> and this command creates a
|
|---|
| 142 | symlink from the configuration directory back to the installation directory
|
|---|
| 143 | as the package is expecting to find some files there.</para>
|
|---|
| 144 |
|
|---|
| 145 | <para><command>ln -v -sf ant-&apache-ant-version; /opt/ant</command>: This
|
|---|
| 146 | command is optional, and creates a convenience symlink.</para>
|
|---|
| 147 |
|
|---|
| 148 | </sect2>
|
|---|
| 149 |
|
|---|
| 150 | <sect2 role="configuration">
|
|---|
| 151 | <title>Configuring Apache Ant</title>
|
|---|
| 152 |
|
|---|
| 153 | <sect3 id="apache-ant-config">
|
|---|
| 154 | <title>Config Files</title>
|
|---|
| 155 |
|
|---|
| 156 | <para><filename>/etc/ant/ant.conf</filename>,
|
|---|
| 157 | <filename>~/.ant/ant.conf</filename>, and
|
|---|
| 158 | <filename>~/.antrc</filename></para>
|
|---|
| 159 |
|
|---|
| 160 | <indexterm zone="apache-ant apache-ant-config">
|
|---|
| 161 | <primary sortas="e-AA.ant-ant.conf">~/.ant/ant.conf</primary>
|
|---|
| 162 | </indexterm>
|
|---|
| 163 |
|
|---|
| 164 | <indexterm zone="apache-ant apache-ant-config">
|
|---|
| 165 | <primary sortas="e-AA.antrc">~/.antrc</primary>
|
|---|
| 166 | </indexterm>
|
|---|
| 167 |
|
|---|
| 168 | <indexterm zone="apache-ant apache-ant-config">
|
|---|
| 169 | <primary sortas="e-etc-ant-ant.conf">/etc/ant/ant.conf</primary>
|
|---|
| 170 | </indexterm>
|
|---|
| 171 |
|
|---|
| 172 | </sect3>
|
|---|
| 173 |
|
|---|
| 174 | <sect3>
|
|---|
| 175 | <title>Configuration Information</title>
|
|---|
| 176 |
|
|---|
| 177 | <para>Some packages will require <command>ant</command> to be in the
|
|---|
| 178 | search path and the <envar>$ANT_HOME</envar> environment variable
|
|---|
| 179 | defined. Satisfy these requirements by adding the following lines to
|
|---|
| 180 | <filename>/etc/profile</filename> or to individual user's
|
|---|
| 181 | <filename>~/.profile</filename> or <filename>~/.bashrc</filename> files:</para>
|
|---|
| 182 |
|
|---|
| 183 | <screen><literal>export PATH=$PATH:/opt/ant/bin
|
|---|
| 184 | export ANT_HOME=/opt/ant</literal></screen>
|
|---|
| 185 |
|
|---|
| 186 | </sect3>
|
|---|
| 187 |
|
|---|
| 188 | </sect2>
|
|---|
| 189 |
|
|---|
| 190 | <sect2 role="content">
|
|---|
| 191 | <title>Contents</title>
|
|---|
| 192 |
|
|---|
| 193 | <segmentedlist>
|
|---|
| 194 | <segtitle>Installed Programs</segtitle>
|
|---|
| 195 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 196 | <segtitle>Installed Directories</segtitle>
|
|---|
| 197 |
|
|---|
| 198 | <seglistitem>
|
|---|
| 199 | <seg>ant, antRun, antRun.pl, complete-ant-cmd.pl, runant.pl, and runant.py</seg>
|
|---|
| 200 | <seg>ant.jar, ant-*.jar, xercesImpl.jar, and xml-apis.jar</seg>
|
|---|
| 201 | <seg>/etc/ant and /opt/ant-&apache-ant-version;</seg>
|
|---|
| 202 | </seglistitem>
|
|---|
| 203 | </segmentedlist>
|
|---|
| 204 |
|
|---|
| 205 | <variablelist>
|
|---|
| 206 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 207 | <?dbfo list-presentation="list"?>
|
|---|
| 208 | <?dbhtml list-presentation="table"?>
|
|---|
| 209 |
|
|---|
| 210 | <varlistentry id="ant">
|
|---|
| 211 | <term><command>ant</command></term>
|
|---|
| 212 | <listitem>
|
|---|
| 213 | <para>is a <application>Java</application> based build tool used by
|
|---|
| 214 | many packages instead of the conventional <command>make</command>
|
|---|
| 215 | program.</para>
|
|---|
| 216 | <indexterm zone="apache-ant ant">
|
|---|
| 217 | <primary sortas="b-ant">ant</primary>
|
|---|
| 218 | </indexterm>
|
|---|
| 219 | </listitem>
|
|---|
| 220 | </varlistentry>
|
|---|
| 221 |
|
|---|
| 222 | <varlistentry id="antRun">
|
|---|
| 223 | <term><command>antRun</command></term>
|
|---|
| 224 | <listitem>
|
|---|
| 225 | <para>is a support script used to start <command>ant</command>
|
|---|
| 226 | build scripts in a given directory.</para>
|
|---|
| 227 | <indexterm zone="apache-ant antRun">
|
|---|
| 228 | <primary sortas="b-antRun">antRun</primary>
|
|---|
| 229 | </indexterm>
|
|---|
| 230 | </listitem>
|
|---|
| 231 | </varlistentry>
|
|---|
| 232 |
|
|---|
| 233 | <varlistentry id="antRun.pl">
|
|---|
| 234 | <term><command>antRun.pl</command></term>
|
|---|
| 235 | <listitem>
|
|---|
| 236 | <para>is a <application>Perl</application> script that provides
|
|---|
| 237 | similar functionality offered by the <command>antRun</command> script.</para>
|
|---|
| 238 | <indexterm zone="apache-ant antRun.pl">
|
|---|
| 239 | <primary sortas="b-antRun.pl">antRun.pl</primary>
|
|---|
| 240 | </indexterm>
|
|---|
| 241 | </listitem>
|
|---|
| 242 | </varlistentry>
|
|---|
| 243 |
|
|---|
| 244 | <varlistentry id="complete-ant-cmd.pl">
|
|---|
| 245 | <term><command>complete-ant-cmd.pl</command></term>
|
|---|
| 246 | <listitem>
|
|---|
| 247 | <para>is a <application>Perl</application> script that allows
|
|---|
| 248 | <application>Bash</application> to complete an <command>ant</command>
|
|---|
| 249 | command-line.</para>
|
|---|
| 250 | <indexterm zone="apache-ant complete-ant-cmd.pl">
|
|---|
| 251 | <primary sortas="b-complete-ant-cmd.pl">complete-ant-cmd.pl</primary>
|
|---|
| 252 | </indexterm>
|
|---|
| 253 | </listitem>
|
|---|
| 254 | </varlistentry>
|
|---|
| 255 |
|
|---|
| 256 | <varlistentry id="runant.pl">
|
|---|
| 257 | <term><command>runant.pl</command></term>
|
|---|
| 258 | <listitem>
|
|---|
| 259 | <para>is a <application>Perl</application> wrapper script used to
|
|---|
| 260 | invoke <command>ant</command>.</para>
|
|---|
| 261 | <indexterm zone="apache-ant runant.pl">
|
|---|
| 262 | <primary sortas="b-runant.pl">runant.pl</primary>
|
|---|
| 263 | </indexterm>
|
|---|
| 264 | </listitem>
|
|---|
| 265 | </varlistentry>
|
|---|
| 266 |
|
|---|
| 267 | <varlistentry id="runant.py">
|
|---|
| 268 | <term><command>runant.py</command></term>
|
|---|
| 269 | <listitem>
|
|---|
| 270 | <para>is a <application>Python</application> wrapper script used to
|
|---|
| 271 | invoke <command>ant</command>.</para>
|
|---|
| 272 | <indexterm zone="apache-ant runant.py">
|
|---|
| 273 | <primary sortas="b-runant.py">runant.py</primary>
|
|---|
| 274 | </indexterm>
|
|---|
| 275 | </listitem>
|
|---|
| 276 | </varlistentry>
|
|---|
| 277 |
|
|---|
| 278 | <varlistentry id="ant-star">
|
|---|
| 279 | <term><filename class='libraryfile'>ant-*.jar</filename></term>
|
|---|
| 280 | <listitem>
|
|---|
| 281 | <para>files are the <application>Apache Ant</application>
|
|---|
| 282 | <application>Java</application> class libraries.</para>
|
|---|
| 283 | <indexterm zone="apache-ant ant-star">
|
|---|
| 284 | <primary sortas="c-ant-star">ant-*.jar</primary>
|
|---|
| 285 | </indexterm>
|
|---|
| 286 | </listitem>
|
|---|
| 287 | </varlistentry>
|
|---|
| 288 |
|
|---|
| 289 | <varlistentry id="xercesImpl">
|
|---|
| 290 | <term><filename class='libraryfile'>xercesImpl.jar</filename></term>
|
|---|
| 291 | <listitem>
|
|---|
| 292 | <para>is a <application>Java</application> class library used by
|
|---|
| 293 | <application>Apache Ant</application> to perform XML parsing.</para>
|
|---|
| 294 | <indexterm zone="apache-ant xercesImpl">
|
|---|
| 295 | <primary sortas="c-xercesImpl">xercesImpl.jar</primary>
|
|---|
| 296 | </indexterm>
|
|---|
| 297 | </listitem>
|
|---|
| 298 | </varlistentry>
|
|---|
| 299 |
|
|---|
| 300 | <varlistentry id="xml-apis">
|
|---|
| 301 | <term><filename class='libraryfile'>xml-apis.jar</filename></term>
|
|---|
| 302 | <listitem>
|
|---|
| 303 | <para>contains the DOM <application>Java</application> classes required
|
|---|
| 304 | by the <application>Apache Ant</application> XML formatter.</para>
|
|---|
| 305 | <indexterm zone="apache-ant xml-apis">
|
|---|
| 306 | <primary sortas="c-xml-apis">xml-apis.jar</primary>
|
|---|
| 307 | </indexterm>
|
|---|
| 308 | </listitem>
|
|---|
| 309 | </varlistentry>
|
|---|
| 310 |
|
|---|
| 311 | </variablelist>
|
|---|
| 312 |
|
|---|
| 313 | </sect2>
|
|---|
| 314 |
|
|---|
| 315 | </sect1>
|
|---|
