| [Top] | [Contents] | [Index] | [ ? ] |
This file documents the GNU Automake package. Automake is a program which creates GNU standards-compliant Makefiles from template files. This edition documents version 1.7.2.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Automake is a tool for automatically generating `Makefile.in's from
files called `Makefile.am'. Each `Makefile.am' is basically a
series of make variable definitions(1), with
rules being thrown in occasionally. The generated `Makefile.in's
are compliant with the GNU Makefile standards.
The GNU Makefile Standards Document (see section `Makefile Conventions' in The GNU Coding Standards) is long, complicated, and subject to change. The goal of Automake is to remove the burden of Makefile maintenance from the back of the individual GNU maintainer (and put it on the back of the Automake maintainer).
The typical Automake input file is simply a series of variable definitions. Each such file is processed to create a `Makefile.in'. There should generally be one `Makefile.am' per directory of a project.
Automake does constrain a project in certain ways; for instance it assumes that the project uses Autoconf (see section `Introduction' in The Autoconf Manual), and enforces certain restrictions on the `configure.in' contents(2).
Automake requires perl in order to generate the
`Makefile.in's. However, the distributions created by Automake are
fully GNU standards-compliant, and do not require perl in order
to be built.
Mail suggestions and bug reports for Automake to bug-automake@gnu.org.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The following sections cover a few basic ideas that will help you understand how Automake works.
2.1 General Operation General operation of Automake 2.2 Strictness Standards conformance checking 2.3 The Uniform Naming Scheme 2.4 How derived variables are named 2.5 Variables reserved for the user 2.6 Programs automake might require
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Automake works by reading a `Makefile.am' and generating a `Makefile.in'. Certain variables and targets defined in the `Makefile.am' instruct Automake to generate more specialized code; for instance, a `bin_PROGRAMS' variable definition will cause targets for compiling and linking programs to be generated.
The variable definitions and targets in the `Makefile.am' are copied
verbatim into the generated file. This allows you to add arbitrary code
into the generated `Makefile.in'. For instance the Automake
distribution includes a non-standard cvs-dist target, which the
Automake maintainer uses to make distributions from his source control
system.
Note that most GNU make extensions are not recognized by Automake. Using such extensions in a `Makefile.am' will lead to errors or confusing behavior.
A special exception is that the GNU make append operator, `+=', is supported. This operator appends its right hand argument to the variable specified on the left. Automake will translate the operator into an ordinary `=' operator; `+=' will thus work with any make program.
Automake tries to keep comments grouped with any adjoining targets or variable definitions.
A target defined in `Makefile.am' generally overrides any such
target of a similar name that would be automatically generated by
automake. Although this is a supported feature, it is generally
best to avoid making use of it, as sometimes the generated rules are
very particular.
Similarly, a variable defined in `Makefile.am' or AC_SUBST'ed
from `configure.in' will override any definition of the variable that
automake would ordinarily create. This feature is more often
useful than the ability to override a target definition. Be warned that
many of the variables generated by automake are considered to be for
internal use only, and their names might change in future releases.
When examining a variable definition, Automake will recursively examine
variables referenced in the definition. For example, if Automake is
looking at the content of foo_SOURCES in this snippet
xs = a.c b.c foo_SOURCES = c.c $(xs) |
it would use the files `a.c', `b.c', and `c.c' as the
contents of foo_SOURCES.
Automake also allows a form of comment which is not copied into the output; all lines beginning with `##' (leading spaces allowed) are completely ignored by Automake.
It is customary to make the first line of `Makefile.am' read:
## Process this file with automake to produce Makefile.in |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
While Automake is intended to be used by maintainers of GNU packages, it does make some effort to accommodate those who wish to use it, but do not want to use all the GNU conventions.
To this end, Automake supports three levels of strictness---the strictness indicating how stringently Automake should check standards conformance.
The valid strictness levels are:
For more information on the precise implications of the strictness
level, see 21. The effect of --gnu and --gnits.
Automake also has a special "cygnus" mode which is similar to
strictness but handled differently. This mode is useful for packages
which are put into a "Cygnus" style tree (e.g., the GCC tree). For
more information on this mode, see 22. The effect of --cygnus.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Automake variables generally follow a uniform naming scheme that
makes it easy to decide how programs (and other derived objects) are
built, and how they are installed. This scheme also supports
configure time determination of what should be built.
At make time, certain variables are used to determine which
objects are to be built. The variable names are made of several pieces
which are concatenated together.
The piece which tells automake what is being built is commonly called
the primary. For instance, the primary PROGRAMS holds a
list of programs which are to be compiled and linked.
A different set of names is used to decide where the built objects
should be installed. These names are prefixes to the primary which
indicate which standard directory should be used as the installation
directory. The standard directory names are given in the GNU standards
(see section `Directory Variables' in The GNU Coding Standards).
Automake extends this list with pkglibdir, pkgincludedir,
and pkgdatadir; these are the same as the non-`pkg'
versions, but with `@PACKAGE@' appended. For instance,
pkglibdir is defined as $(libdir)/@PACKAGE@.
For each primary, there is one additional variable named by prepending
`EXTRA_' to the primary name. This variable is used to list
objects which may or may not be built, depending on what
configure decides. This variable is required because Automake
must statically know the entire list of objects that may be built in
order to generate a `Makefile.in' that will work in all cases.
For instance, cpio decides at configure time which programs are
built. Some of the programs are installed in bindir, and some
are installed in sbindir:
EXTRA_PROGRAMS = mt rmt bin_PROGRAMS = cpio pax sbin_PROGRAMS = @MORE_PROGRAMS@ |
Defining a primary without a prefix as a variable, e.g.,
PROGRAMS, is an error.
Note that the common `dir' suffix is left off when constructing the variable names; thus one writes `bin_PROGRAMS' and not `bindir_PROGRAMS'.
Not every sort of object can be installed in every directory. Automake will flag those attempts it finds in error. Automake will also diagnose obvious misspellings in directory names.
Sometimes the standard directories--even as augmented by Automake---
are not enough. In particular it is sometimes useful, for clarity, to
install objects in a subdirectory of some predefined directory. To this
end, Automake allows you to extend the list of possible installation
directories. A given prefix (e.g. `zar') is valid if a variable of
the same name with `dir' appended is defined (e.g. zardir).
For instance, until HTML support is part of Automake, you could use this to install raw HTML documentation:
htmldir = $(prefix)/html html_DATA = automake.html |
The special prefix `noinst' indicates that the objects in question should be built but not installed at all. This is usually used for objects required to build the rest of your package, for instance static libraries (see section 9.2 Building a library), or helper scripts.
The special prefix `check' indicates that the objects in question
should not be built until the make check command is run. Those
objects are not installed either.
The current primary names are `PROGRAMS', `LIBRARIES', `LISP', `PYTHON', `JAVA', `SCRIPTS', `DATA', `HEADERS', `MANS', and `TEXINFOS'.
Some primaries also allow additional prefixes which control other
aspects of automake's behavior. The currently defined prefixes
are `dist_', `nodist_', and `nobase_'. These prefixes
are explained later (see section 9.4 Program and Library Variables).
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Sometimes a Makefile variable name is derived from some text the maintainer supplies. For instance, a program name listed in `_PROGRAMS' is rewritten into the name of a `_SOURCES' variable. In cases like this, Automake canonicalizes the text, so that program names and the like do not have to follow Makefile variable naming rules. All characters in the name except for letters, numbers, the strudel (@), and the underscore are turned into underscores when making variable references.
For example, if your program is named sniff-glue, the derived
variable name would be sniff_glue_SOURCES, not
sniff-glue_SOURCES. Similarly the sources for a library named
libmumble++.a should be listed in the
libmumble___a_SOURCES variable.
The strudel is an addition, to make the use of Autoconf substitutions in variable names less obfuscating.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Some Makefile variables are reserved by the GNU Coding Standards
for the use of the "user" -- the person building the package. For
instance, CFLAGS is one such variable.
Sometimes package developers are tempted to set user variables such as
CFLAGS because it appears to make their job easier -- they don't
have to introduce a second variable into every target.
However, the package itself should never set a user variable, particularly not to include switches which are required for proper compilation of the package. Since these variables are documented as being for the package builder, that person rightfully expects to be able to override any of these variables at build time.
To get around this problem, automake introduces an automake-specific
shadow variable for each user flag variable. (Shadow variables are not
introduced for variables like CC, where they would make no
sense.) The shadow variable is named by prepending `AM_' to the
user variable's name. For instance, the shadow variable for
YFLAGS is AM_YFLAGS.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Automake sometimes requires helper programs so that the generated `Makefile' can do its work properly. There are a fairly large number of them, and we list them here.
ansi2knr.c
ansi2knr.1
compile
config.guess
config.sub
depcomp
elisp-comp
install-sh
install program which works on
platforms where install is unavailable or unusable.
mdate-sh
missing
missing
prints an informative warning and attempts to fix things so that the
build can continue.
mkinstalldirs
mkdir -p is not portable.
py-compile
texinfo.tex
make dvi, make ps
and make pdf to work when Texinfo sources are in the package.
ylwrap
lex and yacc and ensures that, for
instance, multiple yacc instances can be invoked in a single
directory in parallel.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
3.1 A simple example, start to finish 3.2 A classic program 3.3 Building true and false
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Let's suppose you just finished writing zardoz, a program to make
your head float from vortex to vortex. You've been using Autoconf to
provide a portability framework, but your `Makefile.in's have been
ad-hoc. You want to make them bulletproof, so you turn to Automake.
The first step is to update your `configure.in' to include the
commands that automake needs. The way to do this is to add an
AM_INIT_AUTOMAKE call just after AC_INIT:
AC_INIT(zardoz, 1.0) AM_INIT_AUTOMAKE ... |
Since your program doesn't have any complicating factors (e.g., it
doesn't use gettext, it doesn't want to build a shared library),
you're done with this part. That was easy!
Now you must regenerate `configure'. But to do that, you'll need
to tell autoconf how to find the new macro you've used. The
easiest way to do this is to use the aclocal program to generate
your `aclocal.m4' for you. But wait... maybe you already have an
`aclocal.m4', because you had to write some hairy macros for your
program. The aclocal program lets you put your own macros into
`acinclude.m4', so simply rename and then run:
mv aclocal.m4 acinclude.m4 aclocal autoconf |
Now it is time to write your `Makefile.am' for zardoz.
Since zardoz is a user program, you want to install it where the
rest of the user programs go: bindir. Additionally,
zardoz has some Texinfo documentation. Your `configure.in'
script uses AC_REPLACE_FUNCS, so you need to link against
`@LIBOBJS@'. So here's what you'd write:
bin_PROGRAMS = zardoz zardoz_SOURCES = main.c head.c float.c vortex9.c gun.c zardoz_LDADD = @LIBOBJS@ info_TEXINFOS = zardoz.texi |
Now you can run automake --add-missing to generate your
`Makefile.in' and grab any auxiliary files you might need, and
you're done!
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
GNU hello is renowned for its classic simplicity and versatility. This section shows how Automake could be used with the GNU Hello package. The examples below are from the latest beta version of GNU Hello, but with all of the maintainer-only code stripped out, as well as all copyright comments.
Of course, GNU Hello is somewhat more featureful than your traditional two-liner. GNU Hello is internationalized, does option processing, and has a manual and a test suite.
Here is the `configure.in' from GNU Hello:
dnl Process this file with autoconf to produce a configure script.
AC_INIT(src/hello.c)
AM_INIT_AUTOMAKE(hello, 1.3.11)
AM_CONFIG_HEADER(config.h)
dnl Set of available languages.
ALL_LINGUAS="de fr es ko nl no pl pt sl sv"
dnl Checks for programs.
AC_PROG_CC
AC_ISC_POSIX
dnl Checks for libraries.
dnl Checks for header files.
AC_STDC_HEADERS
AC_HAVE_HEADERS(string.h fcntl.h sys/file.h sys/param.h)
dnl Checks for library functions.
AC_FUNC_ALLOCA
dnl Check for st_blksize in struct stat
AC_ST_BLKSIZE
dnl internationalization macros
AM_GNU_GETTEXT
AC_OUTPUT([Makefile doc/Makefile intl/Makefile po/Makefile.in \
src/Makefile tests/Makefile tests/hello],
[chmod +x tests/hello])
|
The `AM_' macros are provided by Automake (or the Gettext library); the rest are standard Autoconf macros.
The top-level `Makefile.am':
EXTRA_DIST = BUGS ChangeLog.O SUBDIRS = doc intl po src tests |
As you can see, all the work here is really done in subdirectories.
The `po' and `intl' directories are automatically generated
using gettextize; they will not be discussed here.
In `doc/Makefile.am' we see:
info_TEXINFOS = hello.texi hello_TEXINFOS = gpl.texi |
This is sufficient to build, install, and distribute the GNU Hello manual.
Here is `tests/Makefile.am':
TESTS = hello EXTRA_DIST = hello.in testdata |
The script `hello' is generated by configure, and is the
only test case. make check will run this test.
Last we have `src/Makefile.am', where all the real work is done:
bin_PROGRAMS = hello hello_SOURCES = hello.c version.c getopt.c getopt1.c getopt.h system.h hello_LDADD = @INTLLIBS@ @ALLOCA@ localedir = $(datadir)/locale INCLUDES = -I../intl -DLOCALEDIR=\"$(localedir)\" |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Here is another, trickier example. It shows how to generate two
programs (true and false) from the same source file
(`true.c'). The difficult part is that each compilation of
`true.c' requires different cpp flags.
bin_PROGRAMS = true false
false_SOURCES =
false_LDADD = false.o
true.o: true.c
$(COMPILE) -DEXIT_CODE=0 -c true.c
false.o: true.c
$(COMPILE) -DEXIT_CODE=1 -o false.o -c true.c
|
Note that there is no true_SOURCES definition. Automake will
implicitly assume that there is a source file named `true.c', and
define rules to compile `true.o' and link `true'. The
true.o: true.c rule supplied by the above `Makefile.am',
will override the Automake generated rule to build `true.o'.
false_SOURCES is defined to be empty--that way no implicit value
is substituted. Because we have not listed the source of
`false', we have to tell Automake how to link the program. This is
the purpose of the false_LDADD line. A false_DEPENDENCIES
variable, holding the dependencies of the `false' target will be
automatically generated by Automake from the content of
false_LDADD.
The above rules won't work if your compiler doesn't accept both
`-c' and `-o'. The simplest fix for this is to introduce a
bogus dependency (to avoid problems with a parallel make):
true.o: true.c false.o
$(COMPILE) -DEXIT_CODE=0 -c true.c
false.o: true.c
$(COMPILE) -DEXIT_CODE=1 -c true.c && mv true.o false.o
|
Also, these explicit rules do not work if the de-ANSI-fication feature is used (see section 9.13 Automatic de-ANSI-fication). Supporting de-ANSI-fication requires a little more work:
true._o: true._c false.o
$(COMPILE) -DEXIT_CODE=0 -c true.c
false._o: true._c
$(COMPILE) -DEXIT_CODE=1 -c true.c && mv true._o false.o
|
As it turns out, there is also a much easier way to do this same task.
Some of the above techniques are useful enough that we've kept the
example in the manual. However if you were to build true and
false in real life, you would probably use per-program
compilation flags, like so:
bin_PROGRAMS = false true false_SOURCES = true.c false_CPPFLAGS = -DEXIT_CODE=1 true_SOURCES = true.c true_CPPFLAGS = -DEXIT_CODE=0 |
In this case Automake will cause `true.c' to be compiled twice, with different flags. De-ANSI-fication will work automatically. In this instance, the names of the object files would be chosen by automake; they would be `false-true.o' and `true-true.o'. (The name of the object files rarely matters.)
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
To create all the `Makefile.in's for a package, run the
automake program in the top level directory, with no arguments.
automake will automatically find each appropriate
`Makefile.am' (by scanning `configure.in'; see section 5. Scanning `configure.in')
and generate the corresponding `Makefile.in'. Note that
automake has a rather simplistic view of what constitutes a
package; it assumes that a package has only one `configure.in', at
the top. If your package has multiple `configure.in's, then you
must run automake in each directory holding a
`configure.in'. (Alternatively, you may rely on Autoconf's
autoreconf, which is able to recurse your package tree and run
automake where appropriate.)
You can optionally give automake an argument; `.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 `Makefile.in'. Note that automake must always
be run from the topmost directory of a project, even if being used to
regenerate the `Makefile.in' in some subdirectory. This is
necessary because automake must scan `configure.in', and
because automake uses the knowledge that a `Makefile.in' is
in a subdirectory to change its behavior in some cases.
Automake will run autoconf to scan `configure.in' and its
dependencies (`aclocal.m4'), therefore autoconf must be in
your PATH. If there is an AUTOCONF variable in your
environment it will be used instead of autoconf, this allows you
to select a particular version of Autoconf. By the way, don't
misunderstand this paragraph: Automake runs autoconf to
scan your `configure.in', this won't build
`configure' and you still have to run autoconf yourself for
this purpose.
automake accepts the following options:
AC_CANONICAL_HOST. Automake is distributed with several of these
files (see section 2.6 Programs automake might require); 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.
By default Automake tries to make a symbolic link pointing to its own
copy of the missing file; this can be changed with --copy.
--add-missing, causes installed files to be
copied. The default is to make a symbolic link.
--cygnus.
--add-missing, causes standard files to be reinstalled
even if they already exist in the source tree. This involves removing
the file from the source tree before creating the new symlink (or, with
--copy, copying the new file).
--gnu and --gnits.
--gnu and --gnits. This is the default strictness.
automake creates all `Makefile.in's mentioned in
`configure.in'. This option causes it to only update those
`Makefile.in's which are out of date with respect to one of their
dependents.
A category can be turned off by prefixing its name with `no-'. For instance `-Wno-syntax' will hide the warnings about unused variables.
The categories output by default are `syntax' and `unsupported'. Additionally, `gnu' is enabled in `--gnu' and `--gnits' strictness.
`portability' warnings are currently disabled by default, but they will be enabled in `--gnu' and `--gnits' strictness in a future release.
The environment variable `WARNINGS' can contain a comma separated
list of categories to enable. It will be taken into account before the
command-line switches, this way `-Wnone' will also ignore any
warning category enabled by `WARNINGS'. This variable is also used
by other tools like autoconf; unknown categories are ignored
for this reason.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Automake scans the package's `configure.in' to determine certain
information about the package. Some autoconf macros are required
and some variables must be defined in `configure.in'. Automake
will also use information from `configure.in' to further tailor its
output.
Automake also supplies some Autoconf macros to make the maintenance
easier. These macros can automatically be put into your
`aclocal.m4' using the aclocal program.
5.1 Configuration requirements 5.2 Other things Automake recognizes 5.3 Auto-generating aclocal.m4 5.4 aclocal options aclocal command line arguments 5.5 Macro search path Modifying aclocal's search path 5.6 Autoconf macros supplied with Automake 5.7 Writing your own aclocal macros
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The one real requirement of Automake is that your `configure.in'
call AM_INIT_AUTOMAKE. This macro does several things which are
required for proper Automake operation (see section 5.6 Autoconf macros supplied with Automake).
Here are the other macros which Automake requires but which are not run
by AM_INIT_AUTOMAKE:
AC_CONFIG_FILES
AC_OUTPUT
AC_CONFIG_FILES([foo/Makefile]) will cause Automake to
generate `foo/Makefile.in' if `foo/Makefile.am' exists.
Other listed files are treated differently. Currently the only
difference is that an Automake `Makefile' is removed by make
distclean, while other files are removed by make clean.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Every time Automake is run it calls Autoconf to trace `configure.in'. This way it can recognize the use of certain macros and tailor the generated `Makefile.in' appropriately. Currently recognized macros and their effects are:
AC_CONFIG_HEADERS
AM_CONFIG_HEADER
(see section 5.6 Autoconf macros supplied with Automake); this is no longer the case today.
AC_CONFIG_AUX_DIR
AC_CANONICAL_HOST
AC_CANONICAL_SYSTEM
AC_CANONICAL_HOST, but also defines the
`Makefile' variables `build_alias' and `target_alias'.
See section `Getting the Canonical System Type' in The Autoconf Manual.
AC_LIBSOURCE
AC_LIBSOURCES
AC_LIBOBJ
AC_LIBSOURCE or AC_LIBSOURCES.
Note that the AC_LIBOBJ macro calls AC_LIBSOURCE. So if
an Autoconf macro is documented to call AC_LIBOBJ([file]), then
`file.c' will be distributed automatically by Automake. This
encompasses many macros like AC_FUNC_ALLOCA,
AC_FUNC_MEMCMP, AC_REPLACE_FUNCS, and others.
By the way, direct assignments to LIBOBJS are no longer
supported. You should always use AC_LIBOBJ for this purpose.
See section `AC_LIBOBJ vs. LIBOBJS' in The Autoconf Manual.
AC_PROG_RANLIB
AC_PROG_CXX
AC_PROG_F77
AC_F77_LIBRARY_LDFLAGS
AC_PROG_LIBTOOL
libtool (see section `Introduction' in The Libtool Manual).
AC_PROG_YACC
AC_PROG_LEX
AC_SUBST
If the Autoconf manual says that a macro calls AC_SUBST for
var, or defined the output variable var then var will
be defined in each generated `Makefile.in'.
E.g. AC_PATH_XTRA defines X_CFLAGS and X_LIBS, so
you can use the variable in any `Makefile.am' if
AC_PATH_XTRA is called.
AM_C_PROTOTYPES
AM_GNU_GETTEXT
AM_MAINTAINER_MODE
configure. If this is used, automake will cause
`maintainer-only' rules to be turned off by default in the
generated `Makefile.in's. This macro defines the
`MAINTAINER_MODE' conditional, which you can use in your own
`Makefile.am'.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Automake includes a number of Autoconf macros which can be used in your
package; some of them are actually required by Automake in certain
situations. These macros must be defined in your `aclocal.m4';
otherwise they will not be seen by autoconf.
The aclocal program will automatically generate `aclocal.m4'
files based on the contents of `configure.in'. This provides a
convenient way to get Automake-provided macros, without having to
search around. Also, the aclocal mechanism allows other packages
to supply their own macros.
At startup, aclocal scans all the `.m4' files it can find,
looking for macro definitions (see section 5.5 Macro search path). Then it
scans `configure.in'. Any
mention of one of the macros found in the first step causes that macro,
and any macros it in turn requires, to be put into `aclocal.m4'.
The contents of `acinclude.m4', if it exists, are also automatically included in `aclocal.m4'. This is useful for incorporating local macros into `configure'.
aclocal tries to be smart about looking for new AC_DEFUNs
in the files it scans. It also
tries to copy the full text of the scanned file into `aclocal.m4',
including both `#' and `dnl' comments. If you want to make a
comment which will be completely ignored by aclocal, use
`##' as the comment leader.
5.4 aclocal options Options supported by aclocal 5.5 Macro search path How aclocal finds .m4 files
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
aclocal accepts the following options:
--acdir=dir
--help
-I dir
--output=file
--print-ac-dir
aclocal will search to
find third-party `.m4' files. When this option is given, normal
processing is suppressed. This option can be used by a package to
determine where to install a macro file.
--verbose
--version
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
By default, aclocal searches for `.m4' files in the following
directories, in this order:
acdir-APIVERSION
1.6.
acdir
automake itself is built. This is
`@datadir@/aclocal/', which typically
expands to `${prefix}/share/aclocal/'. To find the compiled-in
value of acdir, use the --print-ac-dir option
(see section 5.4 aclocal options).
As an example, suppose that automake-1.6.2 was configured with
--prefix=/usr/local. Then, the search path would be:
As explained in (see section 5.4 aclocal options), there are several options that can be used to change or extend this search path.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
--acdir
The most obvious option to modify the search path is
--acdir=dir, which changes default directory and
drops the APIVERSION directory. For example, if one specifies
--acdir=/opt/private/, then the search path becomes:
Note that this option, --acdir, is intended for use
by the internal automake test suite only; it is not ordinarily
needed by end-users.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
-I dir
Any extra directories specified using -I options
(see section 5.4 aclocal options) are prepended to this search list. Thus,
aclocal -I /foo -I /bar results in the following search path:
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
There is a third mechanism for customizing the search path. If a `dirlist' file exists in acdir, then that file is assumed to contain a list of directories, one per line, to be added to the search list. These directories are searched after all other directories.
For example, suppose `acdir/dirlist' contains the following:
/test1 /test2 |
and that aclocal was called with the -I /foo -I /bar options.
Then, the search path would be
If the --acdir=dir option is used, then aclocal
will search for the `dirlist' file in dir. In the
--acdir=/opt/private/ example above, aclocal would look
for `/opt/private/dirlist'. Again, however, the --acdir
option is intended for use by the internal automake test suite only;
--acdir is not ordinarily needed by end-users.
`dirlist' is useful in the following situation: suppose that
automake version 1.6.2 is installed with
$prefix=/usr by the system vendor. Thus, the default search
directories are
However, suppose further that many packages have been manually
installed on the system, with $prefix=/usr/local, as is typical.
In that case, many of these "extra" `.m4' files are in
`/usr/local/share/aclocal'. The only way to force
`/usr/bin/aclocal' to find these "extra" `.m4' files
is to always call aclocal -I /usr/local/share/aclocal.
This is inconvenient. With `dirlist', one may create the file
`/usr/share/aclocal/dirlist'
which contains only the single line
`/usr/local/share/aclocal'
Now, the "default" search path on the affected system is
without the need for -I options; -I options can be reserved
for project-specific needs (`my-source-dir/m4/'), rather than
using it to work around local system-dependent tool installation
directories.
Similarly, `dirlist' can be handy if you have installed a local
copy Automake on your account and want aclocal to look for
macros installed at other places on the system.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Automake ships with several Autoconf macros that you can use from your
`configure.in'. When you use one of them it will be included by
aclocal in `aclocal.m4'.
5.6.1 Public macros Macros that you can use. 5.6.2 Private macros Macros that you should not use.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AM_CONFIG_HEADER
AC_CONFIG_HEADERS
today (see section 5.2 Other things Automake recognizes).
AM_ENABLE_MULTILIB
AM_C_PROTOTYPES
AM_HEADER_TIOCGWINSZ_NEEDS_SYS_IOCTL
TIOCGWINSZ requires `<sys/ioctl.h>', then
define GWINSZ_IN_SYS_IOCTL. Otherwise TIOCGWINSZ can be
found in `<termios.h>'.
AM_INIT_AUTOMAKE([OPTIONS])
AM_INIT_AUTOMAKE(PACKAGE, VERSION, [NO-DEFINE])
This macro has two forms, the second of which has two required
arguments: the package and the version number. This latter form is
obsolete because the package and version can be obtained
from Autoconf's AC_INIT macro (which itself has an old and a new
form).
If your `configure.in' has:
AC_INIT(src/foo.c) AM_INIT_AUTOMAKE(mumble, 1.5) |
AC_INIT(mumble, 1.5) AC_CONFIG_SRCDIR(src/foo.c) AM_INIT_AUTOMAKE |
Note that if you're upgrading your `configure.in' from an earlier
version of Automake, it is not always correct to simply move the package
and version arguments from AM_INIT_AUTOMAKE directly to
AC_INIT, as in the example above. The first argument of
AC_INIT is the name of your package (e.g. `GNU Automake'),
not the tarball name (e.g. `automake') you used to pass to
AM_INIT_AUTOMAKE. Autoconf's rule to derive a tarball name from
the package name should work for most but not all packages. Especially,
if your tarball name is not all lower case, you will have to use the
four-argument form of AC_INIT (supported in Autoconf versions
greater than 2.52g).
When AM_INIT_AUTOMAKE is called with a single argument, it is
interpreted as a space-separated list of Automake options which should
be applied to every `Makefile.am' in the tree. The effect is as if
each option were listed in AUTOMAKE_OPTIONS.
By default this macro AC_DEFINE's `PACKAGE' and
`VERSION'. This can be avoided by passing the `no-define'
option, as in:
AM_INIT_AUTOMAKE([gnits 1.5 no-define dist-bzip2]) |
AM_PATH_LISPDIR
emacs, and, if found, sets the output
variable lispdir to the full path to Emacs' site-lisp directory.
Note that this test assumes the emacs found to be a version that
supports Emacs Lisp (such as GNU Emacs or XEmacs). Other emacsen
can cause this test to hang (some, like old versions of MicroEmacs,
start up in interactive mode, requiring `C-x C-c' to exit, which
is hardly obvious for a non-emacs user). In most cases, however, you
should be able to use `C-c' to kill the test. In order to avoid
problems, you can set EMACS to "no" in the environment, or
use the `--with-lispdir' option to configure to
explictly set the correct path (if you're sure you have an emacs
that supports Emacs Lisp.
AM_PROG_AS
CCAS, and will also set CCASFLAGS if required.
AM_PROG_CC_C_O
AC_PROG_CC_C_O, but it generates its results in the
manner required by automake. You must use this instead of
AC_PROG_CC_C_O when you need this functionality.
AM_PROG_CC_STDC
CC to make it so. This macro tries various
options that select ANSI C on some system or another. It considers the
compiler to be in ANSI C mode if it handles function prototypes correctly.
If you use this macro, you should check after calling it whether the C
compiler has been set to accept ANSI C; if not, the shell variable
am_cv_prog_cc_stdc is set to `no'. If you wrote your source
code in ANSI C, you can make an un-ANSIfied copy of it by using the
ansi2knr option (see section 9.13 Automatic de-ANSI-fication).
This macro is a relic from the time Autoconf didn't offer such a
feature. AM_PROG_CC_STDC's logic has now been merged into
Autoconf's AC_PROG_CC macro, therefore you should use the latter
instead. Chances are you are already using AC_PROG_CC, so you
can simply remove the AM_PROG_CC_STDC call and turn all
occurrences of $am_cv_prog_cc_stdc into
$ac_cv_prog_cc_stdc. AM_PROG_CC_STDC will be marked as
obsolete (in the Autoconf sense) in Automake 1.8.
AM_PROG_LEX
AC_PROG_LEX (see section `Particular Program Checks' in The Autoconf Manual), but uses the
missing script on systems that do not have lex.
`HP-UX 10' is one such system.
AM_PROG_GCJ
gcj program or causes an error. It sets
`GCJ' and `GCJFLAGS'. gcj is the Java front-end to the
GNU Compiler Collection.
AM_SYS_POSIX_TERMIOS
am_cv_sys_posix_termios to
`yes'. If not, set the variable to `no'.
AM_WITH_DMALLOC
WITH_DMALLOC and add `-ldmalloc' to LIBS.
AM_WITH_REGEX
configure command line. If
specified (the default), then the `regex' regular expression
library is used, `regex.o' is put into `LIBOBJS', and
`WITH_REGEX' is defined. If `--without-regex' is given, then
the `rx' regular expression library is used, and `rx.o' is put
into `LIBOBJS'.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The following macros are private macros you should not call directly. They are called by the other public macros when appropriate. Do not rely on them, as they might be changed in a future version. Consider them as implementation details; or better, do not consider them at all: skip this section!
_AM_DEPENDENCIES
AM_SET_DEPDIR
AM_DEP_TRACK
AM_OUTPUT_DEPENDENCY_COMMANDS
AM_MAKE_INCLUDE
make handles
include statements. This macro is automatically invoked when
needed; there should be no need to invoke it manually.
AM_PROG_INSTALL_STRIP
install which can be used to
strip a program at installation time. This macro is
automatically included when required.
AM_SANITY_CHECK
AM_INIT_AUTOMAKE.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The aclocal program doesn't have any built-in knowledge of any
macros, so it is easy to extend it with your own macros.
This is mostly used for libraries which want to supply their own
Autoconf macros for use by other programs. For instance the
gettext library supplies a macro AM_GNU_GETTEXT which
should be used by any package using gettext. When the library is
installed, it installs this macro so that aclocal will find it.
A file of macros should be a series of AC_DEFUN's. The
aclocal programs also understands AC_REQUIRE, so it is
safe to put each macro in a separate file. See section `Prerequisite Macros' in The Autoconf Manual, and section `Macro Definitions' in The Autoconf Manual.
A macro file's name should end in `.m4'. Such files should be
installed in `aclocal --print-ac-dir` (which usually happens to
be `$(datadir)/aclocal').
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
In packages with subdirectories, the top level `Makefile.am' must
tell Automake which subdirectories are to be built. This is done via
the SUBDIRS variable.
The SUBDIRS variable holds a list of subdirectories in which
building of various sorts can occur. Many targets (e.g. all) in
the generated `Makefile' will run both locally and in all specified
subdirectories. Note that the directories listed in SUBDIRS are
not required to contain `Makefile.am's; only `Makefile's
(after configuration). This allows inclusion of libraries from packages
which do not use Automake (such as gettext).
In packages that use subdirectories, the top-level `Makefile.am' is often very short. For instance, here is the `Makefile.am' from the GNU Hello distribution:
EXTRA_DIST = BUGS ChangeLog.O README-alpha SUBDIRS = doc intl po src tests |
When Automake invokes make in a subdirectory, it uses the value
of the MAKE variable. It passes the value of the variable
AM_MAKEFLAGS to the make invocation; this can be set in
`Makefile.am' if there are flags you must always pass to
make.
The directories mentioned in SUBDIRS must be direct children of
the current directory. For instance, you cannot put `src/subdir'
into SUBDIRS. Instead you should put SUBDIRS = subdir
into `src/Makefile.am'. Automake can be used to construct packages
of arbitrary depth this way.
By default, Automake generates `Makefiles' which work depth-first
(`postfix'). However, it is possible to change this ordering. You
can do this by putting `.' into SUBDIRS. For instance,
putting `.' first will cause a `prefix' ordering of
directories. All `clean' targets are run in reverse order of build
targets.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
It is possible to define the SUBDIRS variable conditionally if,
like in the case of GNU Inetutils, you want to only build a
subset of the entire package.
To illustrate how this works, let's assume we have two directories
`src/' and `opt/'. `src/' should always be built, but we
want to decide in ./configure whether `opt/' will be built
or not. (For this example we will assume that `opt/' should be
built when the variable $want_opt was set to yes.)
Running make should thus recurse into `src/' always, and
then maybe in `opt/'.
However make dist should always recurse into both `src/' and
`opt/'. Because `opt/' should be distributed even if it is
not needed in the current configuration. This means `opt/Makefile'
should be created unconditionally. (3)
There are two ways to setup a project like this. You can use Automake
conditionals (see section 20. Conditionals) or use Autoconf AC_SUBST
variables (see section `Setting Output Variables' in The Autoconf Manual). Using Automake conditionals is the
preferred solution.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AM_CONDITIONAL `configure' should output the `Makefile' for each directory and define a condition into which `opt/' should be built.
... AM_CONDITIONAL([COND_OPT], [test "$want_opt" = yes]) AC_CONFIG_FILES([Makefile src/Makefile opt/Makefile]) ... |
Then SUBDIRS can be defined in the top-level `Makefile.am'
as follows.
if COND_OPT MAYBE_OPT = opt endif SUBDIRS = src $(MAYBE_OPT) |
As you can see, running make will rightly recurse into
`src/' and maybe `opt/'.
As you can't see, running make dist will recurse into both
`src/' and `opt/' directories because make dist, unlike
make all, doesn't use the SUBDIRS variable. It uses the
DIST_SUBDIRS variable.
In this case Automake will define DIST_SUBDIRS = src opt
automatically because it knows that MAYBE_OPT can contain
opt in some condition.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
AC_SUBST
Another idea is to define MAYBE_OPT from `./configure' using
AC_SUBST:
... if test "$want_opt" = yes; then MAYBE_OPT=opt else MAYBE_OPT= fi AC_SUBST([MAYBE_OPT]) AC_CONFIG_FILES([Makefile src/Makefile opt/Makefile]) ... |
In this case the top-level `Makefile.am' should look as follows.
SUBDIRS = src $(MAYBE_OPT) DIST_SUBDIRS = src opt |
The drawback is that since Automake cannot guess what the possible
values of MAYBE_OPT are, it is necessary to define
DIST_SUBDIRS.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
DIST_SUBDIRS is used
As shown in the above examples, DIST_SUBDIRS is used by targets
that need to recurse in all directories, even those which have been
conditionally left out of the build.
Precisely, DIST_SUBDIRS is used by make dist, make
distclean, and make maintainer-clean. All other recursive
targets use SUBDIRS.
Automake will define DIST_SUBDIRS automatically from the
possibles values of SUBDIRS in all conditions.
If SUBDIRS contains AC_SUBST variables,
DIST_SUBDIRS will not be defined correctly because Automake
doesn't know the possible values of these variables. In this case
DIST_SUBDIRS needs to be defined manually.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If you've ever read Peter Miller's excellent paper,
Recursive Make Considered Harmful, the preceding section on the use of
subdirectories will probably come as unwelcome advice. For those who
haven't read the paper, Miller's main thesis is that recursive
make invocations are both slow and error-prone.
Automake provides sufficient cross-directory support (4) to enable you to write a single `Makefile.am' for a complex multi-directory package.
By default an installable file specified in a subdirectory will have its directory name stripped before installation. For instance, in this example, the header file will be installed as `$(includedir)/stdio.h':
include_HEADERS = inc/stdio.h |
However, the `nobase_' prefix can be used to circumvent this path stripping. In this example, the header file will be installed as `$(includedir)/sys/types.h':
nobase_include_HEADERS = sys/types.h |
`nobase_' should be specified first when used in conjunction with either `dist_' or `nodist_' (see section 15. What Goes in a Distribution). For instance:
nobase_dist_pkgdata_DATA = images/vortex.pgm |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Automake generates rules to automatically rebuild `Makefile's, `configure', and other derived files like `Makefile.in'.
If you are using AM_MAINTAINER_MODE in `configure.in', then
these automatic rebuilding rules are only enabled in maintainer mode.
Sometimes you need to run aclocal with an argument like -I
to tell it where to find `.m4' files. Since sometimes make
will automatically run aclocal, you need a way to specify these
arguments. You can do this by defining ACLOCAL_AMFLAGS; this
holds arguments which are passed verbatim to aclocal. This variable
is only useful in the top-level `Makefile.am'.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
A large part of Automake's functionality is dedicated to making it easy to build programs and libraries.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
In order to build a program, you need to tell Automake which sources are part of it, and which libraries it should be linked with.
This section also covers conditional compilation of sources or programs. Most of the comments about these also apply to libraries (see section 9.2 Building a library) and Libtool libraries (see section 9.3 Building a Shared Library).
9.1.1 Defining program sources 9.1.2 Linking the program Linking with libraries or extra objects 9.1.3 Conditional compilation of sources Handling conditional sources 9.1.4 Conditional compilation of programs Building program conditionally
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
In a directory containing source that gets built into a program (as
opposed to a library or a script), the `PROGRAMS' primary is used.
Programs can be installed in bindir, sbindir,
libexecdir, pkglibdir, or not at all (`noinst').
They can also be built only for make check, in which case the
prefix is `check'.
For instance:
bin_PROGRAMS = hello |
In this simple case, the resulting `Makefile.in' will contain code
to generate a program named hello.
Associated with each program are several assisting variables which are named after the program. These variables are all optional, and have reasonable defaults. Each variable, its use, and default is spelled out below; we use the "hello" example throughout.
The variable hello_SOURCES is used to specify which source files
get built into an executable:
hello_SOURCES = hello.c version.c getopt.c getopt1.c getopt.h system.h |
This causes each mentioned `.c' file to be compiled into the corresponding `.o'. Then all are linked to produce `hello'.
If `hello_SOURCES' is not specified, then it defaults to the single file `hello.c'; that is, the default is to compile a single C file whose base name is the name of the program itself. (This is a terrible default but we are stuck with it for historical reasons.)
Multiple programs can be built in a single directory. Multiple programs can share a single source file, which must be listed in each `_SOURCES' definition.
Header files listed in a `_SOURCES' definition will be included in the distribution but otherwise ignored. In case it isn't obvious, you should not include the header file generated by `configure' in a `_SOURCES' variable; this file should not be distributed. Lex (`.l') and Yacc (`.y') files can also be listed; see 9.7 Yacc and Lex support.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [C |