source: general/sysutils/apache-ant.xml@ 6732c094

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 6732c094 was 6732c094, checked in by Randy McMurchy <randy@…>, 17 years ago

Updated all the XML files (and the one stylesheet) to use the 4.5 version of DocBook XML DTD

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@6716 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 11.7 KB
Line 
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://apache.org/dist/ant/source/apache-ant-&apache-ant-version;-src.tar.bz2">
8 <!ENTITY apache-ant-download-ftp "ftp://ftp.oregonstate.edu/pub/apache/ant/source/apache-ant-&apache-ant-version;-src.tar.bz2">
9 <!ENTITY apache-ant-md5sum "22b378e27ab300e4d73bf09d91c7e2a6">
10 <!ENTITY apache-ant-size "6.8 MB">
11 <!ENTITY apache-ant-buildsize "109 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 like
34 <command>make</command>, but without <command>make</command>'s wrinkles.
35 Ant is different. Instead of a model where it is extended with shell-based commands,
36 Ant is extended using <application>Java</application> classes. Instead of writing
37 shell commands, the configuration files are XML-based, calling out a target tree where
38 various tasks get executed. Each task is run by an object that implements a
39 particular task interface.</para>
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>Download (HTTP): <ulink url="&apache-ant-download-http;"/></para>
45 </listitem>
46 <listitem>
47 <para>Download (FTP): <ulink url="&apache-ant-download-ftp;"/></para>
48 </listitem>
49 <listitem>
50 <para>Download MD5 sum: &apache-ant-md5sum;</para>
51 </listitem>
52 <listitem>
53 <para>Download size: &apache-ant-size;</para>
54 </listitem>
55 <listitem>
56 <para>Estimated disk space required: &apache-ant-buildsize;</para>
57 </listitem>
58 <listitem>
59 <para>Estimated build time: &apache-ant-time;</para>
60 </listitem>
61 </itemizedlist>
62
63 <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
64 <itemizedlist spacing="compact">
65 <listitem>
66 <para>Required Patch: <ulink
67 url="&patch-root;/apache-ant-&apache-ant-version;-blfs_install-1.patch"/></para>
68 </listitem>
69 </itemizedlist> -->
70
71 <bridgehead renderas="sect3">Apache Ant Dependencies</bridgehead>
72
73 <bridgehead renderas="sect4">Required</bridgehead>
74 <para role="required"><xref linkend="jdk"/> and
75 <xref linkend="junit"/></para>
76
77 <para condition="html" role="usernotes">User Notes:
78 <ulink url="&blfs-wiki;/apache-ant"/></para>
79
80 </sect2>
81
82 <sect2 role="installation">
83 <title>Installation of Apache Ant</title>
84
85 <note>
86 <para>You may need additional libraries to satisfy the build
87 requirements of various packages installed using
88 <application>Apache Ant</application>. Review the table at
89 <ulink url="http://ant.apache.org/manual/install.html#librarydependencies"/>
90 for any prerequisite libraries you may need.</para>
91
92 <!-- <para>One such library is the
93 <application>JUnit</application>-3.8.1 testing framework library. Many
94 Ant-installed packages will use this library to perform the unit tests
95 during the build process. To install the JUnit library along with the
96 <application>Apache Ant</application> package, download it from
97 <ulink url="http://www.junit.org/"/>, unzip the distribution file (requires
98 <xref linkend="unzip"/>) and copy the <filename>junit.jar</filename> file
99 into the <filename class='directory'>lib</filename> subdirectory of the
100 <application>Apache Ant</application> source tree before beginning the
101 <application>Apache Ant</application> build.</para> -->
102 </note>
103
104 <para>Install <application>Apache Ant</application> by running the following
105 commands:</para>
106
107<screen><userinput>sed -i 's|${dist.dir}/etc|/etc/ant|' build.xml
108sed -i 's|/etc/ant.conf|/etc/ant/ant.conf|' src/script/ant</userinput></screen>
109
110 <para>The unit regression tests are performed in the build step below.</para>
111
112 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
113
114<screen role="root"><userinput>./build.sh -Ddist.dir=/opt/ant-&apache-ant-version; dist &amp;&amp;
115ln -v -sf /etc/ant /opt/ant-&apache-ant-version;/etc &amp;&amp;
116ln -v -sf ant-&apache-ant-version; /opt/ant</userinput></screen>
117
118 </sect2>
119
120 <sect2 role="commands">
121 <title>Command Explanations</title>
122
123 <para><command>sed ...</command>: These commands change the configuration
124 directory to <filename class='directory'>/etc/ant</filename> to conform
125 with FHS guidelines.</para>
126
127 <para><command>./build.sh -Ddist.dir=/opt/ant-&apache-ant-version;
128 dist</command>: This command does everything. It builds, tests, then
129 installs the package into
130 <filename class='directory'>/opt/ant-&apache-ant-version;</filename>.</para>
131
132 <para><command>ln -v -sf /etc/ant /opt/ant-&apache-ant-version;/etc</command>:
133 The <command>sed</command> commands change the configuration directory to
134 <filename class='directory'>/etc/ant</filename> and this command creates a
135 symlink from the configuration directory back to the installation directory
136 as the package is expecting to find some files there.</para>
137
138 <para><command>ln -v -sf ant-&apache-ant-version; /opt/ant</command>: This
139 command is optional, and creates a convenience symlink.</para>
140
141 </sect2>
142
143 <sect2 role="configuration">
144 <title>Configuring Apache Ant</title>
145
146 <sect3 id="apache-ant-config">
147 <title>Config Files</title>
148
149 <para><filename>/etc/ant/ant.conf</filename>,
150 <filename>~/.ant/ant.conf</filename>, and
151 <filename>~/.antrc</filename></para>
152
153 <indexterm zone="apache-ant apache-ant-config">
154 <primary sortas="e-AA.ant-ant.conf">~/.ant/ant.conf</primary>
155 </indexterm>
156
157 <indexterm zone="apache-ant apache-ant-config">
158 <primary sortas="e-AA.antrc">~/.antrc</primary>
159 </indexterm>
160
161 <indexterm zone="apache-ant apache-ant-config">
162 <primary sortas="e-etc-ant-ant.conf">/etc/ant/ant.conf</primary>
163 </indexterm>
164
165 </sect3>
166
167 <sect3>
168 <title>Configuration Information</title>
169
170 <para>Some packages will require <command>ant</command> to be in the search
171 path and the <envar>$ANT_HOME</envar> environment variable defined.
172 Satisfy these requirements by adding the following lines to
173 <filename>/etc/profile</filename> or to individual user's
174 <filename>~/.profile</filename> or <filename>~/.bashrc</filename> files:</para>
175
176<screen><literal>export PATH=$PATH:/opt/ant/bin
177export ANT_HOME=/opt/ant</literal></screen>
178
179 </sect3>
180
181 </sect2>
182
183 <sect2 role="content">
184 <title>Contents</title>
185
186 <segmentedlist>
187 <segtitle>Installed Programs</segtitle>
188 <segtitle>Installed Libraries</segtitle>
189 <segtitle>Installed Directories</segtitle>
190
191 <seglistitem>
192 <seg>ant, antRun, antRun.pl, complete-ant-cmd.pl, runant.pl, and runant.py</seg>
193 <seg>ant.jar, ant-*.jar, xercesImpl.jar, and xml-apis.jar</seg>
194 <seg>/etc/ant and /opt/ant-&apache-ant-version;</seg>
195 </seglistitem>
196 </segmentedlist>
197
198 <variablelist>
199 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
200 <?dbfo list-presentation="list"?>
201 <?dbhtml list-presentation="table"?>
202
203 <varlistentry id="ant">
204 <term><command>ant</command></term>
205 <listitem>
206 <para>is a <application>Java</application> based build tool used by
207 many packages instead of the conventional <command>make</command>
208 program.</para>
209 <indexterm zone="apache-ant ant">
210 <primary sortas="b-ant">ant</primary>
211 </indexterm>
212 </listitem>
213 </varlistentry>
214
215 <varlistentry id="antRun">
216 <term><command>antRun</command></term>
217 <listitem>
218 <para>is a support script used to start <command>ant</command>
219 build scripts in a given directory.</para>
220 <indexterm zone="apache-ant antRun">
221 <primary sortas="b-antRun">antRun</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry id="antRun.pl">
227 <term><command>antRun.pl</command></term>
228 <listitem>
229 <para>is a <application>Perl</application> script that provides
230 similar functionality offered by the <command>antRun</command> script.</para>
231 <indexterm zone="apache-ant antRun.pl">
232 <primary sortas="b-antRun.pl">antRun.pl</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry id="complete-ant-cmd.pl">
238 <term><command>complete-ant-cmd.pl</command></term>
239 <listitem>
240 <para>is a <application>Perl</application> script that allows
241 <application>Bash</application> to complete an <command>ant</command>
242 command-line.</para>
243 <indexterm zone="apache-ant complete-ant-cmd.pl">
244 <primary sortas="b-complete-ant-cmd.pl">complete-ant-cmd.pl</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="runant.pl">
250 <term><command>runant.pl</command></term>
251 <listitem>
252 <para>is a <application>Perl</application> wrapper script used to
253 invoke <command>ant</command>.</para>
254 <indexterm zone="apache-ant runant.pl">
255 <primary sortas="b-runant.pl">runant.pl</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="runant.py">
261 <term><command>runant.py</command></term>
262 <listitem>
263 <para>is a <application>Python</application> wrapper script used to
264 invoke <command>ant</command>.</para>
265 <indexterm zone="apache-ant runant.py">
266 <primary sortas="b-runant.py">runant.py</primary>
267 </indexterm>
268 </listitem>
269 </varlistentry>
270
271 <varlistentry id="ant-star">
272 <term><filename class='libraryfile'>ant-*.jar</filename></term>
273 <listitem>
274 <para>files are the <application>Apache Ant</application>
275 <application>Java</application> class libraries.</para>
276 <indexterm zone="apache-ant ant-star">
277 <primary sortas="c-ant-star">ant-*.jar</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="xercesImpl">
283 <term><filename class='libraryfile'>xercesImpl.jar</filename></term>
284 <listitem>
285 <para>is a <application>Java</application> class library used by
286 <application>Apache Ant</application> to perform XML parsing.</para>
287 <indexterm zone="apache-ant xercesImpl">
288 <primary sortas="c-xercesImpl">xercesImpl.jar</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="xml-apis">
294 <term><filename class='libraryfile'>xml-apis.jar</filename></term>
295 <listitem>
296 <para>contains the DOM <application>Java</application> classes required
297 by the <application>Apache Ant</application> XML formatter.</para>
298 <indexterm zone="apache-ant xml-apis">
299 <primary sortas="c-xml-apis">xml-apis.jar</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 </variablelist>
305
306 </sect2>
307
308</sect1>
Note: See TracBrowser for help on using the repository browser.