aboutsummaryrefslogtreecommitdiffstats
path: root/chapter06/automake.xml
blob: 2202f65ca87b0ed9c4bd999665302f1e5bfaee8d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  <!ENTITY % patches-entities SYSTEM "../patches.ent">
  %general-entities;
  %patches-entities;
]>
<sect1 id="ch-system-automake" role="wrap">
<title>Automake-&automake-version;</title>
<?dbhtml filename="automake.html"?>

<indexterm zone="ch-system-automake"><primary sortas="a-Automake">Automake</primary></indexterm>

<sect2 role="package"><title/>
<para>The Automake package contains programs for generating Makefiles for use
with Autoconf.</para>

<segmentedlist>
<segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.2 SBU</seg><seg>6.8 MB</seg></seglistitem>
</segmentedlist>

<segmentedlist>
<segtitle>&dependencies;</segtitle>
<seglistitem><seg>Autoconf, Bash, Coreutils,
Diffutils, Grep, M4, Make, Perl, and Sed</seg></seglistitem>
</segmentedlist>
</sect2>

<sect2 role="installation">
<title>Installation of Automake</title>

<para>Prepare Automake for compilation:</para>

<screen><userinput>./configure --prefix=/usr</userinput></screen>

<para>Compile the package:</para>

<screen><userinput>make</userinput></screen>

<para>To test the results, issue:
<userinput>make check</userinput>. This takes a long time, about 5 SBUs.</para>

<para>Install the package:</para>

<screen><userinput>make install</userinput></screen>

</sect2>


<sect2 id="contents-automake" role="content"><title>Contents of Automake</title>

<segmentedlist>
<segtitle>Installed programs</segtitle>
<seglistitem><seg>acinstall, aclocal, aclocal-&automake-version;,
automake, automake-&automake-version;,
compile, config.guess, config.sub, depcomp, elisp-comp, install-sh, mdate-sh, 
missing, mkinstalldirs, py-compile, symlink-tree, and ylwrap</seg></seglistitem>
</segmentedlist>

<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>

<varlistentry id="acinstall">
<term><command>acinstall</command></term>
<listitem>
<para>A script that installs aclocal-style M4 files</para>
<indexterm zone="ch-system-automake acinstall"><primary sortas="b-acinstall">acinstall</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="aclocal">
<term><command>aclocal</command></term>
<listitem>
<para>Generates <filename>aclocal.m4</filename>
files based on the contents of <filename>configure.in</filename> files</para>
<indexterm zone="ch-system-automake aclocal"><primary sortas="b-aclocal">aclocal</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="aclocal-version">
<term><command>aclocal-&automake-version;</command></term>
<listitem>
<para>A hard link to <command>aclocal</command></para>
<indexterm zone="ch-system-automake aclocal-version"><primary
sortas="b-aclocal-&automake-version;">aclocal-&automake-version;</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="automake">
<term><command>automake</command></term>
<listitem>
<para>A tool for automatically generating
<filename>Makefile.in</filename> files from
<filename>Makefile.am</filename> files. To create all the
<filename>Makefile.in</filename> files for a package, run this program
in the top-level directory. By scanning the
<filename>configure.in</filename> file, it automatically finds each
appropriate <filename>Makefile.am</filename> file and generate the
corresponding <filename>Makefile.in</filename> file</para>
<indexterm zone="ch-system-automake automake"><primary sortas="b-automake">automake</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="automake-version">
<term><command>automake-&automake-version;</command></term>
<listitem>
<para>A hard link to <command>automake</command></para>
<indexterm zone="ch-system-automake automake-version"><primary
sortas="b-automake-&automake-version;">automake-&automake-version;</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="compile">
<term><command>compile</command></term>
<listitem>
<para>A wrapper for compilers</para>
<indexterm zone="ch-system-automake compile"><primary sortas="b-compile">compile</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="config.guess">
<term><command>config.guess</command></term>
<listitem>
<para>A script that attempts to guess
the canonical triplet for the given build, host, or target architecture</para>
<indexterm zone="ch-system-automake config.guess"><primary sortas="b-config.guess">config.guess</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="config.sub">
<term><command>config.sub</command></term>
<listitem>
<para>A configuration validation subroutine script</para>
<indexterm zone="ch-system-automake config.sub"><primary sortas="b-config.sub">config.sub</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="depcomp">
<term><command>depcomp</command></term>
<listitem>
<para>A script for compiling a program so that dependency information
is generated in addition to the desired output</para>
<indexterm zone="ch-system-automake depcomp"><primary sortas="b-depcomp">depcomp</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="elisp-comp">
<term><command>elisp-comp</command></term>
<listitem>
<para>Byte-compiles Emacs Lisp code</para>
<indexterm zone="ch-system-automake elisp-comp"><primary sortas="b-elisp-comp">elisp-comp</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="install-sh">
<term><command>install-sh</command></term>
<listitem>
<para>A script that installs a program, script, or data file</para>
<indexterm zone="ch-system-automake install-sh"><primary sortas="b-install-sh">install-sh</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="mdate-sh">
<term><command>mdate-sh</command></term>
<listitem>
<para>A script that prints the modification time of a file or directory</para>
<indexterm zone="ch-system-automake mdate-sh"><primary sortas="b-mdate-sh">mdate-sh</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="missing">
<term><command>missing</command></term>
<listitem>
<para>A script acting as a common stub for missing GNU programs during
an installation</para>
<indexterm zone="ch-system-automake missing"><primary sortas="b-missing">missing</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="mkinstalldirs">
<term><command>mkinstalldirs</command></term>
<listitem>
<para>A script that creates a directory tree</para>
<indexterm zone="ch-system-automake mkinstalldirs"><primary sortas="b-mkinstalldirs">mkinstalldirs</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="py-compile">
<term><command>py-compile</command></term>
<listitem>
<para>Compiles a Python program</para>
<indexterm zone="ch-system-automake py-compile"><primary sortas="b-py-compile">py-compile</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="symlink-tree">
<term><command>symlink-tree</command></term>
<listitem>
<para>A script to create a symlink tree of a directory tree</para>
<indexterm zone="ch-system-automake symlink-tree"><primary sortas="b-symlink-tree">symlink-tree</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="ylwrap">
<term><command>ylwrap</command></term>
<listitem>
<para>A wrapper for <command>lex</command> and <command>yacc</command></para>
<indexterm zone="ch-system-automake ylwrap"><primary sortas="b-ylwrap">ylwrap</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>