source: chapter06/automake.xml@ 1375d26

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE section [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>
<section xmlns="http://docbook.org/docbook-ng"
         xml:id="ch-system-automake" xreflabel="Automake" role="wrap">
<info><title>Automake-&automake-version;</title></info>
<?dbhtml filename="automake.html"?>

<indexterm zone="ch-system-automake"><primary sortas="a-Automake">Automake</primary></indexterm>

<section role="package"><info><title/></info>
<para>The Automake package contains programs for generating Makefiles for use
with Autoconf.</para>

<segmentedlist>
<segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.2 SBU</seg><seg>6.8 MB</seg></seglistitem>
</segmentedlist>

<segmentedlist>
<segtitle>Automake installation depends on</segtitle>
<seglistitem><seg>Autoconf, Bash, Coreutils,
Diffutils, Grep, M4, Make, Perl, Sed</seg></seglistitem>
</segmentedlist>
</section>

<section role="installation">
<info><title>Installation of Automake</title></info>

<para>Prepare Automake for compilation:</para>

<screen><userinput>./configure --prefix=/usr</userinput></screen>

<para>Compile the package:</para>

<screen><userinput>make</userinput></screen>

<para>To test the results, issue:
<userinput>make check</userinput>. This takes a long time, about 5 SBUs.</para>

<para>Install the package:</para>

<screen><userinput>make install</userinput></screen>

</section>


<section xml:id="contents-automake" role="content"><info><title>Contents of Automake</title></info>

<segmentedlist>
<segtitle>Installed programs</segtitle>
<seglistitem><seg>acinstall, aclocal, aclocal-1.8, automake, automake-1.8, 
compile, config.guess, config.sub, depcomp, elisp-comp, install-sh, mdate-sh, 
missing, mkinstalldirs, py-compile, symlink-tree, ylwrap</seg></seglistitem>
</segmentedlist>

<variablelist><title>Short descriptions</title>

<varlistentry xml:id="acinstall">
<term><command>acinstall</command></term>
<listitem>
<indexterm zone="ch-system-automake acinstall"><primary sortas="b-acinstall">acinstall</primary></indexterm>
<para>is a script that installs aclocal-style M4 files.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="aclocal">
<term><command>aclocal</command></term>
<listitem>
<indexterm zone="ch-system-automake aclocal"><primary sortas="b-aclocal">aclocal</primary></indexterm>
<para>generates <filename>aclocal.m4</filename>
files based on the contents of <filename>configure.in</filename> files.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="automake">
<term><command>automake</command></term>
<listitem>
<indexterm zone="ch-system-automake automake"><primary sortas="b-automake">automake</primary></indexterm>
<para>is a tool for automatically generating
<filename>Makefile.in</filename>'s from files called
<filename>Makefile.am</filename>. To create all the
<filename>Makefile.in</filename> files for a package, run this program in the
top-level directory. By scanning the <filename>configure.in</filename>s it
automatically finds each appropriate <filename>Makefile.am</filename> and
generate the corresponding <filename>Makefile.in</filename>.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="compile">
<term><command>compile</command></term>
<listitem>
<indexterm zone="ch-system-automake compile"><primary sortas="b-compile">compile</primary></indexterm>
<para>is a wrapper for compilers.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="config.guess">
<term><command>config.guess</command> </term>
<listitem>
<indexterm zone="ch-system-automake config.guess"><primary sortas="b-config.guess">config.guess</primary></indexterm>
<para>is a script that attempts to guess
the canonical triplet for the given build, host, or target architecture.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="config.su">
<term><command>config.sub</command></term>
<listitem>
<indexterm zone="ch-system-automake config.su"><primary sortas="b-config.su">config.su</primary></indexterm>
<para>is a configuration validation subroutine script.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="depcomp">
<term><command>depcomp</command></term>
<listitem>
<indexterm zone="ch-system-automake depcomp"><primary sortas="b-depcomp">depcomp</primary></indexterm>
<para>is a script for compiling a program so that not only the desired output is 
generated, but also dependency information.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="elisp-comp">
<term><command>elisp-comp</command></term>
<listitem>
<indexterm zone="ch-system-automake elisp-comp"><primary sortas="b-elisp-comp">elisp-comp</primary></indexterm>
<para>byte-compiles Emacs Lisp code.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="install-sh">
<term><command>install-sh</command></term>
<listitem>
<indexterm zone="ch-system-automake install-sh"><primary sortas="b-install-sh">install-sh</primary></indexterm>
<para>is a script that installs a program, a script, or a datafile.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="mdate-sh">
<term><command>mdate-sh</command></term>
<listitem>
<indexterm zone="ch-system-automake mdate-sh"><primary sortas="b-mdate-sh">mdate-sh</primary></indexterm>
<para>is a script that prints the modification time of a file or directory.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="missing">
<term><command>missing</command></term>
<listitem>
<indexterm zone="ch-system-automake missing"><primary sortas="b-missing">missing</primary></indexterm>
<para>is a script acting as a common stub for
missing GNU programs during an installation.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="mkinstalldirs">
<term><command>mkinstalldirs</command></term>
<listitem>
<indexterm zone="ch-system-automake mkinstalldirs"><primary sortas="b-mkinstalldirs">mkinstalldirs</primary></indexterm>
<para>is a script that creates a directory tree.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="py-compile">
<term><command>py-compile</command></term>
<listitem>
<indexterm zone="ch-system-automake py-compile"><primary sortas="b-py-compile">py-compile</primary></indexterm>
<para>compiles a Python program.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="symlink-tree">
<term><command>symlink-tree</command></term>
<listitem>
<indexterm zone="ch-system-automake symlink-tree"><primary sortas="b-symlink-tree">symlink-tree</primary></indexterm>
<para>is a script to create a symlink tree of a directory tree.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="ylwrap">
<term><command>ylwrap</command></term>
<listitem>
<indexterm zone="ch-system-automake ylwrap"><primary sortas="b-ylwrap">ylwrap</primary></indexterm>
<para>is a wrapper for <command>lex</command> and <command>yacc</command>.</para>
</listitem>
</varlistentry>
</variablelist>

</section>

</section>