automake.xml 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  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>Fix a bug in the testsuite that can cause one of the tests to fail
  34. intermittently:</para>
  35. <screen><userinput remap="pre">sed -i -e '48i$sleep' t/aclocal7.sh</userinput></screen>
  36. <para>Prepare Automake for compilation:</para>
  37. <screen><userinput remap="configure">./configure --prefix=/usr --docdir=/usr/share/doc/automake-&automake-version;</userinput></screen>
  38. <para>Compile the package:</para>
  39. <screen><userinput remap="make">make</userinput></screen>
  40. <note><para>The tests take a very long time: over 30 SBUs. Running
  41. the tests is not recommended.</para></note>
  42. <para>To test the results, issue:</para>
  43. <screen><userinput remap="test">make check</userinput></screen>
  44. <para>Install the package:</para>
  45. <screen><userinput remap="install">make install</userinput></screen>
  46. </sect2>
  47. <sect2 id="contents-automake" role="content">
  48. <title>Contents of Automake</title>
  49. <segmentedlist>
  50. <segtitle>Installed programs</segtitle>
  51. <segtitle>Installed directories</segtitle>
  52. <seglistitem>
  53. <seg>acinstall, aclocal, aclocal-&am-minor-version;, automake,
  54. automake-&am-minor-version;, compile, config.guess, config.sub,
  55. depcomp, elisp-comp, install-sh, mdate-sh, missing, mkinstalldirs,
  56. py-compile, symlink-tree, and ylwrap</seg>
  57. <seg>/usr/share/aclocal-&am-minor-version;, /usr/share/automake-&am-minor-version;,
  58. /usr/share/doc/automake-&automake-version;</seg>
  59. </seglistitem>
  60. </segmentedlist>
  61. <variablelist>
  62. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  63. <?dbfo list-presentation="list"?>
  64. <?dbhtml list-presentation="table"?>
  65. <varlistentry id="acinstall">
  66. <term><command>acinstall</command></term>
  67. <listitem>
  68. <para>A script that installs aclocal-style M4 files</para>
  69. <indexterm zone="ch-system-automake acinstall">
  70. <primary sortas="b-acinstall">acinstall</primary>
  71. </indexterm>
  72. </listitem>
  73. </varlistentry>
  74. <varlistentry id="aclocal">
  75. <term><command>aclocal</command></term>
  76. <listitem>
  77. <para>Generates <filename>aclocal.m4</filename> files based on the
  78. contents of <filename>configure.in</filename> files</para>
  79. <indexterm zone="ch-system-automake aclocal">
  80. <primary sortas="b-aclocal">aclocal</primary>
  81. </indexterm>
  82. </listitem>
  83. </varlistentry>
  84. <varlistentry id="aclocalversion">
  85. <term><command>aclocal-&am-minor-version;</command></term>
  86. <listitem>
  87. <para>A hard link to <command>aclocal</command></para>
  88. <indexterm zone="ch-system-automake aclocalversion">
  89. <primary sortas="b-aclocal-&am-minor-version;">aclocal-&am-minor-version;</primary>
  90. </indexterm>
  91. </listitem>
  92. </varlistentry>
  93. <varlistentry id="automake">
  94. <term><command>automake</command></term>
  95. <listitem>
  96. <para>A tool for automatically generating
  97. <filename>Makefile.in</filename> files from
  98. <filename>Makefile.am</filename> files. To create all the
  99. <filename>Makefile.in</filename> files for a package, run this program
  100. in the top-level directory. By scanning the
  101. <filename>configure.in</filename> file, it automatically finds each
  102. appropriate <filename>Makefile.am</filename> file and generates the
  103. corresponding <filename>Makefile.in</filename> file</para>
  104. <indexterm zone="ch-system-automake automake">
  105. <primary sortas="b-automake">automake</primary>
  106. </indexterm>
  107. </listitem>
  108. </varlistentry>
  109. <varlistentry id="automake-version">
  110. <term><command>automake-&am-minor-version;</command></term>
  111. <listitem>
  112. <para>A hard link to <command>automake</command></para>
  113. <indexterm zone="ch-system-automake automake-version">
  114. <primary sortas="b-automake-&am-minor-version;">automake-&am-minor-version;</primary>
  115. </indexterm>
  116. </listitem>
  117. </varlistentry>
  118. <varlistentry id="compile">
  119. <term><command>compile</command></term>
  120. <listitem>
  121. <para>A wrapper for compilers</para>
  122. <indexterm zone="ch-system-automake compile">
  123. <primary sortas="b-compile">compile</primary>
  124. </indexterm>
  125. </listitem>
  126. </varlistentry>
  127. <varlistentry id="config.guess">
  128. <term><command>config.guess</command></term>
  129. <listitem>
  130. <para>A script that attempts to guess the canonical triplet for
  131. the given build, host, or target architecture</para>
  132. <indexterm zone="ch-system-automake config.guess">
  133. <primary sortas="b-config.guess">config.guess</primary>
  134. </indexterm>
  135. </listitem>
  136. </varlistentry>
  137. <varlistentry id="config.sub">
  138. <term><command>config.sub</command></term>
  139. <listitem>
  140. <para>A configuration validation subroutine script</para>
  141. <indexterm zone="ch-system-automake config.sub">
  142. <primary sortas="b-config.sub">config.sub</primary>
  143. </indexterm>
  144. </listitem>
  145. </varlistentry>
  146. <varlistentry id="depcomp">
  147. <term><command>depcomp</command></term>
  148. <listitem>
  149. <para>A script for compiling a program so that dependency information
  150. is generated in addition to the desired output</para>
  151. <indexterm zone="ch-system-automake depcomp">
  152. <primary sortas="b-depcomp">depcomp</primary>
  153. </indexterm>
  154. </listitem>
  155. </varlistentry>
  156. <varlistentry id="elisp-comp">
  157. <term><command>elisp-comp</command></term>
  158. <listitem>
  159. <para>Byte-compiles Emacs Lisp code</para>
  160. <indexterm zone="ch-system-automake elisp-comp">
  161. <primary sortas="b-elisp-comp">elisp-comp</primary>
  162. </indexterm>
  163. </listitem>
  164. </varlistentry>
  165. <varlistentry id="install-sh">
  166. <term><command>install-sh</command></term>
  167. <listitem>
  168. <para>A script that installs a program, script, or data file</para>
  169. <indexterm zone="ch-system-automake install-sh">
  170. <primary sortas="b-install-sh">install-sh</primary>
  171. </indexterm>
  172. </listitem>
  173. </varlistentry>
  174. <varlistentry id="mdate-sh">
  175. <term><command>mdate-sh</command></term>
  176. <listitem>
  177. <para>A script that prints the modification time of a file or
  178. directory</para>
  179. <indexterm zone="ch-system-automake mdate-sh">
  180. <primary sortas="b-mdate-sh">mdate-sh</primary>
  181. </indexterm>
  182. </listitem>
  183. </varlistentry>
  184. <varlistentry id="missing">
  185. <term><command>missing</command></term>
  186. <listitem>
  187. <para>A script acting as a common stub for missing GNU programs during
  188. an installation</para>
  189. <indexterm zone="ch-system-automake missing">
  190. <primary sortas="b-missing">missing</primary>
  191. </indexterm>
  192. </listitem>
  193. </varlistentry>
  194. <varlistentry id="mkinstalldirs">
  195. <term><command>mkinstalldirs</command></term>
  196. <listitem>
  197. <para>A script that creates a directory tree</para>
  198. <indexterm zone="ch-system-automake mkinstalldirs">
  199. <primary sortas="b-mkinstalldirs">mkinstalldirs</primary>
  200. </indexterm>
  201. </listitem>
  202. </varlistentry>
  203. <varlistentry id="py-compile">
  204. <term><command>py-compile</command></term>
  205. <listitem>
  206. <para>Compiles a Python program</para>
  207. <indexterm zone="ch-system-automake py-compile">
  208. <primary sortas="b-py-compile">py-compile</primary>
  209. </indexterm>
  210. </listitem>
  211. </varlistentry>
  212. <varlistentry id="symlink-tree">
  213. <term><command>symlink-tree</command></term>
  214. <listitem>
  215. <para>A script to create a symlink tree of a directory tree</para>
  216. <indexterm zone="ch-system-automake symlink-tree">
  217. <primary sortas="b-symlink-tree">symlink-tree</primary>
  218. </indexterm>
  219. </listitem>
  220. </varlistentry>
  221. <varlistentry id="ylwrap">
  222. <term><command>ylwrap</command></term>
  223. <listitem>
  224. <para>A wrapper for <command>lex</command> and
  225. <command>yacc</command></para>
  226. <indexterm zone="ch-system-automake ylwrap">
  227. <primary sortas="b-ylwrap">ylwrap</primary>
  228. </indexterm>
  229. </listitem>
  230. </varlistentry>
  231. </variablelist>
  232. </sect2>
  233. </sect1>