automake.xml 9.1 KB

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