automake.xml 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  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-automake" role="wrap">
  8. <?dbhtml filename="automake.html"?>
  9. <sect1info condition="script">
  10. <productname>automake</productname>
  11. <productnumber>&automake-version;</productnumber>
  12. <address>&automake-url;</address>
  13. </sect1info>
  14. <title>Automake-&automake-version;</title>
  15. <indexterm zone="ch-system-automake">
  16. <primary sortas="a-Automake">Automake</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Automake package contains programs for generating Makefiles for use
  21. with Autoconf.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&automake-ch6-sbu;</seg>
  27. <seg>&automake-ch6-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of Automake</title>
  33. <para>Prepare Automake for compilation:</para>
  34. <screen><userinput remap="configure">./configure --prefix=/usr --docdir=/usr/share/doc/automake-&automake-version;</userinput></screen>
  35. <para>Compile the package:</para>
  36. <screen><userinput remap="make">make</userinput></screen>
  37. <para>There are a couple of tests that incorrectly link to the
  38. wrong version of the flex library, so we temporarily work around
  39. the problem. Also, using the -j4 make option speeds up the tests, even on
  40. systems with only one processor due to internal delays in individual
  41. tests. To test the results, issue:</para>
  42. <screen><userinput remap="test">mv -v /usr/lib/libfl.{so,save}
  43. ln -sv libfl.a /usr/lib/libfl.so
  44. make -j4 check
  45. rm -v /usr/lib/libfl.so
  46. mv -v /usr/lib/libfl.{save,so}</userinput></screen>
  47. <para>Install the package:</para>
  48. <screen><userinput remap="install">make install</userinput></screen>
  49. </sect2>
  50. <sect2 id="contents-automake" role="content">
  51. <title>Contents of Automake</title>
  52. <segmentedlist>
  53. <segtitle>Installed programs</segtitle>
  54. <segtitle>Installed directories</segtitle>
  55. <seglistitem>
  56. <seg>acinstall, aclocal, aclocal-&am-minor-version;, automake,
  57. automake-&am-minor-version;, compile, config.guess, config.sub,
  58. depcomp, install-sh, mdate-sh, missing, mkinstalldirs,
  59. py-compile, and ylwrap</seg>
  60. <seg>/usr/share/aclocal-&am-minor-version;, /usr/share/automake-&am-minor-version;,
  61. /usr/share/doc/automake-&automake-version;</seg>
  62. </seglistitem>
  63. </segmentedlist>
  64. <variablelist>
  65. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  66. <?dbfo list-presentation="list"?>
  67. <?dbhtml list-presentation="table"?>
  68. <varlistentry id="acinstall">
  69. <term><command>acinstall</command></term>
  70. <listitem>
  71. <para>A script that installs aclocal-style M4 files</para>
  72. <indexterm zone="ch-system-automake acinstall">
  73. <primary sortas="b-acinstall">acinstall</primary>
  74. </indexterm>
  75. </listitem>
  76. </varlistentry>
  77. <varlistentry id="aclocal">
  78. <term><command>aclocal</command></term>
  79. <listitem>
  80. <para>Generates <filename>aclocal.m4</filename> files based on the
  81. contents of <filename>configure.in</filename> files</para>
  82. <indexterm zone="ch-system-automake aclocal">
  83. <primary sortas="b-aclocal">aclocal</primary>
  84. </indexterm>
  85. </listitem>
  86. </varlistentry>
  87. <varlistentry id="aclocalversion">
  88. <term><command>aclocal-&am-minor-version;</command></term>
  89. <listitem>
  90. <para>A hard link to <command>aclocal</command></para>
  91. <indexterm zone="ch-system-automake aclocalversion">
  92. <primary sortas="b-aclocal-&am-minor-version;">aclocal-&am-minor-version;</primary>
  93. </indexterm>
  94. </listitem>
  95. </varlistentry>
  96. <varlistentry id="automake">
  97. <term><command>automake</command></term>
  98. <listitem>
  99. <para>A tool for automatically generating
  100. <filename>Makefile.in</filename> files from
  101. <filename>Makefile.am</filename> files. To create all the
  102. <filename>Makefile.in</filename> files for a package, run this program
  103. in the top-level directory. By scanning the
  104. <filename>configure.in</filename> file, it automatically finds each
  105. appropriate <filename>Makefile.am</filename> file and generates the
  106. corresponding <filename>Makefile.in</filename> file</para>
  107. <indexterm zone="ch-system-automake automake">
  108. <primary sortas="b-automake">automake</primary>
  109. </indexterm>
  110. </listitem>
  111. </varlistentry>
  112. <varlistentry id="automake-version">
  113. <term><command>automake-&am-minor-version;</command></term>
  114. <listitem>
  115. <para>A hard link to <command>automake</command></para>
  116. <indexterm zone="ch-system-automake automake-version">
  117. <primary sortas="b-automake-&am-minor-version;">automake-&am-minor-version;</primary>
  118. </indexterm>
  119. </listitem>
  120. </varlistentry>
  121. <varlistentry id="compile">
  122. <term><command>compile</command></term>
  123. <listitem>
  124. <para>A wrapper for compilers</para>
  125. <indexterm zone="ch-system-automake compile">
  126. <primary sortas="b-compile">compile</primary>
  127. </indexterm>
  128. </listitem>
  129. </varlistentry>
  130. <varlistentry id="config.guess">
  131. <term><command>config.guess</command></term>
  132. <listitem>
  133. <para>A script that attempts to guess the canonical triplet for
  134. the given build, host, or target architecture</para>
  135. <indexterm zone="ch-system-automake config.guess">
  136. <primary sortas="b-config.guess">config.guess</primary>
  137. </indexterm>
  138. </listitem>
  139. </varlistentry>
  140. <varlistentry id="config.sub">
  141. <term><command>config.sub</command></term>
  142. <listitem>
  143. <para>A configuration validation subroutine script</para>
  144. <indexterm zone="ch-system-automake config.sub">
  145. <primary sortas="b-config.sub">config.sub</primary>
  146. </indexterm>
  147. </listitem>
  148. </varlistentry>
  149. <varlistentry id="depcomp">
  150. <term><command>depcomp</command></term>
  151. <listitem>
  152. <para>A script for compiling a program so that dependency information
  153. is generated in addition to the desired output</para>
  154. <indexterm zone="ch-system-automake depcomp">
  155. <primary sortas="b-depcomp">depcomp</primary>
  156. </indexterm>
  157. </listitem>
  158. </varlistentry>
  159. <varlistentry id="install-sh">
  160. <term><command>install-sh</command></term>
  161. <listitem>
  162. <para>A script that installs a program, script, or data file</para>
  163. <indexterm zone="ch-system-automake install-sh">
  164. <primary sortas="b-install-sh">install-sh</primary>
  165. </indexterm>
  166. </listitem>
  167. </varlistentry>
  168. <varlistentry id="mdate-sh">
  169. <term><command>mdate-sh</command></term>
  170. <listitem>
  171. <para>A script that prints the modification time of a file or
  172. directory</para>
  173. <indexterm zone="ch-system-automake mdate-sh">
  174. <primary sortas="b-mdate-sh">mdate-sh</primary>
  175. </indexterm>
  176. </listitem>
  177. </varlistentry>
  178. <varlistentry id="missing">
  179. <term><command>missing</command></term>
  180. <listitem>
  181. <para>A script acting as a common stub for missing GNU programs during
  182. an installation</para>
  183. <indexterm zone="ch-system-automake missing">
  184. <primary sortas="b-missing">missing</primary>
  185. </indexterm>
  186. </listitem>
  187. </varlistentry>
  188. <varlistentry id="mkinstalldirs">
  189. <term><command>mkinstalldirs</command></term>
  190. <listitem>
  191. <para>A script that creates a directory tree</para>
  192. <indexterm zone="ch-system-automake mkinstalldirs">
  193. <primary sortas="b-mkinstalldirs">mkinstalldirs</primary>
  194. </indexterm>
  195. </listitem>
  196. </varlistentry>
  197. <varlistentry id="py-compile">
  198. <term><command>py-compile</command></term>
  199. <listitem>
  200. <para>Compiles a Python program</para>
  201. <indexterm zone="ch-system-automake py-compile">
  202. <primary sortas="b-py-compile">py-compile</primary>
  203. </indexterm>
  204. </listitem>
  205. </varlistentry>
  206. <varlistentry id="ylwrap">
  207. <term><command>ylwrap</command></term>
  208. <listitem>
  209. <para>A wrapper for <command>lex</command> and
  210. <command>yacc</command></para>
  211. <indexterm zone="ch-system-automake ylwrap">
  212. <primary sortas="b-ylwrap">ylwrap</primary>
  213. </indexterm>
  214. </listitem>
  215. </varlistentry>
  216. </variablelist>
  217. </sect2>
  218. </sect1>