autoconf.xml 7.1 KB

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