source: general/prog/apache-ant.xml@ a0ad432

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY apache-ant-download-http "https://archive.apache.org/dist/ant/source/apache-ant-&apache-ant-version;-src.tar.xz">
  <!ENTITY apache-ant-download-ftp  " ">
  <!ENTITY apache-ant-md5sum        "778c68be3787dfebc249de45598f63b2">
  <!ENTITY apache-ant-size          "3.6 MB">
  <!ENTITY apache-ant-buildsize     "196 MB">
  <!ENTITY apache-ant-time          "0.2 SBU (excluding download time)">
]>

<sect1 id="apache-ant" xreflabel="apache-ant-&apache-ant-version;">
  <?dbhtml filename="apache-ant.html"?>


  <title>apache-ant-&apache-ant-version;</title>

  <indexterm zone="apache-ant">
   <primary sortas="a-Apache-Ant">Apache Ant</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Apache Ant</title>

    <para>
      The <application>Apache Ant</application> package is a
      <application>Java</application>-based build tool. In theory, it is
      like the <command>make</command> command, but without
      <command>make</command>'s wrinkles. <application>Ant</application> is
      different. Instead of a model that is extended with shell-based commands,
      <application>Ant</application> is extended using
      <application>Java</application> classes. Instead of writing shell
      commands, the configuration files are XML-based, calling out a target
      tree that executes various tasks. Each task is run by an object that
      implements a particular task interface.
    </para>

    &lfs122_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&apache-ant-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&apache-ant-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &apache-ant-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &apache-ant-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &apache-ant-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &apache-ant-time;
        </para>
      </listitem>
    </itemizedlist>
<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required file: <ulink
             url="https://repository.jboss.org/nexus/content/repositories/thirdparty-releases/javax/media/jai-core/1.1.3/jai-core-1.1.3.jar"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Required file: <ulink
             url="https://repository.jboss.org/nexus/content/repositories/thirdparty-releases/com/sun/media/jai-codec/1.1.3/jai-codec-1.1.3.jar"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Required file: <ulink
             url="http://central.maven.org/maven2/org/tukaani/xz/1.0/xz-1.0.jar"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Required file: <ulink
             url="http://www.netrexx.org/files/NetRexx-3.06-GA.zip"/>
        </para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">Apache Ant Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      A JDK (<xref linkend="java-bin"/> or <xref linkend="openjdk"/>) and
      <xref linkend="glib2"/>
    </para>

    &build-use-internet;

<!--    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="junit"/>
    </para>
-->
  </sect2>

  <sect2 role="installation">
    <title>Installation of Apache Ant</title>

    <para>
      Build a limited bootstrap version of <application>Apache
      Ant</application> using the following command:
    </para>

<screen><userinput>./bootstrap.sh</userinput></screen>

    <para>
      Download the runtime dependencies using the
      <filename>fetch.xml</filename> ant build script:
    </para>

<!-- A spsce betweem -D and dest makes the build fail. -->

<screen><userinput>bootstrap/bin/ant -f fetch.xml -Ddest=optional</userinput></screen>

    <para>
      Build <application>Apache Ant</application> by running the following
      command:
    </para>

<!-- A spsce betweem -D and dest here passes, but leave it out for consistency. -->

<screen><userinput>./build.sh -Ddist.dir=$PWD/ant-&apache-ant-version; dist</userinput></screen>

    <para>
      Install, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>cp -rv ant-&apache-ant-version; /opt/            &amp;&amp;
chown -R root:root /opt/ant-&apache-ant-version; &amp;&amp;
ln -sfv ant-&apache-ant-version; /opt/ant</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>bootstrap/bin/ant -f fetch.xml -Ddest=optional</command>:
      Downloads the missing dependencies to the user's home directory, and
      copies them into the source tree (in the <filename>lib/optional</filename>
      directory, where <command>ant</command> picks them up at build time).
    </para>

    <para>
      <command>./build.sh -Ddist.dir=$PWD/ant-&apache-ant-version;
      dist</command>: This command builds, tests, then installs the package
      into a temporary directory.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Apache Ant</title>

    <sect3 id="apache-ant-config">
      <title>Config Files</title>

      <para>
        <filename>/etc/ant/ant.conf</filename>,
        <filename>~/.ant/ant.conf</filename>, and
        <filename>~/.antrc</filename>
      </para>

      <indexterm zone="apache-ant apache-ant-config">
        <primary sortas="e-AA.ant-ant.conf">~/.ant/ant.conf</primary>
      </indexterm>

      <indexterm zone="apache-ant apache-ant-config">
        <primary sortas="e-AA.antrc">~/.antrc</primary>
      </indexterm>

      <indexterm zone="apache-ant apache-ant-config">
        <primary sortas="e-etc-ant-ant.conf">/etc/ant/ant.conf</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>
        Some packages will require <command>ant</command> to be in the
        search path and the <envar>ANT_HOME</envar> environment variable
        defined. Satisfy these requirements by issuing, as the <systemitem
        class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>cat &gt; /etc/profile.d/ant.sh &lt;&lt; EOF
<literal># Begin /etc/profile.d/ant.sh

pathappend /opt/ant/bin
export ANT_HOME=/opt/ant

# End /etc/profile.d/ant.sh</literal>
EOF</userinput></screen>

      <para>
        The above instructions assume you have configured your system as
        described in <xref linkend="postlfs-config-profile"/>.
      </para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          ant, antRun, antRun.pl, complete-ant-cmd.pl, runant.pl, and runant.py         </seg>
        <seg>
          Numerous <filename>ant*.jar</filename>  and dependent libraries in
          <envar>$ANT_HOME</envar><filename>/lib</filename>
        </seg>
        <seg>/opt/ant-&apache-ant-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="ant">
        <term><command>ant</command></term>
        <listitem>
          <para>
            is a <application>Java</application> based build tool used by
            many packages instead of the conventional <command>make</command>
            program
          </para>
          <indexterm zone="apache-ant ant">
            <primary sortas="b-ant">ant</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="antRun">
        <term><command>antRun</command></term>
        <listitem>
          <para>
            is a support script used to start <command>ant</command>
            build scripts in a given directory
          </para>
          <indexterm zone="apache-ant antRun">
            <primary sortas="b-antRun">antRun</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="antRun.pl">
        <term><command>antRun.pl</command></term>
        <listitem>
          <para>
            is a <application>Perl</application> script that provides similar
            functionality offered by the <command>antRun</command> script
          </para>
          <indexterm zone="apache-ant antRun.pl">
            <primary sortas="b-antRun.pl">antRun.pl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="complete-ant-cmd.pl">
        <term><command>complete-ant-cmd.pl</command></term>
        <listitem>
          <para>
            is a <application>Perl</application> script that allows
            <application>Bash</application> to complete an
            <command>ant</command> command-line
          </para>
          <indexterm zone="apache-ant complete-ant-cmd.pl">
            <primary sortas="b-complete-ant-cmd.pl">complete-ant-cmd.pl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="runant.pl">
        <term><command>runant.pl</command></term>
        <listitem>
          <para>
            is a <application>Perl</application> wrapper script used to
            invoke <command>ant</command>
          </para>
          <indexterm zone="apache-ant runant.pl">
            <primary sortas="b-runant.pl">runant.pl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="runant.py">
        <term><command>runant.py</command></term>
        <listitem>
          <para>
            is a <application>Python</application> wrapper script used to
            invoke <command>ant</command>
          </para>
          <indexterm zone="apache-ant runant.py">
            <primary sortas="b-runant.py">runant.py</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ant-star">
        <term><filename class="libraryfile">ant*.jar</filename></term>
        <listitem>
          <para>
            files are the <application>Apache Ant</application>
            <application>Java</application> class libraries
          </para>
          <indexterm zone="apache-ant ant-star">
            <primary sortas="c-ant-star">ant-*.jar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>