automake.xml 9.3 KB

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