automake.xml 9.4 KB

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