automake.xml 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. %general-entities;
  5. ]>
  6. <sect1 id="ch-system-automake" role="wrap">
  7. <title>Automake-&automake-version;</title>
  8. <?dbhtml filename="automake.html"?>
  9. <indexterm zone="ch-system-automake"><primary sortas="a-Automake">Automake</primary></indexterm>
  10. <sect2 role="package"><title/>
  11. <para>The Automake package contains programs for generating Makefiles for use
  12. with Autoconf.</para>
  13. <segmentedlist>
  14. <segtitle>&buildtime;</segtitle>
  15. <segtitle>&diskspace;</segtitle>
  16. <seglistitem><seg>0.2 SBU</seg><seg>6.8 MB</seg></seglistitem>
  17. </segmentedlist>
  18. <segmentedlist>
  19. <segtitle>Automake installation depends on</segtitle>
  20. <seglistitem><seg>Autoconf, Bash, Coreutils,
  21. Diffutils, Grep, M4, Make, Perl, and Sed</seg></seglistitem>
  22. </segmentedlist>
  23. </sect2>
  24. <sect2 role="installation">
  25. <title>Installation of Automake</title>
  26. <para>Prepare Automake for compilation:</para>
  27. <screen><userinput>./configure --prefix=/usr</userinput></screen>
  28. <para>Compile the package:</para>
  29. <screen><userinput>make</userinput></screen>
  30. <para>To test the results, issue:
  31. <userinput>make check</userinput>. This takes a long time, about 5 SBUs.</para>
  32. <para>Install the package:</para>
  33. <screen><userinput>make install</userinput></screen>
  34. </sect2>
  35. <sect2 id="contents-automake" role="content"><title>Contents of Automake</title>
  36. <segmentedlist>
  37. <segtitle>Installed programs</segtitle>
  38. <seglistitem><seg>acinstall, aclocal, aclocal-&automake-version;,
  39. automake, automake-&automake-version;,
  40. compile, config.guess, config.sub, depcomp, elisp-comp, install-sh, mdate-sh,
  41. missing, mkinstalldirs, py-compile, symlink-tree, and ylwrap</seg></seglistitem>
  42. </segmentedlist>
  43. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  44. <?dbfo list-presentation="list"?>
  45. <?dbhtml list-presentation="table"?>
  46. <varlistentry id="acinstall">
  47. <term><command>acinstall</command></term>
  48. <listitem>
  49. <para>A script that installs aclocal-style M4 files</para>
  50. <indexterm zone="ch-system-automake acinstall"><primary sortas="b-acinstall">acinstall</primary></indexterm>
  51. </listitem>
  52. </varlistentry>
  53. <varlistentry id="aclocal">
  54. <term><command>aclocal</command></term>
  55. <listitem>
  56. <para>Generates <filename>aclocal.m4</filename>
  57. files based on the contents of <filename>configure.in</filename> files</para>
  58. <indexterm zone="ch-system-automake aclocal"><primary sortas="b-aclocal">aclocal</primary></indexterm>
  59. </listitem>
  60. </varlistentry>
  61. <varlistentry id="aclocal-version">
  62. <term><command>aclocal-&automake-version;</command></term>
  63. <listitem>
  64. <para>A hard link to <command>aclocal</command></para>
  65. <indexterm zone="ch-system-automake aclocal-version"><primary
  66. sortas="b-aclocal-&automake-version;">aclocal-&automake-version;</primary></indexterm>
  67. </listitem>
  68. </varlistentry>
  69. <varlistentry id="automake">
  70. <term><command>automake</command></term>
  71. <listitem>
  72. <para>A tool for automatically generating
  73. <filename>Makefile.in</filename> files from
  74. <filename>Makefile.am</filename> files. To create all the
  75. <filename>Makefile.in</filename> files for a package, run this program
  76. in the top-level directory. By scanning the
  77. <filename>configure.in</filename> file, it automatically finds each
  78. appropriate <filename>Makefile.am</filename> file and generate the
  79. corresponding <filename>Makefile.in</filename> file</para>
  80. <indexterm zone="ch-system-automake automake"><primary sortas="b-automake">automake</primary></indexterm>
  81. </listitem>
  82. </varlistentry>
  83. <varlistentry id="automake-version">
  84. <term><command>automake-&automake-version;</command></term>
  85. <listitem>
  86. <para>A hard link to <command>automake</command></para>
  87. <indexterm zone="ch-system-automake automake-version"><primary
  88. sortas="b-automake-&automake-version;">automake-&automake-version;</primary></indexterm>
  89. </listitem>
  90. </varlistentry>
  91. <varlistentry id="compile">
  92. <term><command>compile</command></term>
  93. <listitem>
  94. <para>A wrapper for compilers</para>
  95. <indexterm zone="ch-system-automake compile"><primary sortas="b-compile">compile</primary></indexterm>
  96. </listitem>
  97. </varlistentry>
  98. <varlistentry id="config.guess">
  99. <term><command>config.guess</command></term>
  100. <listitem>
  101. <para>A script that attempts to guess
  102. the canonical triplet for the given build, host, or target architecture</para>
  103. <indexterm zone="ch-system-automake config.guess"><primary sortas="b-config.guess">config.guess</primary></indexterm>
  104. </listitem>
  105. </varlistentry>
  106. <varlistentry id="config.sub">
  107. <term><command>config.sub</command></term>
  108. <listitem>
  109. <para>A configuration validation subroutine script</para>
  110. <indexterm zone="ch-system-automake config.sub"><primary sortas="b-config.sub">config.sub</primary></indexterm>
  111. </listitem>
  112. </varlistentry>
  113. <varlistentry id="depcomp">
  114. <term><command>depcomp</command></term>
  115. <listitem>
  116. <para>A script for compiling a program so that dependency information
  117. is generated in addition to the desired output</para>
  118. <indexterm zone="ch-system-automake depcomp"><primary sortas="b-depcomp">depcomp</primary></indexterm>
  119. </listitem>
  120. </varlistentry>
  121. <varlistentry id="elisp-comp">
  122. <term><command>elisp-comp</command></term>
  123. <listitem>
  124. <para>Byte-compiles Emacs Lisp code</para>
  125. <indexterm zone="ch-system-automake elisp-comp"><primary sortas="b-elisp-comp">elisp-comp</primary></indexterm>
  126. </listitem>
  127. </varlistentry>
  128. <varlistentry id="install-sh">
  129. <term><command>install-sh</command></term>
  130. <listitem>
  131. <para>A script that installs a program, script, or data file</para>
  132. <indexterm zone="ch-system-automake install-sh"><primary sortas="b-install-sh">install-sh</primary></indexterm>
  133. </listitem>
  134. </varlistentry>
  135. <varlistentry id="mdate-sh">
  136. <term><command>mdate-sh</command></term>
  137. <listitem>
  138. <para>A script that prints the modification time of a file or directory</para>
  139. <indexterm zone="ch-system-automake mdate-sh"><primary sortas="b-mdate-sh">mdate-sh</primary></indexterm>
  140. </listitem>
  141. </varlistentry>
  142. <varlistentry id="missing">
  143. <term><command>missing</command></term>
  144. <listitem>
  145. <para>A script acting as a common stub for missing GNU programs during
  146. an installation</para>
  147. <indexterm zone="ch-system-automake missing"><primary sortas="b-missing">missing</primary></indexterm>
  148. </listitem>
  149. </varlistentry>
  150. <varlistentry id="mkinstalldirs">
  151. <term><command>mkinstalldirs</command></term>
  152. <listitem>
  153. <para>A script that creates a directory tree</para>
  154. <indexterm zone="ch-system-automake mkinstalldirs"><primary sortas="b-mkinstalldirs">mkinstalldirs</primary></indexterm>
  155. </listitem>
  156. </varlistentry>
  157. <varlistentry id="py-compile">
  158. <term><command>py-compile</command></term>
  159. <listitem>
  160. <para>Compiles a Python program</para>
  161. <indexterm zone="ch-system-automake py-compile"><primary sortas="b-py-compile">py-compile</primary></indexterm>
  162. </listitem>
  163. </varlistentry>
  164. <varlistentry id="symlink-tree">
  165. <term><command>symlink-tree</command></term>
  166. <listitem>
  167. <para>A script to create a symlink tree of a directory tree</para>
  168. <indexterm zone="ch-system-automake symlink-tree"><primary sortas="b-symlink-tree">symlink-tree</primary></indexterm>
  169. </listitem>
  170. </varlistentry>
  171. <varlistentry id="ylwrap">
  172. <term><command>ylwrap</command></term>
  173. <listitem>
  174. <para>A wrapper for <command>lex</command> and <command>yacc</command></para>
  175. <indexterm zone="ch-system-automake ylwrap"><primary sortas="b-ylwrap">ylwrap</primary></indexterm>
  176. </listitem>
  177. </varlistentry>
  178. </variablelist>
  179. </sect2>
  180. </sect1>