source: final-system/common/automake.xml@ 97074be

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  <!ENTITY % patches-entities SYSTEM "../../patches.ent">
  %general-entities;
  %patches-entities;
]>

<sect1 id="ch-system-automake" role="wrap">
  <?dbhtml filename="automake.html"?>

  <title>Automake-&automake-version;</title>

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

  <sect2 role="package">
    <title/>

    <para>The Automake package contains programs for generating Makefiles
    for use with Autoconf.</para>

    <segmentedlist>
      <segtitle>&dependencies;</segtitle>

      <seglistitem>
        <seg>Autoconf, Bash, Coreutils, Diffutils, Grep, M4, Make, Perl,
        and Sed</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Automake</title>

    <para os="a">Prepare Automake for compilation:</para>

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

    <para os="b">Compile the package:</para>

<screen os="c"><userinput>make</userinput></screen>

    <para os="d">To test the results, issue:
    <userinput>make check</userinput>.</para>

    <para os="e">Install the package:</para>

<screen os="f"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 id="contents-automake" role="content">
    <title>Contents of Automake</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>

      <seglistitem>
        <seg>acinstall, aclocal, aclocal-&automake-version;, automake,
        automake-&automake-version;, compile, config.guess, config.sub,
        depcomp, elisp-comp, install-sh, mdate-sh, missing, mkinstalldirs,
        py-compile, symlink-tree, and ylwrap</seg>
      </seglistitem>
    </segmentedlist>

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

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

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

      <varlistentry id="aclocal-version">
        <term><command>aclocal-&automake-version;</command></term>
        <listitem>
          <para>A hard link to <command>aclocal</command></para>
          <indexterm zone="ch-system-automake aclocal-version">
            <primary
            sortas="b-aclocal-&automake-version;">aclocal-&automake-version;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="automake">
        <term><command>automake</command></term>
        <listitem>
          <para>A tool for automatically generating
          <filename>Makefile.in</filename> files from
          <filename>Makefile.am</filename> files. 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> file, it automatically finds
          each appropriate <filename>Makefile.am</filename> file and generates
          the corresponding <filename>Makefile.in</filename> file</para>
          <indexterm zone="ch-system-automake automake">
            <primary sortas="b-automake">automake</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="automake-version">
        <term><command>automake-&automake-version;</command></term>
        <listitem>
          <para>A hard link to <command>automake</command></para>
          <indexterm zone="ch-system-automake automake-version">
            <primary
            sortas="b-automake-&automake-version;">automake-&automake-version;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

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

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

      <varlistentry id="depcomp">
        <term><command>depcomp</command></term>
        <listitem>
          <para>A script for compiling a program so that dependency information
          is generated in addition to the desired output</para>
          <indexterm zone="ch-system-automake depcomp">
            <primary sortas="b-depcomp">depcomp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="install-sh">
        <term><command>install-sh</command></term>
        <listitem>
          <para>A script that installs a program, script, or data file</para>
          <indexterm zone="ch-system-automake install-sh">
            <primary sortas="b-install-sh">install-sh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

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

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

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

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

      <varlistentry id="ylwrap">
        <term><command>ylwrap</command></term>
        <listitem>
          <para>A wrapper for <command>lex</command> and
          <command>yacc</command></para>
          <indexterm zone="ch-system-automake ylwrap">
            <primary sortas="b-ylwrap">ylwrap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>