aboutsummaryrefslogtreecommitdiffstats
path: root/chapter06/automake.xml
blob: 84043649a1338b1976ce93b4d49d1879557aaf59 (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>
<sect1 id="ch-system-automake" xreflabel="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>Automake installation depends on</segtitle>
<seglistitem><seg>Autoconf, Bash, Coreutils,
Diffutils, Grep, M4, Make, Perl, 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-1.8, automake, automake-1.8, 
compile, config.guess, config.sub, depcomp, elisp-comp, install-sh, mdate-sh, 
missing, mkinstalldirs, py-compile, symlink-tree, ylwrap</seg></seglistitem>
</segmentedlist>

<variablelist><title>Short descriptions</title>

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

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

<varlistentry id="automake">
<term><command>automake</command></term>
<listitem>
<indexterm zone="ch-system-automake automake"><primary sortas="b-automake">automake</primary></indexterm>
<para>is a tool for automatically generating
<filename>Makefile.in</filename>'s from files called
<filename>Makefile.am</filename>. 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>s it
automatically finds each appropriate <filename>Makefile.am</filename> and
generate the corresponding <filename>Makefile.in</filename>.</para>
</listitem>
</varlistentry>

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

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

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

<varlistentry id="depcomp">
<term><command>depcomp</command></term>
<listitem>
<indexterm zone="ch-system-automake depcomp"><primary sortas="b-depcomp">depcomp</primary></indexterm>
<para>is a script for compiling a program so that not only the desired output is 
generated, but also dependency information.</para>
</listitem>
</varlistentry>

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

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

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

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

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

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

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

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

</sect2>

</sect1>