chapter06/autoconf.xml

   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
   8 <sect1 id="ch-system-autoconf" role="wrap">
   9   <?dbhtml filename="autoconf.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>autoconf</productname>
  13     <productnumber>&autoconf-version;</productnumber>
  14     <address>&autoconf-url;</address>
  15   </sect1info>
  16
  17   <title>Autoconf-&autoconf-version;</title>
  18
  19   <indexterm zone="ch-system-autoconf">
  20     <primary sortas="a-Autoconf">Autoconf</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Autoconf package contains programs for producing shell scripts that
  27     can automatically configure source code.</para>
  28
  29     <segmentedlist>
  30       <segtitle>&buildtime;</segtitle>
  31       <segtitle>&diskspace;</segtitle>
  32
  33       <seglistitem>
  34         <seg>&autoconf-ch6-sbu;</seg>
  35         <seg>&autoconf-ch6-du;</seg>
  36       </seglistitem>
  37     </segmentedlist>
  38
  39   </sect2>
  40
  41   <sect2 role="installation">
  42     <title>Installation of Autoconf</title>
  43
  44     <para>Prepare Autoconf for compilation:</para>
  45
  46 <screen><userinput remap="configure">./configure --prefix=/usr</userinput></screen>
  47
  48     <para>Compile the package:</para>
  49
  50 <screen><userinput remap="make">make</userinput></screen>
  51
  52     <para>To test the results, issue:</para>
  53
  54 <screen><userinput remap="test">make check</userinput></screen>
  55
  56     <para>This takes a long time, about 4.7 SBUs. In addition, 6 tests are skipped
  57     that use Automake. For full test coverage, Autoconf can be re-tested
  58     after Automake has been installed.</para>
  59
  60     <para>Install the package:</para>
  61
  62 <screen><userinput remap="install">make install</userinput></screen>
  63
  64   </sect2>
  65
  66   <sect2 id="contents-autoconf" role="content">
  67     <title>Contents of Autoconf</title>
  68
  69     <segmentedlist>
  70       <segtitle>Installed programs</segtitle>
  71       <segtitle>Installed directory</segtitle>
  72
  73       <seglistitem>
  74         <seg>autoconf, autoheader, autom4te, autoreconf, autoscan, autoupdate,
  75         and ifnames</seg>
  76         <seg>/usr/share/autoconf</seg>
  77       </seglistitem>
  78     </segmentedlist>
  79
  80     <variablelist>
  81       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  82       <?dbfo list-presentation="list"?>
  83       <?dbhtml list-presentation="table"?>
  84
  85       <varlistentry id="autoconf">
  86         <term><command>autoconf</command></term>
  87         <listitem>
  88           <para>Produces shell scripts that automatically configure software
  89           source code packages to adapt to many kinds of Unix-like systems.
  90           The configuration scripts it produces are independent&mdash;running
  91           them does not require the <command>autoconf</command> program.</para>
  92           <indexterm zone="ch-system-autoconf autoconf">
  93             <primary sortas="b-autoconf">autoconf</primary>
  94           </indexterm>
  95         </listitem>
  96       </varlistentry>
  97
  98       <varlistentry id="autoheader">
  99         <term><command>autoheader</command> </term>
 100         <listitem>
 101           <para>A tool for creating template files of C
 102           <emphasis>#define</emphasis> statements for configure to use</para>
 103           <indexterm zone="ch-system-autoconf autoheader">
 104             <primary sortas="b-autoheader">autoheader</primary>
 105           </indexterm>
 106         </listitem>
 107       </varlistentry>
 108
 109       <varlistentry id="autom4te">
 110         <term><command>autom4te</command></term>
 111         <listitem>
 112           <para>A wrapper for the M4 macro processor</para>
 113           <indexterm zone="ch-system-autoconf autom4te">
 114             <primary sortas="b-autom4te">autom4te</primary>
 115           </indexterm>
 116         </listitem>
 117       </varlistentry>
 118
 119       <varlistentry id="autoreconf">
 120         <term><command>autoreconf</command></term>
 121         <listitem>
 122           <para>Automatically runs <command>autoconf</command>,
 123           <command>autoheader</command>, <command>aclocal</command>,
 124           <command>automake</command>, <command>gettextize</command>, and
 125           <command>libtoolize</command> in the correct order to save time
 126           when changes are made to <command>autoconf</command> and
 127           <command>automake</command> template files</para>
 128           <indexterm zone="ch-system-autoconf autoreconf">
 129             <primary sortas="b-autoreconf">autoreconf</primary>
 130           </indexterm>
 131         </listitem>
 132       </varlistentry>
 133
 134       <varlistentry id="autoscan">
 135         <term><command>autoscan</command> </term>
 136         <listitem>
 137           <para>Helps to create a <filename>configure.in</filename> file for a
 138           software package; it examines the source files in a directory tree,
 139           searching them for common portability issues, and creates a
 140           <filename>configure.scan</filename> file that serves as as a
 141           preliminary <filename>configure.in</filename> file for the
 142           package</para>
 143           <indexterm zone="ch-system-autoconf autoscan">
 144             <primary sortas="b-autoscan">autoscan</primary>
 145           </indexterm>
 146         </listitem>
 147       </varlistentry>
 148
 149       <varlistentry id="autoupdate">
 150         <term><command>autoupdate</command></term>
 151         <listitem>
 152           <para>Modifies a <filename>configure.in</filename> file that still
 153           calls <command>autoconf</command> macros by their old names to use the
 154           current macro names</para>
 155           <indexterm zone="ch-system-autoconf autoupdate">
 156             <primary sortas="b-autoupdate">autoupdate</primary>
 157           </indexterm>
 158         </listitem>
 159       </varlistentry>
 160
 161       <varlistentry id="ifnames">
 162         <term><command>ifnames</command> </term>
 163         <listitem>
 164           <para>Helps when writing <filename>configure.in</filename> files
 165           for a software package; it prints the identifiers that the package
 166           uses in C preprocessor conditionals. If a package has already been set
 167           up to have some portability, this program can help determine what
 168           <command>configure</command> needs to check for. It can also fill in
 169           gaps in a <filename>configure.in</filename> file generated by
 170           <command>autoscan</command></para>
 171           <indexterm zone="ch-system-autoconf ifnames">
 172             <primary sortas="b-ifnames">ifnames</primary>
 173           </indexterm>
 174         </listitem>
 175       </varlistentry>
 176
 177     </variablelist>
 178
 179   </sect2>
 180
 181 </sect1>