automake.xml 9.6 KB

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