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 220 221 222 223
|
.\" Copyright (C) 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
.\" Copyright (C) 1998 Ben Pfaff.
.\"
.\" Permission is granted to make and distribute verbatim copies of
.\" this manual provided the copyright notice and this permission notice
.\" are preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the entire
.\" resulting derived work is distributed under the terms of a permission
.\" notice identical to this one.
.\"
.\" Permission is granted to copy and distribute translations of this manual
.\" into another language, under the above conditions for modified versions,
.\" except that this permission notice may be stated in a translation approved
.\" by the Foundation.
.\"
.TH AUTOMAKE 1 "Automake"
.SH NAME
automake - automatically create Makefile.in's from Makefile.am's
.SH SYNOPSIS
.B automake
[
.B -a
|
.B --add-missing
] [
.BR --amdir= DIR
] [
.BR --build-dir= DIR
] [
.B --cygnus
] [
.B --foreign
] [
.B --gnits
] [
.B --gnu
] [
.B --help
] [
.B -i
|
.B --include-deps
] [
.B --no-force
] [
.B -o
DIR
] [
.BR --output-dir= DIR
] [
.BR --srcdir-name= DIR
] [
.B -v
|
.B --verbose
] [
.B --version
]
.SH DESCRIPTION
.PP
To create all the
.BR Makefile.in s
for a package, run the
.B automake
program in the top level directory, with no arguments.
.B automake
will automatically find each appropriate
.B Makefile.am
(by scanning
.BR configure.in )
and generate the corresponding
.BR Makefile.in .
Note that
.B automake
has a rather simplistic view of what constitutes a package; it assumes
that a package has only one
.BR configure.in ,
at the
top. If your package has multiple
.BR configure.in s,
then you must run
.B automake
in each directory holding a
.BR configure.in .
.PP
You can optionally give
.B automake
an argument;
.B .am
is appended to the argument and the result is used as the name of the
input file. This feature is generally only used to automatically
rebuild an out-of-date
.BR Makefile.in .
Note that
.B automake
must always be run from the topmost directory of a project, even if
being used to regenerate the
.B Makefile.in
in some subdirectory. This is necessary
because
.B automake
must scan
.BR configure.in ,
and because
.B automake
uses the knowledge that a
.B Makefile.in
is in a subdirectory to change its behavior in some cases.
.PP
.B automake
accepts the following options:
.TP
.BI -a
.TP
.BI --add-missing
Automake requires certain common files to exist in certain
situations; for instance
.B config.guess
is required if
.B configure.in
runs
.BR AC_CANONICAL_HOST .
Automake is distributed with several of these files; this option will
cause the missing ones to be automatically added to the package,
whenever possible. In general if Automake tells you a file is
missing, try using this option.
.TP
.BI --amdir=\fRDIR
Look for Automake data files in directory DIR instead of in the
installation directory. This is typically used for debugging.
.TP
.BI --build-dir=\fRDIR
Tell Automake where the build directory is. This option is used
when including dependencies into a
.B Makefile.in
generated by
.B make
.BR dist ;
it should not be used otherwise.
.TP
.BI --cygnus
Causes the generated
.BR Makefile.in s
to follow Cygnus rules, instead of GNU or Gnits rules.
.TP
.BI --foreign
Set the global strictness to
.BR foreign .
.TP
.BI --gnits
Set the global strictness to
.BR gnits .
.TP
.BI --gnu
Set the global strictness to
.BR gnu .
This is the default strictness.
.TP
.BI --help
Print a summary of the command line options and exit.
.TP
.BI -i
.TP
.BI --include-deps
Include all automatically generated dependency information in the
generated
.BR Makefile.in .
This is generally done
when making a distribution.
.TP
.BI --no-force
Ordinarily
.B automake
creates all
.BR Makefile.in s
mentioned in
.BR configure.in .
This option causes it to only update those
.BR Makefile.in s
which are out of date with respect to one of their dependents.
.TP
.BI -o\ \fRDIR
.TP
.BI --output-dir=\fRDIR
Put the generated
.B Makefile.in
in the directory DIR. Ordinarily
each
.B Makefile.in
is created in the directory of the
corresponding
.BR Makefile.am .
This option is used when making
distributions.
.TP
.BI --srcdir-name=\fRDIR
Tell Automake the name of the source directory associated with the
current build. This option is used when including dependencies into a
.B Makefile.in
generated by
.BR make dist ;
it should not be used otherwise.
.TP
.BI -v
.TP
.BI --verbose
Cause Automake to print information about which files are being read
or created.
.TP
.BI --version
Print the version number of Automake and exit.
.PP
.SH "SEE ALSO"
.BR aclocal (1),
and the Texinfo documentation for automake
.SH AUTHORS
Automake was written primarily by David Mackenzie and Tom Tromey.
This manpage written by Ben Pfaff <pfaffben@pilot.msu.edu> for the
Debian GNU/Linux
.B automake
package.
|