* Fixed problem when BASEDIR paths were given without a trailing '/'.
[linux_from_scratch.git] / newxml / chapter06 / automake.xml
blobe2e4927192a74dcd40a31b9cac8accefa6244f2f
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
3   <!ENTITY % general-entities SYSTEM "../general.ent">
4   %general-entities;
5 ]>
6 <sect1 id="ch-system-automake" xreflabel="Automake">
7 <title>Automake-&automake-version;</title>
8 <?dbhtml filename="automake.html"?>
10 <indexterm zone="ch-system-automake"><primary sortas="a-Automake">Automake</primary></indexterm>
12 <para>The Automake package contains programs for generating Makefiles for use
13 with Autoconf.</para>
15 <screen>&buildtime; 0.2 SBU
16 &diskspace; 6.8 MB</screen>
18 <para>Automake installation depends on: Autoconf, Bash, Coreutils,
19 Diffutils, Grep, M4, Make, Perl, Sed.</para>
23 <sect2>
24 <title>Installation of Automake</title>
26 <para>Prepare Automake for compilation:</para>
28 <screen><userinput>./configure --prefix=/usr</userinput></screen>
30 <para>Compile the package:</para>
32 <screen><userinput>make</userinput></screen>
34 <para>To test the results, issue:
35 <userinput>make check</userinput>. This takes a long time, about 5 SBUs.</para>
37 <para>Install the package:</para>
39 <screen><userinput>make install</userinput></screen>
41 </sect2>
44 <sect2 id="contents-automake"><title>Contents of Automake</title>
46 <para><emphasis>Installed programs</emphasis>: acinstall, aclocal,
47 aclocal-1.8, automake, automake-1.8, compile, config.guess, config.sub,
48 depcomp, elisp-comp, install-sh, mdate-sh, missing, mkinstalldirs, py-compile,
49 symlink-tree, ylwrap</para>
51 </sect2>
53 <sect2><title>Short descriptions</title>
55 <indexterm zone="ch-system-automake acinstall"><primary sortas="b-acinstall">acinstall</primary></indexterm>
56 <para id="acinstall"><command>acinstall</command> is a script that installs
57 aclocal-style M4 files.</para>
59 <indexterm zone="ch-system-automake aclocal"><primary sortas="b-aclocal">aclocal</primary></indexterm>
60 <para id="aclocal"><command>aclocal</command> generates <filename>aclocal.m4</filename>
61 files based on the contents of <filename>configure.in</filename> files.</para>
63 <indexterm zone="ch-system-automake automake"><primary sortas="b-automake">automake</primary></indexterm>
64 <para id="automake"><command>automake</command> is a tool for automatically generating
65 <filename>Makefile.in</filename>'s from files called
66 <filename>Makefile.am</filename>. To create all the
67 <filename>Makefile.in</filename> files for a package, run this program in the
68 top-level directory. By scanning the <filename>configure.in</filename>s it
69 automatically finds each appropriate <filename>Makefile.am</filename> and
70 generate the corresponding <filename>Makefile.in</filename>.</para>
72 <indexterm zone="ch-system-automake compile"><primary sortas="b-compile">compile</primary></indexterm>
73 <para id="compile"><command>compile</command> is a wrapper for compilers.</para>
75 <indexterm zone="ch-system-automake config.guess"><primary sortas="b-config.guess">config.guess</primary></indexterm>
76 <para id="config.guess"><command>config.guess</command> is a script that attempts to guess
77 the canonical triplet for the given build, host, or target architecture.</para>
79 <indexterm zone="ch-system-automake config.su"><primary sortas="b-config.su">config.su</primary></indexterm>
80 <para id="config.su"><command>config.sub</command> is a configuration validation
81 subroutine script.</para>
83 <indexterm zone="ch-system-automake depcomp"><primary sortas="b-depcomp">depcomp</primary></indexterm>
84 <para id="depcomp"><command>depcomp</command> is a script for compiling a program
85 so that not only the desired output is generated, but also dependency
86 information.</para>
88 <indexterm zone="ch-system-automake elisp-comp"><primary sortas="b-elisp-comp">elisp-comp</primary></indexterm>
89 <para id="elisp-comp"><command>elisp-comp</command> byte-compiles Emacs Lisp code.</para>
91 <indexterm zone="ch-system-automake install-sh"><primary sortas="b-install-sh">install-sh</primary></indexterm>
92 <para id="install-sh"><command>install-sh</command> is a script that installs a program,
93 a script, or a datafile.</para>
95 <indexterm zone="ch-system-automake mdate-sh"><primary sortas="b-mdate-sh">mdate-sh</primary></indexterm>
96 <para id="mdate-sh"><command>mdate-sh</command> is a script that prints the modification
97 time of a file or directory.</para>
99 <indexterm zone="ch-system-automake missing"><primary sortas="b-missing">missing</primary></indexterm>
100 <para id="missing"><command>missing</command> is a script acting as a common stub for
101 missing GNU programs during an installation.</para>
103 <indexterm zone="ch-system-automake mkinstalldirs"><primary sortas="b-mkinstalldirs">mkinstalldirs</primary></indexterm>
104 <para id="mkinstalldirs"><command>mkinstalldirs</command> is a script that creates a directory
105 tree.</para>
107 <indexterm zone="ch-system-automake py-compile"><primary sortas="b-py-compile">py-compile</primary></indexterm>
108 <para id="py-compile"><command>py-compile</command> compiles a Python program.</para>
110 <indexterm zone="ch-system-automake symlink-tree"><primary sortas="b-symlink-tree">symlink-tree</primary></indexterm>
111 <para id="symlink-tree"><command>symlink-tree</command> is a script to create a symlink tree of
112 a directory tree.</para>
114 <indexterm zone="ch-system-automake ylwrap"><primary sortas="b-ylwrap">ylwrap</primary></indexterm>
115 <para id="ylwrap"><command>ylwrap</command> is a wrapper for lex and yacc.</para>
117 </sect2>
121 </sect1>