Autoconf: David Mackenzie Ben Elliston Akim Demaille
Autoconf: David Mackenzie Ben Elliston Akim Demaille
Autoconf: David Mackenzie Ben Elliston Akim Demaille
David MacKenzie
Ben Elliston
Akim Demaille
This manual is for GNU Autoconf (version 2.62, 8 April 2008), a package for creating scripts
to configure source code packages using templates and an M4 macro package.
Copyright
c 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
2006, 2007, 2008 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document under
the terms of the GNU Free Documentation License, Version 1.2 or any later
version published by the Free Software Foundation; with no Invariant Sections,
with the Front-Cover texts being “A GNU Manual,” and with the Back-Cover
Texts as in (a) below. A copy of the license is included in the section entitled
“GNU Free Documentation License.”
(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and modify
this GNU manual. Buying copies from the FSF supports it in developing GNU
and promoting software freedom.”
i
Table of Contents
1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
5 Existing Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.1 Common Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.1.1 Standard Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.1.2 Default Includes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5.2 Alternative Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
5.2.1 Particular Program Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
5.2.2 Generic Program and File Checks . . . . . . . . . . . . . . . . . . . . . . . 41
5.3 Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
5.4 Library Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
5.5 Library Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
5.5.1 Portability of C Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
5.5.2 Particular Function Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
5.5.3 Generic Function Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
5.6 Header Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
5.6.1 Portability of Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
5.6.2 Particular Header Checks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
5.6.3 Generic Header Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
5.7 Declarations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
5.7.1 Particular Declaration Checks . . . . . . . . . . . . . . . . . . . . . . . . . . 64
5.7.2 Generic Declaration Checks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
5.8 Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
5.8.1 Particular Structure Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
5.8.2 Generic Structure Checks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
5.9 Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
5.9.1 Particular Type Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
5.9.2 Generic Type Checks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
5.10 Compilers and Preprocessors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
5.10.1 Specific Compiler Characteristics . . . . . . . . . . . . . . . . . . . . . . 70
5.10.2 Generic Compiler Characteristics . . . . . . . . . . . . . . . . . . . . . . 71
5.10.3 C Compiler Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
5.10.4 C++ Compiler Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.10.5 Objective C Compiler Characteristics . . . . . . . . . . . . . . . . . . 78
5.10.6 Erlang Compiler and Interpreter Characteristics. . . . . . . . . 79
5.10.7 Fortran Compiler Characteristics. . . . . . . . . . . . . . . . . . . . . . . 79
5.11 System Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
5.12 Posix Variants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
5.13 Erlang Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
6 Writing Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
6.1 Language Choice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
6.2 Writing Test Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
6.2.1 Guidelines for Test Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
6.2.2 Test Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
6.2.3 Generating Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
6.3 Running the Preprocessor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.4 Running the Compiler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
6.5 Running the Linker. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
6.6 Checking Runtime Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
iii
6.7 Systemology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
6.8 Multiple Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
8 Programming in M4 . . . . . . . . . . . . . . . . . . . . . 111
8.1 M4 Quotation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
8.1.1 Active Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
8.1.2 One Macro Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.1.3 Quoting and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
8.1.4 Quotation and Nested Macros . . . . . . . . . . . . . . . . . . . . . . . . . 114
8.1.5 changequote is Evil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
8.1.6 Quadrigraphs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
8.1.7 Quotation Rule Of Thumb . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
8.2 Using autom4te . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
8.2.1 Invoking autom4te . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
8.2.2 Customizing autom4te . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
8.3 Programming in M4sugar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
8.3.1 Redefined M4 Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
8.3.2 Diagnostic messages from M4sugar . . . . . . . . . . . . . . . . . . . . . 125
8.3.3 Diversion support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
8.3.4 Conditional constructs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
8.3.5 Looping constructs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
8.3.6 Evaluation Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
8.3.7 String manipulation in M4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
8.3.8 Arithmetic computation in M4 . . . . . . . . . . . . . . . . . . . . . . . . . 137
8.3.9 Forbidden Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
8.4 Programming in M4sh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
8.5 File Descriptor Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
1 Introduction
A physicist, an engineer, and a computer scientist were discussing the
nature of God. “Surely a Physicist,” said the physicist, “because
early in the Creation, God made Light; and you know, Maxwell’s
equations, the dual nature of electromagnetic waves, the relativistic
consequences. . . ” “An Engineer!,” said the engineer, “because
before making Light, God split the Chaos into Land and Water; it takes a
hell of an engineer to handle that big amount of mud, and orderly
separation of solids from liquids. . . ” The computer scientist
shouted: “And the Chaos, where do you think it was coming from, hmm?”
—Anonymous
Autoconf is a tool for producing shell scripts that automatically configure software source
code packages to adapt to many kinds of Posix-like systems. The configuration scripts
produced by Autoconf are independent of Autoconf when they are run, so their users do
not need to have Autoconf.
The configuration scripts produced by Autoconf require no manual user intervention
when run; they do not normally even need an argument specifying the system type. Instead,
they individually test for the presence of each feature that the software package they are
for might need. (Before each check, they print a one-line message stating what they are
checking for, so the user doesn’t get too bored while waiting for the script to finish.) As a
result, they deal well with systems that are hybrids or customized from the more common
Posix variants. There is no need to maintain files that list the features supported by each
release of each variant of Posix.
For each software package that Autoconf is used with, it creates a configuration script
from a template file that lists the system features that the package needs or can use. After
the shell code to recognize and respond to a system feature has been written, Autoconf
allows it to be shared by many software packages that can use (or need) that feature. If it
later turns out that the shell code needs adjustment for some reason, it needs to be changed
in only one place; all of the configuration scripts can be regenerated automatically to take
advantage of the updated code.
Those who do not understand Autoconf are condemned to reinvent it, poorly. The
primary goal of Autoconf is making the user’s life easier; making the maintainer’s life
easier is only a secondary goal. Put another way, the primary goal is not to make the
generation of ‘configure’ automatic for package maintainers (although patches along that
front are welcome, since package maintainers form the user base of Autoconf); rather, the
goal is to make ‘configure’ painless, portable, and predictable for the end user of each
autoconfiscated package. And to this degree, Autoconf is highly successful at its goal —
most complaints to the Autoconf list are about difficulties in writing Autoconf input, and
not in the behavior of the resulting ‘configure’. Even packages that don’t use Autoconf
will generally provide a ‘configure’ script, and the most common complaint about these
alternative home-grown scripts is that they fail to meet one or more of the GNU Coding
Standards that users have come to expect from Autoconf-generated ‘configure’ scripts.
The Metaconfig package is similar in purpose to Autoconf, but the scripts it produces
require manual user intervention, which is quite inconvenient when configuring large source
2 Autoconf
trees. Unlike Metaconfig scripts, Autoconf scripts can support cross-compiling, if some care
is taken in writing them.
Autoconf does not solve all problems related to making portable software packages—for
a more complete solution, it should be used in concert with other GNU build tools like
Automake and Libtool. These other tools take on jobs like the creation of a portable,
recursive makefile with all of the standard targets, linking of shared libraries, and so on.
See Chapter 2 [The GNU Build System], page 3, for more information.
Autoconf imposes some restrictions on the names of macros used with #if in C programs
(see Section B.3 [Preprocessor Symbol Index], page 289).
Autoconf requires GNU M4 version 1.4.5 or later in order to generate the scripts. It uses
features that some versions of M4, including GNU M4 1.3, do not have. Autoconf works
better with GNU M4 version 1.4.11 or later, though this is not required.
See Section 17.5 [Autoconf 1], page 253, for information about upgrading from version 1.
See Chapter 20 [History], page 275, for the story of Autoconf’s development. See Chapter 19
[FAQ], page 269, for answers to some common questions about Autoconf.
See the Autoconf web page for up-to-date information, details on the mailing lists,
pointers to a list of known bugs, etc.
Mail suggestions to the Autoconf mailing list. Past suggestions are archived.
Mail bug reports to the Autoconf Bugs mailing list. Past bug reports are archived.
If possible, first check that your bug is not already solved in current development versions,
and that it has not been reported yet. Be sure to include all the needed information and a
short ‘configure.ac’ that demonstrates the problem.
Autoconf’s development tree is accessible via git; see the Autoconf Summary for details,
or view the actual repository. Anonymous CVS access is also available, see ‘README’ for more
details. Patches relative to the current git version can be sent for review to the Autoconf
Patches mailing list. Discussions on past patches are archived, and all commits are archived
in the read-only Autoconf Commit mailing list, which is also archived.
Because of its mission, the Autoconf package itself includes only a set of often-used
macros that have already demonstrated their usefulness. Nevertheless, if you wish to share
your macros, or find existing ones, see the Autoconf Macro Archive, which is kindly run by
Peter Simons.
Chapter 2: The GNU Build System 3
2.1 Automake
The ubiquity of make means that a makefile is almost the only viable way to distribute
automatic build rules for software, but one quickly runs into its numerous limitations.
Its lack of support for automatic dependency tracking, recursive builds in subdirectories,
reliable timestamps (e.g., for network file systems), and so on, mean that developers must
painfully (and often incorrectly) reinvent the wheel for each project. Portability is non-
trivial, thanks to the quirks of make on many systems. On top of all this is the manual
labor required to implement the many standard targets that users have come to expect
(make install, make distclean, make uninstall, etc.). Since you are, of course, using
Autoconf, you also have to insert repetitive code in your Makefile.in to recognize @CC@,
@CFLAGS@, and other substitutions provided by configure. Into this mess steps Automake.
Automake allows you to specify your build needs in a Makefile.am file with a vastly
simpler and more powerful syntax than that of a plain makefile, and then generates a
portable Makefile.in for use with Autoconf. For example, the Makefile.am to build and
install a simple “Hello world” program might look like:
bin_PROGRAMS = hello
hello_SOURCES = hello.c
The resulting Makefile.in (~400 lines) automatically supports all the standard targets, the
substitutions provided by Autoconf, automatic dependency tracking, VPATH building, and
so on. make builds the hello program, and make install installs it in ‘/usr/local/bin’
(or whatever prefix was given to configure, if not ‘/usr/local’).
The benefits of Automake increase for larger packages (especially ones with subdirecto-
ries), but even for small programs the added convenience and portability can be substantial.
And that’s not all. . .
2.2 Gnulib
GNU software has a well-deserved reputation for running on many different types of systems.
While our primary goal is to write software for the GNU system, many users and developers
have been introduced to us through the systems that they were already using.
Gnulib is a central location for common GNU code, intended to be shared among free
software packages. Its components are typically shared at the source level, rather than
being a library that gets built, installed, and linked against. The idea is to copy files from
Gnulib into your own source tree. There is no distribution tarball; developers should just
4 Autoconf
grab source modules from the repository. The source files are available online, under various
licenses, mostly GNU GPL or GNU LGPL.
Gnulib modules typically contain C source code along with Autoconf macros used to con-
figure the source code. For example, the Gnulib stdbool module implements a ‘stdbool.h’
header that nearly conforms to C99, even on old-fashioned hosts that lack ‘stdbool.h’. This
module contains a source file for the replacement header, along with an Autoconf macro
that arranges to use the replacement header on old-fashioned systems.
2.3 Libtool
Often, one wants to build not only programs, but libraries, so that other programs can
benefit from the fruits of your labor. Ideally, one would like to produce shared (dynamically
linked) libraries, which can be used by multiple programs without duplication on disk or
in memory and can be updated independently of the linked programs. Producing shared
libraries portably, however, is the stuff of nightmares—each system has its own incompatible
tools, compiler flags, and magic incantations. Fortunately, GNU provides a solution: Libtool.
Libtool handles all the requirements of building shared libraries for you, and at this time
seems to be the only way to do so with any portability. It also handles many other headaches,
such as: the interaction of Make rules with the variable suffixes of shared libraries, linking
reliably with shared libraries before they are installed by the superuser, and supplying
a consistent versioning system (so that different versions of a library can be installed or
upgraded without breaking binary compatibility). Although Libtool, like Autoconf, can be
used without Automake, it is most simply utilized in conjunction with Automake—there,
Libtool is used automatically whenever shared libraries are needed, and you need not know
its syntax.
2.4 Pointers
Developers who are used to the simplicity of make for small projects on a single system might
be daunted at the prospect of learning to use Automake and Autoconf. As your software
is distributed to more and more users, however, you otherwise quickly find yourself putting
lots of effort into reinventing the services that the GNU build tools provide, and making the
same mistakes that they once made and overcame. (Besides, since you’re already learning
Autoconf, Automake is a piece of cake.)
There are a number of places that you can go to for more information on the GNU build
tools.
− Web
The home pages for Autoconf, Automake, Gnulib, and Libtool.
− Automake Manual
See section “Automake” in GNU Automake, for more information on Automake.
− Books
The book GNU Autoconf, Automake and Libtool 1 describes the complete GNU build
environment. You can also find the entire book on-line.
1
GNU Autoconf, Automake and Libtool, by G. V. Vaughan, B. Elliston, T. Tromey, and I. L. Taylor.
SAMS (originally New Riders), 2000, ISBN 1578701902.
Chapter 3: Making configure Scripts 5
configure.ac --.
| .------> autoconf* -----> configure
[aclocal.m4] --+---+
| ‘-----> [autoheader*] --> [config.h.in]
[acsite.m4] ---’
some variables to decide what to do. These macros are noted in the individual descriptions
(see Chapter 5 [Existing Tests], page 37), and they also warn you when configure is created
if they are called out of order.
To encourage consistency, here is a suggested order for calling the Autoconf macros.
Generally speaking, the things near the end of this list are those that could depend on
things earlier in it. For example, library functions could be affected by types and libraries.
Autoconf requirements
AC_INIT(package, version, bug-report-address )
information on the package
checks for programs
checks for libraries
checks for header files
checks for types
checks for structures
checks for compiler characteristics
checks for library functions
checks for system services
AC_CONFIG_FILES([file...])
AC_OUTPUT
‘--help’
‘-h’ Print a summary of the command line options and exit.
‘--version’
‘-V’ Print the version number of Autoconf and exit.
‘--verbose’
‘-v’ Print the names of the files it examines and the potentially interesting symbols
it finds in them. This output can be voluminous.
‘--include=dir ’
‘-I dir ’ Append dir to the include path. Multiple invocations accumulate.
‘--prepend-include=dir ’
‘-B dir ’ Prepend dir to the include path. Multiple invocations accumulate.
Multiple ‘--trace’ arguments for a single macro are not cumulative; instead,
you should just make format as long as needed.
The format is a regular string, with newlines if desired, and several special
escape codes. It defaults to ‘$f:$l:$n:$%’; see Section 8.2.1 [autom4te Invo-
cation], page 118, for details on the format.
‘--initialization’
‘-i’ By default, ‘--trace’ does not trace the initialization of the Autoconf macros
(typically the AC_DEFUN definitions). This results in a noticeable speedup, but
can be disabled by this option.
It is often necessary to check the content of a ‘configure.ac’ file, but parsing it yourself
is extremely fragile and error-prone. It is suggested that you rely upon ‘--trace’ to scan
‘configure.ac’. For instance, to find the list of variables that are substituted, use:
$ autoconf -t AC_SUBST
configure.ac:2:AC_SUBST:ECHO_C
configure.ac:2:AC_SUBST:ECHO_N
configure.ac:2:AC_SUBST:ECHO_T
More traces deleted
The example below highlights the difference between ‘$@’, ‘$*’, and ‘$%’.
$ cat configure.ac
AC_DEFINE(This, is, [an
[example]])
$ autoconf -t ’AC_DEFINE:@: $@
*: $*
%: $%’
@: [This],[is],[an
[example]]
*: This,is,an
[example]
%: This:is:an [example]
The format gives you a lot of freedom:
$ autoconf -t ’AC_SUBST:$$ac_subst{"$1"} = "$f:$l";’
$ac_subst{"ECHO_C"} = "configure.ac:2";
$ac_subst{"ECHO_N"} = "configure.ac:2";
$ac_subst{"ECHO_T"} = "configure.ac:2";
More traces deleted
A long separator can be used to improve the readability of complex structures, and to ease
their parsing (for instance when no single character is suitable as a separator):
$ autoconf -t ’AM_MISSING_PROG:${|:::::|}*’
ACLOCAL|:::::|aclocal|:::::|$missing_dir
AUTOCONF|:::::|autoconf|:::::|$missing_dir
AUTOMAKE|:::::|automake|:::::|$missing_dir
More traces deleted
Chapter 3: Making configure Scripts 13
‘--no-recursive’
Do not rebuild files in subdirectories to configure (see Section 4.12 [Subdirec-
tories], page 35, macro AC_CONFIG_SUBDIRS).
‘--symlink’
‘-s’ When used with ‘--install’, install symbolic links to the missing auxiliary
files instead of copying them.
‘--make’
‘-m’ When the directories were configured, update the configuration by running
‘./config.status --recheck && ./config.status’, and then run ‘make’.
‘--include=dir ’
‘-I dir ’ Append dir to the include path. Multiple invocations accumulate. Passed on
to autoconf and autoheader internally.
‘--prepend-include=dir ’
‘-B dir ’ Prepend dir to the include path. Multiple invocations accumulate. Passed on
to autoconf and autoheader internally.
‘--warnings=category ’
‘-W category ’
Report the warnings related to category (which can actually be a comma sep-
arated list).
‘cross’ related to cross compilation issues.
‘obsolete’
report the uses of obsolete constructs.
‘portability’
portability issues
‘syntax’ dubious syntactic constructs.
‘all’ report all the warnings
‘none’ report none
‘error’ treats warnings as errors
‘no-category ’
disable warnings falling into category
Warnings about ‘syntax’ are enabled by default, and the environment
variable WARNINGS, a comma separated list of categories, is honored as well.
Passing ‘-W category ’ actually behaves as if you had passed ‘--warnings
syntax,$WARNINGS,category ’. If you want to disable the defaults and
WARNINGS, but (for example) enable the warnings about obsolete constructs,
you would use ‘-W none,obsolete’.
If you want autoreconf to pass flags that are not listed here on to aclocal, set ACLOCAL_
AMFLAGS in your ‘Makefile.am’. Due to a limitation in the Autoconf implementation these
flags currently must be set on a single line in ‘Makefile.am’, without any backslash-newlines.
Chapter 4: Initialization and Output Files 15
Autoconf-generated configure scripts need some information about how to initialize, such
as how to find the package’s source files and about the output files to produce. The following
sections describe the initialization and the creation of output files.
AC_PACKAGE_NAME, PACKAGE_NAME
Exactly package.
AC_PACKAGE_TARNAME, PACKAGE_TARNAME
Exactly tarname.
AC_PACKAGE_VERSION, PACKAGE_VERSION
Exactly version.
AC_PACKAGE_STRING, PACKAGE_STRING
Exactly ‘package version ’.
AC_PACKAGE_BUGREPORT, PACKAGE_BUGREPORT
Exactly bug-report.
If your configure script does its own option processing, it should inspect ‘$@’ or ‘$*’
immediately after calling AC_INIT, because other Autoconf macros liberally use the set
command to process strings, and this has the side effect of updating ‘$@’ and ‘$*’. However,
we suggest that you use standard macros like AC_ARG_ENABLE instead of attempting to
implement your own option processing. See Chapter 14 [Site Configuration], page 223.
16 Autoconf
AC_AUTOCONF_VERSION [Macro]
This macro was introduced in Autoconf 2.62. It identifies the version of Autoconf that
is currently parsing the input file, in a format suitable for m4_version_compare (see
[m4 version compare], page 138); in other words, for this release of Autoconf, its value
is ‘2.62’. One potential use of this macro is for writing conditional fallbacks based on
when a feature was added to Autoconf, rather than using AC_PREREQ to require the
newer version of Autoconf. However, remember that the Autoconf philosophy favors
feature checks over version checks.
Packages that do manual configuration or use the install program might need to tell
configure where to find some other shell scripts by calling AC_CONFIG_AUX_DIR, though
the default places it looks are correct for most cases.
Similarly, packages that use aclocal should declare where local macros can be found
using AC_CONFIG_MACRO_DIR.
ac_srcdir
The name of the corresponding source directory, assuming that the
working directory is the current build directory.
The current directory refers to the directory (or pseudo-directory) containing
the input part of tags. For instance, running
AC_CONFIG_COMMANDS([deep/dir/out:in/in.in], [...], [...])
with ‘--srcdir=../package’ produces the following values:
# Argument of --srcdir
srcdir=’../package’
# Reversing deep/dir
ac_top_build_prefix=’../../’
# Concatenation of $ac_top_build_prefix and srcdir
ac_top_srcdir=’../../../package’
# Concatenation of $ac_top_srcdir and deep/dir
ac_srcdir=’../../../package/deep/dir’
independently of ‘in/in.in’.
init-cmds Shell commands output unquoted near the beginning of ‘config.status’, and
executed each time ‘config.status’ runs (regardless of the tag). Because they
are unquoted, for example, ‘$var’ is output as the value of var. init-cmds is
typically used by ‘configure’ to give ‘config.status’ some variables it needs
to run the commands.
You should be extremely cautious in your variable names: all the init-cmds
share the same name space and may overwrite each other in unpredictable
ways. Sorry. . .
All these macros can be called multiple times, with different tag values, of course!
[lib/Makefile:boiler/lib.mk])
Doing this allows you to keep your file names acceptable to DOS variants, or to
prepend and/or append boilerplate to the file.
CFLAGS [Variable]
Debugging and optimization options for the C compiler. If it is not set in the envi-
ronment when configure runs, the default value is set when you call AC_PROG_CC (or
empty if you don’t). configure uses this variable when compiling or linking programs
to test for C features.
If a compiler option affects only the behavior of the preprocessor (e.g., ‘-D name ’), it
should be put into CPPFLAGS instead. If it affects only the linker (e.g., ‘-L direc-
tory ’), it should be put into LDFLAGS instead. If it affects only the compiler proper,
CFLAGS is the natural home for it. If an option affects multiple phases of the compiler,
though, matters get tricky. One approach to put such options directly into CC, e.g.,
CC=’gcc -m64’. Another is to put them into both CPPFLAGS and LDFLAGS, but not
into CFLAGS.
configure_input [Variable]
A comment saying that the file was generated automatically by configure and giving
the name of the input file. AC_OUTPUT adds a comment line containing this variable to
the top of every makefile it creates. For other files, you should reference this variable
22 Autoconf
in a comment at the top of each input file. For example, an input shell script should
begin like this:
#!/bin/sh
# @configure_input@
The presence of that line also reminds people editing the file that it needs to be
processed by configure in order to be used.
CPPFLAGS [Variable]
Preprocessor options for the C, C++, and Objective C preprocessors and compilers.
If it is not set in the environment when configure runs, the default value is empty.
configure uses this variable when preprocessing or compiling programs to test for
C, C++, and Objective C features.
This variable’s contents should contain options like ‘-I’, ‘-D’, and ‘-U’ that affect only
the behavior of the preprocessor. Please see the explanation of CFLAGS for what you
can do if an option affects other phases of the compiler as well.
Currently, configure always links as part of a single invocation of the compiler that
also preprocesses and compiles, so it uses this variable also when linking programs.
However, it is unwise to depend on this behavior because the GNU coding standards
do not require it and many packages do not use CPPFLAGS when linking programs.
See Section 7.3 [Special Chars in Variables], page 104, for limitations that CPPFLAGS
might run into.
CXXFLAGS [Variable]
Debugging and optimization options for the C++ compiler. It acts like CFLAGS, but
for C++ instead of C.
DEFS [Variable]
‘-D’ options to pass to the C compiler. If AC_CONFIG_HEADERS is called, configure
replaces ‘@DEFS@’ with ‘-DHAVE_CONFIG_H’ instead (see Section 4.9 [Configuration
Headers], page 30). This variable is not defined while configure is performing its
tests, only when creating the output files. See Section 7.2 [Setting Output Variables],
page 102, for how to check the results of previous tests.
ECHO_C [Variable]
ECHO_N [Variable]
ECHO_T [Variable]
How does one suppress the trailing newline from echo for question-answer message
pairs? These variables provide a way:
echo $ECHO_N "And the winner is... $ECHO_C"
sleep 100000000000
echo "${ECHO_T}dead."
Some old and uncommon echo implementations offer no means to achieve this, in
which case ECHO_T is set to tab. You might not want to use it.
ERLCFLAGS [Variable]
Debugging and optimization options for the Erlang compiler. If it is not set in the
environment when configure runs, the default value is empty. configure uses this
variable when compiling programs to test for Erlang features.
Chapter 4: Initialization and Output Files 23
FCFLAGS [Variable]
Debugging and optimization options for the Fortran compiler. If it is not set in the
environment when configure runs, the default value is set when you call AC_PROG_
FC (or empty if you don’t). configure uses this variable when compiling or linking
programs to test for Fortran features.
FFLAGS [Variable]
Debugging and optimization options for the Fortran 77 compiler. If it is not set in the
environment when configure runs, the default value is set when you call AC_PROG_
F77 (or empty if you don’t). configure uses this variable when compiling or linking
programs to test for Fortran 77 features.
LDFLAGS [Variable]
Options for the linker. If it is not set in the environment when configure runs, the
default value is empty. configure uses this variable when linking programs to test
for C, C++, Objective C, and Fortran features.
This variable’s contents should contain options like ‘-s’ and ‘-L’ that affect only the
behavior of the linker. Please see the explanation of CFLAGS for what you can do if
an option also affects other phases of the compiler.
Don’t use this variable to pass library names (‘-l’) to the linker; use LIBS instead.
LIBS [Variable]
‘-l’ options to pass to the linker. The default value is empty, but some Autoconf
macros may prepend extra libraries to this variable if those libraries are found and
provide necessary functions, see Section 5.4 [Libraries], page 44. configure uses this
variable when linking programs to test for C, C++, and Fortran features.
OBJCFLAGS [Variable]
Debugging and optimization options for the Objective C compiler. It acts like CFLAGS,
but for Objective C instead of C.
builddir [Variable]
Rigorously equal to ‘.’. Added for symmetry only.
abs_builddir [Variable]
Absolute name of builddir.
top_builddir [Variable]
The relative name of the top level of the current build tree. In the top-level directory,
this is the same as builddir.
top_build_prefix [Variable]
The relative name of the top level of the current build tree with final slash if nonemtpy.
This is the same as top_builddir, except that it contains of zero of more runs of
../, so it should not be appended with a slash for concatenation. This helps for
make implementations that otherwise do not treat ‘./file’ and ‘file’ as equal in the
toplevel build directory.
abs_top_builddir [Variable]
Absolute name of top_builddir.
24 Autoconf
srcdir [Variable]
The name of the directory that contains the source code for that makefile.
abs_srcdir [Variable]
Absolute name of srcdir.
top_srcdir [Variable]
The name of the top-level source code directory for the package. In the top-level
directory, this is the same as srcdir.
abs_top_srcdir [Variable]
Absolute name of top_srcdir.
libexecdir [Variable]
The directory for installing executables that other programs run.
localedir [Variable]
The directory for installing locale-dependent but architecture-independent data, such
as message catalogs. This directory usually has a subdirectory per locale.
localstatedir [Variable]
The directory for installing modifiable single-machine data.
mandir [Variable]
The top-level directory for installing documentation in man format.
oldincludedir [Variable]
The directory for installing C header files for non-GCC compilers.
pdfdir [Variable]
The directory for installing PDF documentation.
prefix [Variable]
The common installation prefix for all files. If exec prefix is defined to a different
value, prefix is used only for architecture-independent files.
psdir [Variable]
The directory for installing PostScript documentation.
sbindir [Variable]
The directory for installing executables that system administrators run.
sharedstatedir [Variable]
The directory for installing modifiable architecture-independent data.
sysconfdir [Variable]
The directory for installing read-only single-machine data.
Most of these variables have values that rely on prefix or exec_prefix. It is deliberate
that the directory output variables keep them unexpanded: typically ‘@datarootdir@’ is
replaced by ‘${prefix}/share’, not ‘/usr/local/share’, and ‘@datadir@’ is replaced by
‘${datarootdir}’.
This behavior is mandated by the GNU coding standards, so that when the user runs:
‘make’ she can still specify a different prefix from the one specified to configure, in
which case, if needed, the package should hard code dependencies corresponding
to the make-specified prefix.
‘make install’
she can specify a different installation location, in which case the package must
still depend on the location which was compiled in (i.e., never recompile when
‘make install’ is run). This is an extremely important feature, as many people
may decide to install all the files of a package grouped together, and then install
links from the final locations to there.
26 Autoconf
In order to support these features, it is essential that datarootdir remains being defined
as ‘${prefix}/share’ to depend upon the current value of prefix.
A corollary is that you should not use these variables except in makefiles. For instance, in-
stead of trying to evaluate datadir in ‘configure’ and hard-coding it in makefiles using e.g.,
‘AC_DEFINE_UNQUOTED([DATADIR], ["$datadir"], [Data directory.])’, you should add
‘-DDATADIR=’$(datadir)’’ to your makefile’s definition of CPPFLAGS (AM_CPPFLAGS if you
are also using Automake).
Similarly, you should not rely on AC_CONFIG_FILES to replace datadir and friends in
your shell scripts and other files; instead, let make manage their replacement. For instance
Autoconf ships templates of its shell scripts ending with ‘.in’, and uses a makefile snippet
similar to the following to build scripts like autoheader and autom4te:
edit = sed \
-e ’s|@datadir[@]|$(pkgdatadir)|g’ \
-e ’s|@prefix[@]|$(prefix)|g’
autoheader: $(srcdir)/autoheader.in
autom4te: $(srcdir)/autom4te.in
Some details are noteworthy:
‘@datadir[@]’
The brackets prevent configure from replacing ‘@datadir@’ in the Sed expres-
sion itself. Brackets are preferable to a backslash here, since Posix says ‘\@’ is
not portable.
‘$(pkgdatadir)’
Don’t use ‘@pkgdatadir@’! Use the matching makefile variable instead.
‘/’ Don’t use ‘/’ in the Sed expressions that replace file names since most likely the
variables you use, such as ‘$(pkgdatadir)’, contain ‘/’. Use a shell metachar-
acter instead, such as ‘|’.
special characters
File names, file name components, and the value of VPATH should not contain
shell metacharacters or white space. See Section 7.3 [Special Chars in Variables],
page 104.
dependency on ‘Makefile’
Since edit uses values that depend on the configuration specific values (prefix,
etc.) and not only on VERSION and so forth, the output depends on ‘Makefile’,
not ‘configure.ac’.
‘$@’ The main rule is generic, and uses ‘$@’ extensively to avoid the need for multiple
copies of the rule.
Chapter 4: Initialization and Output Files 27
ERLANG_INSTALL_LIB_DIR [Variable]
The common parent directory of Erlang library installation directories. This variable
is set by calling the AC_ERLANG_SUBST_INSTALL_LIB_DIR macro in ‘configure.ac’.
ERLANG_INSTALL_LIB_DIR_library [Variable]
The installation directory for Erlang library library. This variable is set by
calling the ‘AC_ERLANG_SUBST_INSTALL_LIB_SUBDIR(library, version ’ macro in
‘configure.ac’.
$ autoconf
$ configure
configure: creating ./config.status
config.status: creating Makefile
config.status: WARNING:
Makefile.in seems to ignore the --datarootdir setting
$ cat Makefile
prefix = /usr/local
datadir = ${prefix}/share
Usually one can easily change the file to accommodate both older and newer Autoconf
releases:
$ cat Makefile.in
prefix = @prefix@
datarootdir = @datarootdir@
datadir = @datadir@
$ configure
configure: creating ./config.status
config.status: creating Makefile
$ cat Makefile
prefix = /usr/local
datarootdir = ${prefix}/share
datadir = ${datarootdir}
In some cases, however, the checks may not be able to detect that a suitable initialization
of datarootdir is in place, or they may fail to detect that such an initialization is necessary
in the output file. If, after auditing your package, there are still spurious ‘configure’
warnings about datarootdir, you may add the line
AC_DEFUN([AC_DATAROOTDIR_CHECKED])
to your ‘configure.ac’ to disable the warnings. This is an exception to the usual rule that
you should not define a macro whose name begins with AC_ (see Section 9.2 [Macro Names],
page 143).
configure substitutes the correct value for srcdir when it produces ‘Makefile’.
Do not use the make variable $<, which expands to the file name of the file in the source
directory (found with VPATH), except in implicit rules. (An implicit rule is one such as
‘.c.o’, which tells how to create a ‘.o’ file from a ‘.c’ file.) Some versions of make do not
set $< in explicit rules; they expand it to an empty value.
Instead, Make command lines should always refer to source files by prefixing them with
‘$(srcdir)/’. For example:
time.info: time.texinfo
$(MAKEINFO) ’$(srcdir)/time.texinfo’
config.h: stamp-h
stamp-h: config.h.in config.status
./config.status
config.status: configure
./config.status --recheck
(Be careful if you copy these lines directly into your makefile, as you need to convert the
indented lines to start with the tab character.)
In addition, you should use
30 Autoconf
See Section 4.6 [Configuration Actions], page 18, for more details on header.
#ifdef HAVE_UNISTD_H
# include <unistd.h>
#else
/* We are in trouble. */
#endif
The use of old form templates, with ‘#define’ instead of ‘#undef’ is strongly discouraged.
Similarly with old templates with comments on the same line as the ‘#undef’. Anyway,
putting comments in preprocessor macros has never been a good idea.
Since it is a tedious task to keep a template header up to date, you may use autoheader
to generate it, see Section 4.9.2 [autoheader Invocation], page 31.
You might wonder why autoheader is needed: after all, why would configure need
to “patch” a ‘config.h.in’ to produce a ‘config.h’ instead of just creating ‘config.h’
from scratch? Well, when everything rocks, the answer is just that we are wasting our time
maintaining autoheader: generating ‘config.h’ directly is all that is needed. When things
go wrong, however, you’ll be thankful for the existence of autoheader.
The fact that the symbols are documented is important in order to check that ‘config.h’
makes sense. The fact that there is a well-defined list of symbols that should be defined
(or not) is also important for people who are porting packages to environments where
configure cannot be run: they just have to fill in the blanks.
But let’s come back to the point: the invocation of autoheader. . .
If you give autoheader an argument, it uses that file instead of ‘configure.ac’ and
writes the header file to the standard output instead of to ‘config.h.in’. If you give
autoheader an argument of ‘-’, it reads the standard input instead of ‘configure.ac’ and
writes the header file to the standard output.
autoheader accepts the following options:
‘--help’
‘-h’ Print a summary of the command line options and exit.
‘--version’
‘-V’ Print the version number of Autoconf and exit.
‘--verbose’
‘-v’ Report processing steps.
‘--debug’
‘-d’ Don’t remove the temporary files.
‘--force’
‘-f’ Remake the template file even if newer than its input files.
‘--include=dir ’
‘-I dir ’ Append dir to the include path. Multiple invocations accumulate.
‘--prepend-include=dir ’
‘-B dir ’ Prepend dir to the include path. Multiple invocations accumulate.
‘--warnings=category ’
‘-W category ’
Report the warnings related to category (which can actually be a comma sep-
arated list). Current categories include:
‘obsolete’
report the uses of obsolete constructs
‘all’ report all the warnings
‘none’ report none
‘error’ treats warnings as errors
‘no-category ’
disable warnings falling into category
Chapter 4: Initialization and Output Files 33
Please note that text gets included “verbatim” to the template file, not to the resulting
config header, so it can easily get mangled when the template is processed. There is rarely
a need for something other than
AH_BOTTOM([#include <custom.h>])
It may be convenient for users to have configure guess the installation prefix from the
location of a related program that they have already installed. If you wish to do that, you
can call AC_PREFIX_PROGRAM.
5 Existing Tests
These macros test for particular system features that packages might need or want to use. If
you need to test for a kind of feature that none of these macros check for, you can probably
do it by calling primitive test macros with appropriate arguments (see Chapter 6 [Writing
Tests], page 89).
These tests print messages telling the user which feature they’re checking for, and what
they find. They cache their results for future configure runs (see Section 7.4 [Caching
Results], page 105).
Some of these macros set output variables. See Section 4.8 [Makefile Substitutions],
page 21, for how to get their values. The phrase “define name” is used below as a shorthand
to mean “define the C preprocessor symbol name to the value 1”. See Section 7.1 [Defining
Symbols], page 101, for how to get those symbol definitions into your program.
Most generic macros use the following macro to provide the default set of includes:
AC_PROG_MKDIR_P [Macro]
Set output variable MKDIR_P to a program that ensures that for each argument, a
directory named by this argument exists, creating it and its parent directories if
needed, and without race conditions when two instances of the program attempt to
make the same directory at nearly the same time.
This macro uses the ‘mkdir -p’ command if possible. Otherwise, it falls back on invok-
ing install-sh with the ‘-d’ option, so your package should contain ‘install-sh’ as
described under AC_PROG_INSTALL. An ‘install-sh’ file that predates Autoconf 2.60
or Automake 1.10 is vulnerable to race conditions, so if you want to support parallel
installs from different packages into the same directory you need to make sure you
have an up-to-date ‘install-sh’. In particular, be careful about using ‘autoreconf
-if’ if your Automake predates Automake 1.10.
This macro is related to the AS_MKDIR_P macro (see Section 8.4 [Programming in
M4sh], page 139), but it sets an output variable intended for use in other files, whereas
AS_MKDIR_P is intended for use in scripts like configure. Also, AS_MKDIR_P does not
accept options, but MKDIR_P supports the ‘-m’ option, e.g., a makefile might invoke
$(MKDIR_P) -m 0 dir to create an inaccessible directory, and conversely a makefile
should use $(MKDIR_P) -- $(FOO) if FOO might yield a value that begins with ‘-’.
Finally, AS_MKDIR_P does not check for race condition vulnerability, whereas AC_
PROG_MKDIR_P does.
‘@MKDIR_P@’ is special, as its value may vary for different configuration files.
AC_PROG_LEX [Macro]
If flex is found, set output variable LEX to ‘flex’ and LEXLIB to ‘-lfl’, if that library
is in a standard place. Otherwise set LEX to ‘lex’ and LEXLIB to ‘-ll’.
Define YYTEXT_POINTER if yytext defaults to ‘char *’ instead of to ‘char []’. Also set
output variable LEX_OUTPUT_ROOT to the base of the file name that the lexer generates;
usually ‘lex.yy’, but sometimes something else. These results vary according to
whether lex or flex is being used.
You are encouraged to use Flex in your sources, since it is both more pleasant to use
than plain Lex and the C source it produces is portable. In order to ensure portability,
however, you must either provide a function yywrap or, if you don’t use it (e.g., your
scanner has no ‘#include’-like feature), simply include a ‘%noyywrap’ statement in
the scanner’s source. Once this done, the scanner is portable (unless you felt free to
use nonportable constructs) and does not depend on any library. In this case, and in
this case only, it is suggested that you use this Autoconf snippet:
AC_PROG_LEX
Chapter 5: Existing Tests 41
AC_PROG_LN_S [Macro]
If ‘ln -s’ works on the current file system (the operating system and file system
support symbolic links), set the output variable LN_S to ‘ln -s’; otherwise, if ‘ln’
works, set LN_S to ‘ln’, and otherwise set it to ‘cp -p’.
If you make a link in a directory other than the current directory, its meaning depends
on whether ‘ln’ or ‘ln -s’ is used. To safely create links using ‘$(LN_S)’, either find
out which form is used and adjust the arguments, or always invoke ln in the directory
where the link is to be created.
In other words, it does not work to do:
$(LN_S) foo /x/bar
Instead, do:
(cd /x && $(LN_S) foo bar)
AC_PROG_RANLIB [Macro]
Set output variable RANLIB to ‘ranlib’ if ranlib is found, and otherwise to ‘:’ (do
nothing).
AC_PROG_SED [Macro]
Set output variable SED to a Sed implementation that conforms to Posix and does
not have arbitrary length limits. Report an error if no acceptable Sed is found. See
Section 10.13 [Limitations of Usual Tools], page 180, for more information about
portability problems with Sed.
AC_PROG_YACC [Macro]
If bison is found, set output variable YACC to ‘bison -y’. Otherwise, if byacc is
found, set YACC to ‘byacc’. Otherwise set YACC to ‘yacc’.
particular, variable is not set to the final value of ac_cv_path_variable , nor is AC_
SUBST automatically run. Also, on failure, any action can be performed, whereas
AC_CHECK_PROGS only performs variable =value-if-not-found .
Here is an example, similar to what Autoconf uses in its own configure script. It will
search for an implementation of m4 that supports the indir builtin, even if it goes by
the name gm4 or is not the first implementation on PATH.
AC_CACHE_CHECK([for m4 that supports indir], [ac_cv_path_M4],
[AC_PATH_PROGS_FEATURE_CHECK([M4], [m4 gm4],
[[m4out=‘echo ’changequote([,])indir([divnum])’ | $ac_path_M4‘
test "x$m4out" = x0 \
&& ac_cv_path_M4=$ac_path_M4 ac_path_M4_found=:]],
[AC_MSG_ERROR([could not find m4 that supports indir])])])
AC_SUBST([M4], [$ac_cv_path_M4])
AC_PATH_TARGET_TOOL (variable, prog-to-check-for, [Macro]
[value-if-not-found ], [path = ‘$PATH’])
Like AC_CHECK_TARGET_TOOL, but set variable to the absolute name of the program
if it is found.
AC_PATH_TOOL (variable, prog-to-check-for, [Macro]
[value-if-not-found ], [path = ‘$PATH’])
Like AC_CHECK_TOOL, but set variable to the absolute name of the program if it is
found.
In the future, when cross-compiling this macro will not accept program names that
are not prefixed with the host type.
5.3 Files
You might also need to check for the existence of files. Before using these macros, ask
yourself whether a runtime test might not be a better solution. Be aware that, like most
Autoconf macros, they test a feature of the host machine, and therefore, they die when
cross-compiling.
AC_CHECK_FILE (file, [action-if-found ], [action-if-not-found ]) [Macro]
Check whether file file exists on the native system. If it is found, execute action-if-
found, otherwise do action-if-not-found, if given.
AC_CHECK_FILES (files, [action-if-found ], [action-if-not-found ]) [Macro]
Executes AC_CHECK_FILE once for each file listed in files. Additionally, defines
‘HAVE_file ’ (see Section 5.1.1 [Standard Symbols], page 37) for each file found.
the library. Use the base name of the library; e.g., to check for ‘-lmp’, use ‘mp’ as the
library argument.
action-if-found is a list of shell commands to run if the link with the library succeeds;
action-if-not-found is a list of shell commands to run if the link fails. If action-if-
found is not specified, the default action prepends ‘-llibrary ’ to LIBS and defines
‘HAVE_LIBlibrary ’ (in all capitals). This macro is intended to support building
LIBS in a right-to-left (least-dependent to most-dependent) fashion such that library
dependencies are satisfied as a natural side effect of consecutive tests. Linkers are
sensitive to library ordering so the order in which LIBS is generated is important to
reliable detection of libraries.
If linking with library results in unresolved symbols that would be resolved by linking
with additional libraries, give those libraries as the other-libraries argument, separated
by spaces: e.g., ‘-lXt -lX11’. Otherwise, this macro fails to detect that library is
present, because linking the test program always fails with unresolved symbols. The
other-libraries argument should be limited to cases where it is desirable to test for
one library in the presence of another that is not already in LIBS.
AC_CHECK_LIB requires some care in usage, and should be avoided in some common
cases. Many standard functions like gethostbyname appear in the standard C library
on some hosts, and in special libraries like nsl on other hosts. On some hosts the
special libraries contain variant implementations that you may not want to use. These
days it is normally better to use AC_SEARCH_LIBS([gethostbyname], [nsl]) instead
of AC_CHECK_LIB([nsl], [gethostbyname]).
exit On ancient hosts, exit returned int. This is because exit predates void, and
there was a long tradition of it returning int.
On current hosts, the problem more likely is that exit is not declared, due to
C++ problems of some sort or another. For this reason we suggest that test
programs not invoke exit, but return from main instead.
free The C standard says a call free (NULL) does nothing, but some old systems
don’t support this (e.g., NextStep).
isinf
isnan The C99 standard says that isinf and isnan are macros. On some systems
just macros are available (e.g., HP-UX and Solaris 10), on some systems both
macros and functions (e.g., glibc 2.3.2), and on some systems only functions
(e.g., IRIX 6 and Solaris 9). In some cases these functions are declared in
nonstandard headers like <sunmath.h> and defined in non-default libraries like
‘-lm’ or ‘-lsunmath’.
The C99 isinf and isnan macros work correctly with long double arguments,
but pre-C99 systems that use functions typically assume double arguments. On
such a system, isinf incorrectly returns true for a finite long double argument
that is outside the range of double.
To work around this porting mess, you can use code like the following.
#include <math.h>
#ifndef isnan
# define isnan(x) \
(sizeof (x) == sizeof (long double) ? isnan_ld (x) \
: sizeof (x) == sizeof (double) ? isnan_d (x) \
: isnan_f (x))
static inline int isnan_f (float x) { return x != x; }
static inline int isnan_d (double x) { return x != x; }
static inline int isnan_ld (long double x) { return x != x; }
#endif
#ifndef isinf
# define isinf(x) \
(sizeof (x) == sizeof (long double) ? isinf_ld (x) \
: sizeof (x) == sizeof (double) ? isinf_d (x) \
: isinf_f (x))
static inline int isinf_f (float x) { return isnan (x - x); }
static inline int isinf_d (double x) { return isnan (x - x); }
static inline int isinf_ld (long double x) { return isnan (x - x); }
#endif
Use AC_C_INLINE (see Section 5.10.3 [C Compiler], page 72) so that this code
works on compilers that lack the inline keyword. Some optimizing compilers
mishandle these definitions, but systems with that bug typically have missing
or broken isnan functions anyway, so it’s probably not worth worrying about.
malloc The C standard says a call malloc (0) is implementation dependent. It can
return either NULL or a new non-null pointer. The latter is more common (e.g.,
the GNU C Library) but is by no means universal. AC_FUNC_MALLOC can be
used to insist on non-NULL (see Section 5.5.2 [Particular Functions], page 48).
Chapter 5: Existing Tests 47
putenv Posix prefers setenv to putenv; among other things, putenv is not required of
all Posix implementations, but setenv is.
Posix specifies that putenv puts the given string directly in environ, but some
systems make a copy of it instead (e.g., glibc 2.0, or BSD). And when a copy is
made, unsetenv might not free it, causing a memory leak (e.g., FreeBSD 4).
On some systems putenv ("FOO") removes ‘FOO’ from the environment, but
this is not standard usage and it dumps core on some systems (e.g., AIX).
On MinGW, a call putenv ("FOO=") removes ‘FOO’ from the environment,
rather than inserting it with an empty value.
realloc The C standard says a call realloc (NULL, size) is equivalent to malloc
(size), but some old systems don’t support this (e.g., NextStep).
signal handler
Normally signal takes a handler function with a return type of void, but some
old systems required int instead. Any actual int value returned is not used;
this is only a difference in the function prototype demanded.
All systems we know of in current use return void. The int was to support
K&R C, where of course void is not available. AC_TYPE_SIGNAL (see Sec-
tion 5.9.1 [Particular Types], page 67) can be used to establish the correct type
in all cases.
snprintf The C99 standard says that if the output array isn’t big enough and if no other
errors occur, snprintf and vsnprintf truncate the output and return the
number of bytes that ought to have been produced. Some older systems return
the truncated length (e.g., GNU C Library 2.0.x or irix 6.5), some a negative
value (e.g., earlier GNU C Library versions), and some the buffer length without
truncation (e.g., 32-bit Solaris 7). Also, some buggy older systems ignore the
length and overrun the buffer (e.g., 64-bit Solaris 7).
sprintf The C standard says sprintf and vsprintf return the number of bytes written.
On some ancient systems (SunOS 4 for instance) they return the buffer pointer
instead, but these no longer need to be worried about.
sscanf On various old systems, e.g., HP-UX 9, sscanf requires that its input string
be writable (though it doesn’t actually change it). This can be a problem
when using gcc since it normally puts constant strings in read-only memory
(see section “Incompatibilities” in Using and Porting the GNU Compiler Col-
lection). Apparently in some cases even having format strings read-only can be
a problem.
strerror_r
Posix specifies that strerror_r returns an int, but many systems (e.g., GNU C
Library version 2.2.4) provide a different version returning a char *. AC_FUNC_
STRERROR_R can detect which is in use (see Section 5.5.2 [Particular Functions],
page 48).
strnlen AIX 4.3 provides a broken version which produces the following results:
strnlen ("foobar", 0) = 0
strnlen ("foobar", 1) = 3
48 Autoconf
strnlen ("foobar", 2) = 2
strnlen ("foobar", 3) = 1
strnlen ("foobar", 4) = 0
strnlen ("foobar", 5) = 6
strnlen ("foobar", 6) = 6
strnlen ("foobar", 7) = 6
strnlen ("foobar", 8) = 6
strnlen ("foobar", 9) = 6
sysconf _SC_PAGESIZE is standard, but some older systems (e.g., HP-UX 9) have _SC_
PAGE_SIZE instead. This can be tested with #ifdef.
unlink The Posix spec says that unlink causes the given file to be removed only after
there are no more open file handles for it. Some non-Posix hosts have trouble
with this requirement, though, and some DOS variants even corrupt the file
system.
unsetenv On MinGW, unsetenv is not available, but a variable ‘FOO’ can be removed
with a call putenv ("FOO="), as described under putenv above.
va_copy The C99 standard provides va_copy for copying va_list variables. It may be
available in older environments too, though possibly as __va_copy (e.g., gcc in
strict pre-C99 mode). These can be tested with #ifdef. A fallback to memcpy
(&dst, &src, sizeof (va_list)) gives maximum portability.
va_list va_list is not necessarily just a pointer. It can be a struct (e.g., gcc on
Alpha), which means NULL is not portable. Or it can be an array (e.g., gcc in
some PowerPC configurations), which means as a function parameter it can be
effectively call-by-reference and library routines might modify the value back
in the caller (e.g., vsnprintf in the GNU C Library 2.1).
Signed >> Normally the C >> right shift of a signed type replicates the high bit, giving a
so-called “arithmetic” shift. But care should be taken since Standard C doesn’t
require that behavior. On those few processors without a native arithmetic
shift (for instance Cray vector systems) zero bits may be shifted in, the same
as a shift of an unsigned type.
Integer / C divides signed integers by truncating their quotient toward zero, yielding the
same result as Fortran. However, before C99 the standard allowed C imple-
mentations to take the floor or ceiling of the quotient in some cases. Hardly
any implementations took advantage of this freedom, though, and it’s probably
not worth worrying about this issue nowadays.
AC_FUNC_ALLOCA [Macro]
Check how to get alloca. Tries to get a builtin version by checking for ‘alloca.h’
or the predefined C preprocessor macros __GNUC__ and _AIX. If this macro finds
‘alloca.h’, it defines HAVE_ALLOCA_H.
Chapter 5: Existing Tests 49
If those attempts fail, it looks for the function in the standard C library. If any
of those methods succeed, it defines HAVE_ALLOCA. Otherwise, it sets the output
variable ALLOCA to ‘${LIBOBJDIR}alloca.o’ and defines C_ALLOCA (so programs can
periodically call ‘alloca (0)’ to garbage collect). This variable is separate from
LIBOBJS so multiple programs can share the value of ALLOCA without needing to
create an actual library, in case only some of them use the code in LIBOBJS. The
‘${LIBOBJDIR}’ prefix serves the same purpose as in LIBOBJS (see Section 17.6.4
[AC LIBOBJ vs LIBOBJS], page 259).
This macro does not try to get alloca from the System V R3 ‘libPW’ or the System
V R4 ‘libucb’ because those libraries contain some incompatible functions that cause
trouble. Some versions do not even contain alloca or contain a buggy version. If
you still want to use their alloca, use ar to extract ‘alloca.o’ from them instead of
compiling ‘alloca.c’.
Source files that use alloca should start with a piece of code like the following, to
declare it properly.
#ifdef HAVE_ALLOCA_H
# include <alloca.h>
#elif defined __GNUC__
# define alloca __builtin_alloca
#elif defined _AIX
# define alloca __alloca
#elif defined _MSC_VER
# include <malloc.h>
# define alloca _alloca
#else
# include <stddef.h>
# ifdef __cplusplus
extern "C"
# endif
void *alloca (size_t);
#endif
AC_FUNC_CHOWN [Macro]
If the chown function is available and works (in particular, it should accept ‘-1’ for
uid and gid), define HAVE_CHOWN.
AC_FUNC_CLOSEDIR_VOID [Macro]
If the closedir function does not return a meaningful value, define CLOSEDIR_VOID.
Otherwise, callers ought to check its return value for an error indicator.
Currently this test is implemented by running a test program. When cross compiling
the pessimistic assumption that closedir does not return a meaningful value is made.
This macro is obsolescent, as closedir returns a meaningful value on current systems.
New programs need not use this macro.
AC_FUNC_ERROR_AT_LINE [Macro]
If the error_at_line function is not found, require an AC_LIBOBJ replacement of
‘error’.
50 Autoconf
AC_FUNC_FNMATCH [Macro]
If the fnmatch function conforms to Posix, define HAVE_FNMATCH. Detect common
implementation bugs, for example, the bugs in Solaris 2.4.
Unlike the other specific AC_FUNC macros, AC_FUNC_FNMATCH does not replace a bro-
ken/missing fnmatch. This is for historical reasons. See AC_REPLACE_FNMATCH below.
This macro is obsolescent. New programs should use Gnulib’s fnmatch-posix mod-
ule. See Section 2.2 [Gnulib], page 3.
AC_FUNC_FNMATCH_GNU [Macro]
Behave like AC_REPLACE_FNMATCH (replace) but also test whether fnmatch supports
GNU extensions. Detect common implementation bugs, for example, the bugs in the
GNU C Library 2.1.
This macro is obsolescent. New programs should use Gnulib’s fnmatch-gnu module.
See Section 2.2 [Gnulib], page 3.
AC_FUNC_FORK [Macro]
This macro checks for the fork and vfork functions. If a working fork is found,
define HAVE_WORKING_FORK. This macro checks whether fork is just a stub by trying
to run it.
If ‘vfork.h’ is found, define HAVE_VFORK_H. If a working vfork is found, define HAVE_
WORKING_VFORK. Otherwise, define vfork to be fork for backward compatibility
with previous versions of autoconf. This macro checks for several known errors in
implementations of vfork and considers the system to not have a working vfork if
it detects any of them. It is not considered to be an implementation error if a child’s
invocation of signal modifies the parent’s signal handler, since child processes rarely
change their signal handlers.
Since this macro defines vfork only for backward compatibility with previous versions
of autoconf you’re encouraged to define it yourself in new code:
#ifndef HAVE_WORKING_VFORK
# define vfork fork
#endif
AC_FUNC_FSEEKO [Macro]
If the fseeko function is available, define HAVE_FSEEKO. Define _LARGEFILE_SOURCE if
necessary to make the prototype visible on some systems (e.g., glibc 2.2). Otherwise
linkage problems may occur when compiling with AC_SYS_LARGEFILE on largefile-
sensitive systems where off_t does not default to a 64bit entity.
AC_FUNC_GETGROUPS [Macro]
If the getgroups function is available and works (unlike on Ultrix 4.3, where
‘getgroups (0, 0)’ always fails), define HAVE_GETGROUPS. Set GETGROUPS_LIBS to
any libraries needed to get that function. This macro runs AC_TYPE_GETGROUPS.
AC_FUNC_GETLOADAVG [Macro]
Check how to get the system load averages. To perform its tests properly, this macro
needs the file ‘getloadavg.c’; therefore, be sure to set the AC_LIBOBJ replacement di-
rectory properly (see Section 5.5.3 [Generic Functions], page 54, AC_CONFIG_LIBOBJ_
DIR).
Chapter 5: Existing Tests 51
If the system has the getloadavg function, define HAVE_GETLOADAVG, and set
GETLOADAVG_LIBS to any libraries necessary to get that function. Also add
GETLOADAVG_LIBS to LIBS. Otherwise, require an AC_LIBOBJ replacement for
‘getloadavg’ with source code in ‘dir /getloadavg.c’, and possibly define several
other C preprocessor macros and output variables:
1. Define C_GETLOADAVG.
2. Define SVR4, DGUX, UMAX, or UMAX4_3 if on those systems.
3. If ‘nlist.h’ is found, define HAVE_NLIST_H.
4. If ‘struct nlist’ has an ‘n_un.n_name’ member, define HAVE_STRUCT_NLIST_N_
UN_N_NAME. The obsolete symbol NLIST_NAME_UNION is still defined, but do not
depend upon it.
5. Programs may need to be installed set-group-ID (or set-user-ID) for getloadavg
to work. In this case, define GETLOADAVG_PRIVILEGED, set the output variable
NEED_SETGID to ‘true’ (and otherwise to ‘false’), and set KMEM_GROUP to the
name of the group that should own the installed program.
The AC_FUNC_GETLOADAVG macro is obsolescent. New programs should use Gnulib’s
getloadavg module. See Section 2.2 [Gnulib], page 3.
AC_FUNC_GETMNTENT [Macro]
Check for getmntent in the standard C library, and then in the ‘sun’, ‘seq’, and ‘gen’
libraries, for unicos, irix 4, ptx, and UnixWare, respectively. Then, if getmntent
is available, define HAVE_GETMNTENT.
AC_FUNC_GETPGRP [Macro]
Define GETPGRP_VOID if it is an error to pass 0 to getpgrp; this is the Posix behavior.
On older BSD systems, you must pass 0 to getpgrp, as it takes an argument and
behaves like Posix’s getpgid.
#ifdef GETPGRP_VOID
pid = getpgrp ();
#else
pid = getpgrp (0);
#endif
This macro does not check whether getpgrp exists at all; if you need to work in that
situation, first call AC_CHECK_FUNC for getpgrp.
This macro is obsolescent, as current systems have a getpgrp whose signature con-
forms to Posix. New programs need not use this macro.
AC_FUNC_LSTAT_FOLLOWS_SLASHED_SYMLINK [Macro]
If ‘link’ is a symbolic link, then lstat should treat ‘link/’ the same as ‘link/.’.
However, many older lstat implementations incorrectly ignore trailing slashes.
It is safe to assume that if lstat incorrectly ignores trailing slashes, then other
symbolic-link-aware functions like unlink also incorrectly ignore trailing slashes.
If lstat behaves properly, define LSTAT_FOLLOWS_SLASHED_SYMLINK, otherwise re-
quire an AC_LIBOBJ replacement of lstat.
52 Autoconf
AC_FUNC_MALLOC [Macro]
If the malloc function is compatible with the GNU C library malloc (i.e., ‘malloc (0)’
returns a valid pointer), define HAVE_MALLOC to 1. Otherwise define HAVE_MALLOC to
0, ask for an AC_LIBOBJ replacement for ‘malloc’, and define malloc to rpl_malloc
so that the native malloc is not used in the main project.
Typically, the replacement file ‘malloc.c’ should look like (note the ‘#undef malloc’):
#include <config.h>
#undef malloc
#include <sys/types.h>
void *
rpl_malloc (size_t n)
{
if (n == 0)
n = 1;
return malloc (n);
}
AC_FUNC_MEMCMP [Macro]
If the memcmp function is not available, or does not work on 8-bit data (like the one on
SunOS 4.1.3), or fails when comparing 16 bytes or more and with at least one buffer
not starting on a 4-byte boundary (such as the one on NeXT x86 OpenStep), require
an AC_LIBOBJ replacement for ‘memcmp’.
This macro is obsolescent, as current systems have a working memcmp. New programs
need not use this macro.
AC_FUNC_MBRTOWC [Macro]
Define HAVE_MBRTOWC to 1 if the function mbrtowc and the type mbstate_t are prop-
erly declared.
AC_FUNC_MKTIME [Macro]
If the mktime function is not available, or does not work correctly, require an AC_
LIBOBJ replacement for ‘mktime’. For the purposes of this test, mktime should con-
form to the Posix standard and should be the inverse of localtime.
AC_FUNC_MMAP [Macro]
If the mmap function exists and works correctly, define HAVE_MMAP. This checks only
private fixed mapping of already-mapped memory.
AC_FUNC_OBSTACK [Macro]
If the obstacks are found, define HAVE_OBSTACK, else require an AC_LIBOBJ replace-
ment for ‘obstack’.
Chapter 5: Existing Tests 53
AC_FUNC_REALLOC [Macro]
If the realloc function is compatible with the GNU C library realloc (i.e., ‘realloc
(NULL, 0)’ returns a valid pointer), define HAVE_REALLOC to 1. Otherwise define
HAVE_REALLOC to 0, ask for an AC_LIBOBJ replacement for ‘realloc’, and define
realloc to rpl_realloc so that the native realloc is not used in the main project.
See AC_FUNC_MALLOC for details.
AC_FUNC_SELECT_ARGTYPES [Macro]
Determines the correct type to be passed for each of the select function’s arguments,
and defines those types in SELECT_TYPE_ARG1, SELECT_TYPE_ARG234, and SELECT_
TYPE_ARG5 respectively. SELECT_TYPE_ARG1 defaults to ‘int’, SELECT_TYPE_ARG234
defaults to ‘int *’, and SELECT_TYPE_ARG5 defaults to ‘struct timeval *’.
This macro is obsolescent, as current systems have a select whose signature conforms
to Posix. New programs need not use this macro.
AC_FUNC_SETPGRP [Macro]
If setpgrp takes no argument (the Posix version), define SETPGRP_VOID. Otherwise,
it is the BSD version, which takes two process IDs as arguments. This macro does
not check whether setpgrp exists at all; if you need to work in that situation, first
call AC_CHECK_FUNC for setpgrp.
This macro is obsolescent, as current systems have a setpgrp whose signature con-
forms to Posix. New programs need not use this macro.
AC_FUNC_STAT [Macro]
AC_FUNC_LSTAT [Macro]
Determine whether stat or lstat have the bug that it succeeds when given the zero-
length file name as argument. The stat and lstat from SunOS 4.1.4 and the Hurd
(as of 1998-11-01) do this.
If it does, then define HAVE_STAT_EMPTY_STRING_BUG (or HAVE_LSTAT_EMPTY_
STRING_BUG) and ask for an AC_LIBOBJ replacement of it.
These macros are obsolescent, as no current systems have the bug. New programs
need not use these macros.
AC_FUNC_STRCOLL [Macro]
If the strcoll function exists and works correctly, define HAVE_STRCOLL. This does
a bit more than ‘AC_CHECK_FUNCS(strcoll)’, because some systems have incorrect
definitions of strcoll that should not be used.
AC_FUNC_STRERROR_R [Macro]
If strerror_r is available, define HAVE_STRERROR_R, and if it is declared, define
HAVE_DECL_STRERROR_R. If it returns a char * message, define STRERROR_R_CHAR_P;
otherwise it returns an int error number. The Thread-Safe Functions option of Posix
requires strerror_r to return int, but many systems (including, for example, version
2.2.4 of the GNU C Library) return a char * value that is not necessarily equal to the
buffer argument.
54 Autoconf
AC_FUNC_STRFTIME [Macro]
Check for strftime in the ‘intl’ library, for SCO Unix. Then, if strftime is avail-
able, define HAVE_STRFTIME.
This macro is obsolescent, as no current systems require the ‘intl’ library for
strftime. New programs need not use this macro.
AC_FUNC_STRTOD [Macro]
If the strtod function does not exist or doesn’t work correctly, ask for an AC_LIBOBJ
replacement of ‘strtod’. In this case, because ‘strtod.c’ is likely to need ‘pow’, set
the output variable POW_LIB to the extra library needed.
AC_FUNC_STRTOLD [Macro]
If the strtold function exists and conforms to C99, define HAVE_STRTOLD.
AC_FUNC_STRNLEN [Macro]
If the strnlen function is not available, or is buggy (like the one from AIX 4.3),
require an AC_LIBOBJ replacement for it.
AC_FUNC_UTIME_NULL [Macro]
If ‘utime (file, NULL)’ sets file’s timestamp to the present, define HAVE_UTIME_
NULL.
This macro is obsolescent, as all current systems have a utime that behaves this way.
New programs need not use this macro.
AC_FUNC_VPRINTF [Macro]
If vprintf is found, define HAVE_VPRINTF. Otherwise, if _doprnt is found, define
HAVE_DOPRNT. (If vprintf is available, you may assume that vfprintf and vsprintf
are also available.)
This macro is obsolescent, as all current systems have vprintf. New programs need
not use this macro.
AC_REPLACE_FNMATCH [Macro]
If the fnmatch function does not conform to Posix (see AC_FUNC_FNMATCH), ask for
its AC_LIBOBJ replacement.
The files ‘fnmatch.c’, ‘fnmatch_loop.c’, and ‘fnmatch_.h’ in the AC_LIBOBJ replace-
ment directory are assumed to contain a copy of the source code of GNU fnmatch.
If necessary, this source code is compiled as an AC_LIBOBJ replacement, and the
‘fnmatch_.h’ file is linked to ‘fnmatch.h’ so that it can be included in place of the
system <fnmatch.h>.
This macro is obsolescent, as it assumes the use of particular source files. New
programs should use Gnulib’s fnmatch-posix module, which provides this macro
along with the source files. See Section 2.2 [Gnulib], page 3.
Autoconf follows a philosophy that was formed over the years by those who have strug-
gled for portability: isolate the portability issues in specific files, and then program as if
you were in a Posix environment. Some functions may be missing or unfixable, and your
package must be ready to replace them.
Suitable replacements for many such problem functions are available from Gnulib (see
Section 2.2 [Gnulib], page 3).
AC_LIBOBJ (function ) [Macro]
Specify that ‘function.c’ must be included in the executables to replace a missing
or broken implementation of function.
Technically, it adds ‘function.$ac_objext’ to the output variable LIBOBJS if it is
not already in, and calls AC_LIBSOURCE for ‘function.c’. You should not directly
change LIBOBJS, since this is not traceable.
AC_LIBSOURCE (file ) [Macro]
Specify that file might be needed to compile the project. If you need to know what
files might be needed by a ‘configure.ac’, you should trace AC_LIBSOURCE. file must
be a literal.
This macro is called automatically from AC_LIBOBJ, but you must call it explicitly
if you pass a shell variable to AC_LIBOBJ. In that case, since shell variables cannot
be traced statically, you must pass to AC_LIBSOURCE any possible files that the shell
variable might cause AC_LIBOBJ to need. For example, if you want to pass a variable
$foo_or_bar to AC_LIBOBJ that holds either "foo" or "bar", you should do:
56 Autoconf
AC_LIBSOURCE([foo.c])
AC_LIBSOURCE([bar.c])
AC_LIBOBJ([$foo_or_bar])
There is usually a way to avoid this, however, and you are encouraged to simply call
AC_LIBOBJ with literal arguments.
Note that this macro replaces the obsolete AC_LIBOBJ_DECL, with slightly different
semantics: the old macro took the function name, e.g., foo, as its argument rather
than the file name.
It is common to merely check for the existence of a function, and ask for its AC_LIBOBJ
replacement if missing. The following macro is a convenient shorthand.
‘limits.h’
C99 says that ‘limits.h’ defines LLONG_MIN, LLONG_MAX, and ULLONG_MAX, but
many almost-C99 environments (e.g., default GCC 4.0.2 + glibc 2.4) do not
define them.
‘inttypes.h’ vs. ‘stdint.h’
The C99 standard says that ‘inttypes.h’ includes ‘stdint.h’, so there’s no
need to include ‘stdint.h’ separately in a standard environment. Some im-
plementations have ‘inttypes.h’ but not ‘stdint.h’ (e.g., Solaris 7), but we
don’t know of any implementation that has ‘stdint.h’ but not ‘inttypes.h’.
‘linux/irda.h’
It requires ‘linux/types.h’ and ‘sys/socket.h’.
‘linux/random.h’
It requires ‘linux/types.h’.
‘net/if.h’
On Darwin, this file requires that ‘sys/socket.h’ be included beforehand. One
should run:
AC_CHECK_HEADERS([sys/socket.h])
AC_CHECK_HEADERS([net/if.h], [], [],
[#include <stdio.h>
#ifdef STDC_HEADERS
# include <stdlib.h>
# include <stddef.h>
#else
# ifdef HAVE_STDLIB_H
# include <stdlib.h>
# endif
#endif
#ifdef HAVE_SYS_SOCKET_H
# include <sys/socket.h>
#endif
])
‘netinet/if_ether.h’
On Darwin, this file requires that ‘stdio.h’ and ‘sys/socket.h’ be included
beforehand. One should run:
AC_CHECK_HEADERS([sys/socket.h])
AC_CHECK_HEADERS([netinet/if_ether.h], [], [],
[#include <stdio.h>
#ifdef STDC_HEADERS
# include <stdlib.h>
# include <stddef.h>
#else
# ifdef HAVE_STDLIB_H
# include <stdlib.h>
# endif
58 Autoconf
#endif
#ifdef HAVE_SYS_SOCKET_H
# include <sys/socket.h>
#endif
])
‘stdint.h’
See above, item ‘inttypes.h’ vs. ‘stdint.h’.
‘stdlib.h’
On many systems (e.g., Darwin), ‘stdio.h’ is a prerequisite.
‘sys/mount.h’
On FreeBSD 4.8 on ia32 and using gcc version 2.95.4, ‘sys/params.h’ is a
prerequisite.
‘sys/ptem.h’
On Solaris 8, ‘sys/stream.h’ is a prerequisite.
‘sys/socket.h’
On Darwin, ‘stdlib.h’ is a prerequisite.
‘sys/ucred.h’
On Tru64 5.1, ‘sys/types.h’ is a prerequisite.
‘X11/extensions/scrnsaver.h’
Using XFree86, this header requires ‘X11/Xlib.h’, which is probably so required
that you might not even consider looking for it.
AC_CHECK_HEADERS([X11/extensions/scrnsaver.h], [], [],
[[#include <X11/Xlib.h>
]])
AC_HEADER_ASSERT [Macro]
Check whether to enable assertions in the style of ‘assert.h’. Assertions are en-
abled by default, but the user can override this by invoking configure with the
‘--disable-assert’ option.
AC_HEADER_DIRENT [Macro]
Check for the following header files. For the first one that is found and defines ‘DIR’,
define the listed C preprocessor macro:
‘dirent.h’ HAVE_DIRENT_H
‘sys/ndir.h’ HAVE_SYS_NDIR_H
‘sys/dir.h’ HAVE_SYS_DIR_H
‘ndir.h’ HAVE_NDIR_H
The directory-library declarations in your source code should look something like the
following:
Chapter 5: Existing Tests 59
#include <sys/types.h>
#ifdef HAVE_DIRENT_H
# include <dirent.h>
# define NAMLEN(dirent) strlen ((dirent)->d_name)
#else
# define dirent direct
# define NAMLEN(dirent) ((dirent)->d_namlen)
# ifdef HAVE_SYS_NDIR_H
# include <sys/ndir.h>
# endif
# ifdef HAVE_SYS_DIR_H
# include <sys/dir.h>
# endif
# ifdef HAVE_NDIR_H
# include <ndir.h>
# endif
#endif
Using the above declarations, the program would declare variables to be of type
struct dirent, not struct direct, and would access the length of a directory entry
name by passing a pointer to a struct dirent to the NAMLEN macro.
This macro also checks for the SCO Xenix ‘dir’ and ‘x’ libraries.
This macro is obsolescent, as all current systems with directory libraries have
<dirent.h>. New programs need not use this macro.
Also see AC_STRUCT_DIRENT_D_INO and AC_STRUCT_DIRENT_D_TYPE (see Section 5.8.1
[Particular Structures], page 65).
AC_HEADER_MAJOR [Macro]
If ‘sys/types.h’ does not define major, minor, and makedev, but ‘sys/mkdev.h’
does, define MAJOR_IN_MKDEV; otherwise, if ‘sys/sysmacros.h’ does, define MAJOR_
IN_SYSMACROS.
AC_HEADER_RESOLV [Macro]
Checks for header ‘resolv.h’, checking for prerequisites first. To properly use
‘resolv.h’, your code should contain something like the following:
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h>
#endif
#ifdef HAVE_NETINET_IN_H
# include <netinet/in.h> /* inet_ functions / structs */
#endif
#ifdef HAVE_ARPA_NAMESER_H
# include <arpa/nameser.h> /* DNS HEADER struct */
#endif
#ifdef HAVE_NETDB_H
# include <netdb.h>
#endif
#include <resolv.h>
60 Autoconf
AC_HEADER_STAT [Macro]
If the macros S_ISDIR, S_ISREG, etc. defined in ‘sys/stat.h’ do not work properly
(returning false positives), define STAT_MACROS_BROKEN. This is the case on Tektronix
UTekV, Amdahl UTS and Motorola System V/88.
This macro is obsolescent, as no current systems have the bug. New programs need
not use this macro.
AC_HEADER_STDBOOL [Macro]
If ‘stdbool.h’ exists and conforms to C99, define HAVE_STDBOOL_H to 1; if the type
_Bool is defined, define HAVE__BOOL to 1. To fulfill the C99 requirements, your
‘system.h’ could contain the following code:
#ifdef HAVE_STDBOOL_H
# include <stdbool.h>
#else
# ifndef HAVE__BOOL
# ifdef __cplusplus
typedef bool _Bool;
# else
# define _Bool signed char
# endif
# endif
# define bool _Bool
# define false 0
# define true 1
# define __bool_true_false_are_defined 1
#endif
Alternatively you can use the ‘stdbool’ package of Gnulib (see Section 2.2 [Gnulib],
page 3); it packages the above code into a replacement header and contains a few
other bells and whistles.
AC_HEADER_STDC [Macro]
Define STDC_HEADERS if the system has C header files conforming to ANSI C89 (ISO
C90). Specifically, this macro checks for ‘stdlib.h’, ‘stdarg.h’, ‘string.h’, and
‘float.h’; if the system has those, it probably has the rest of the C89 header files.
This macro also checks whether ‘string.h’ declares memchr (and thus presumably the
other mem functions), whether ‘stdlib.h’ declare free (and thus presumably malloc
and other related functions), and whether the ‘ctype.h’ macros work on characters
with the high bit set, as the C standard requires.
If you use this macro, your code can refer to STDC_HEADERS to determine whether the
system has conforming header files (and probably C library functions).
This macro is obsolescent, as current systems have conforming header files. New
programs need not use this macro.
Nowadays ‘string.h’ is part of the C standard and declares functions like strcpy,
and ‘strings.h’ is standardized by Posix and declares BSD functions like bcopy; but
historically, string functions were a major sticking point in this area. If you still want
to worry about portability to ancient systems without standard headers, there is so
Chapter 5: Existing Tests 61
much variation that it is probably easier to declare the functions you use than to figure
out exactly what the system header files declare. Some ancient systems contained a
mix of functions from the C standard and from BSD; some were mostly standard
but lacked ‘memmove’; some defined the BSD functions as macros in ‘string.h’ or
‘strings.h’; some had only the BSD functions but ‘string.h’; some declared the
memory functions in ‘memory.h’, some in ‘string.h’; etc. It is probably sufficient to
check for one string function and one memory function; if the library had the standard
versions of those then it probably had most of the others. If you put the following in
‘configure.ac’:
If you use a function like memchr, memset, strtok, or strspn, which have no BSD
equivalent, then macros don’t suffice to port to ancient hosts; you must provide an im-
plementation of each function. An easy way to incorporate your implementations only
when needed (since the ones in system C libraries may be hand optimized) is to, taking
memchr for example, put it in ‘memchr.c’ and use ‘AC_REPLACE_FUNCS([memchr])’.
AC_HEADER_SYS_WAIT [Macro]
If ‘sys/wait.h’ exists and is compatible with Posix, define HAVE_SYS_WAIT_H. In-
compatibility can occur if ‘sys/wait.h’ does not exist, or if it uses the old BSD union
wait instead of int to store a status value. If ‘sys/wait.h’ is not Posix compatible,
then instead of including it, define the Posix macros with their usual interpretations.
Here is an example:
62 Autoconf
#include <sys/types.h>
#ifdef HAVE_SYS_WAIT_H
# include <sys/wait.h>
#endif
#ifndef WEXITSTATUS
# define WEXITSTATUS(stat_val) ((unsigned int) (stat_val) >> 8)
#endif
#ifndef WIFEXITED
# define WIFEXITED(stat_val) (((stat_val) & 255) == 0)
#endif
This macro is obsolescent, as current systems are compatible with Posix. New pro-
grams need not use this macro.
#ifdef _POSIX_VERSION
/* Code for Posix systems. */
#endif
AC_HEADER_TIME [Macro]
If a program may include both ‘time.h’ and ‘sys/time.h’, define TIME_WITH_SYS_
TIME. On some ancient systems, ‘sys/time.h’ included ‘time.h’, but ‘time.h’ was
not protected against multiple inclusion, so programs could not explicitly include both
files. This macro is useful in programs that use, for example, struct timeval as well
as struct tm. It is best used in conjunction with HAVE_SYS_TIME_H, which can be
checked for using AC_CHECK_HEADERS([sys/time.h]).
#ifdef TIME_WITH_SYS_TIME
# include <sys/time.h>
# include <time.h>
#else
# ifdef HAVE_SYS_TIME_H
# include <sys/time.h>
# else
# include <time.h>
# endif
#endif
This macro is obsolescent, as current systems can include both files when they exist.
New programs need not use this macro.
Chapter 5: Existing Tests 63
AC_HEADER_TIOCGWINSZ [Macro]
If the use of TIOCGWINSZ requires ‘<sys/ioctl.h>’, then define GWINSZ_IN_SYS_
IOCTL. Otherwise TIOCGWINSZ can be found in ‘<termios.h>’.
Use:
#ifdef HAVE_TERMIOS_H
# include <termios.h>
#endif
#ifdef GWINSZ_IN_SYS_IOCTL
# include <sys/ioctl.h>
#endif
Previous versions of Autoconf merely checked whether the header was accepted by the
preprocessor. This was changed because the old test was inappropriate for typical uses.
Headers are typically used to compile, not merely to preprocess, and the old behavior
sometimes accepted headers that clashed at compile-time. If you need to check whether a
header is preprocessable, you can use AC_PREPROC_IFELSE (see Section 6.3 [Running the
Preprocessor], page 94).
64 Autoconf
This scheme, which improves the robustness of the test, also requires that you make
sure that headers that must be included before the header-file be part of the includes, (see
Section 5.1.2 [Default Includes], page 37). If looking for ‘bar.h’, which requires that ‘foo.h’
be included before if it exists, we suggest the following scheme:
AC_CHECK_HEADERS([foo.h])
AC_CHECK_HEADERS([bar.h], [], [],
[#ifdef HAVE_FOO_H
# include <foo.h>
# endif
])
The following variant generates smaller, faster configure files if you do not need the
full power of AC_CHECK_HEADERS.
AC_CHECK_HEADERS_ONCE (header-file . . . ) [Macro]
For each given system header file header-file in the blank-separated argument list
that exists, define HAVE_header-file (in all capitals). This is a once-only variant of
AC_CHECK_HEADERS. It generates the checking code at most once, so that configure
is smaller and faster; but the checks cannot be conditionalized and are always done
once, early during the configure run.
5.7 Declarations
The following macros check for the declaration of variables and functions. If there is no
macro specifically defined to check for a symbol you need, then you can use the general
macros (see Section 5.7.2 [Generic Declarations], page 64) or, for more complex tests, you
may use AC_COMPILE_IFELSE (see Section 6.4 [Running the Compiler], page 95).
it is additional shell code to execute when one of the function declarations is needed,
otherwise action-if-found is executed.
includes is a series of include directives, defaulting to AC_INCLUDES_DEFAULT (see
Section 5.1.2 [Default Includes], page 37), which are used prior to the declarations
under test.
This macro uses an M4 list as first argument:
AC_CHECK_DECLS([strdup])
AC_CHECK_DECLS([strlen])
AC_CHECK_DECLS([malloc, realloc, calloc, free])
AC_CHECK_DECLS([j0], [], [], [[#include <math.h>]])
Unlike the other ‘AC_CHECK_*S’ macros, when a symbol is not declared, HAVE_DECL_
symbol is defined to ‘0’ instead of leaving HAVE_DECL_symbol undeclared. When you
are sure that the check was performed, use HAVE_DECL_symbol in #if:
#if !HAVE_DECL_SYMBOL
extern char *symbol;
#endif
If the test may have not been performed, however, because it is safer not to declare
a symbol than to use a declaration that conflicts with the system’s one, you should
use:
#if defined HAVE_DECL_MALLOC && !HAVE_DECL_MALLOC
void *malloc (size_t *s);
#endif
You fall into the second category only in extreme situations: either your files may be
used without being configured, or they are used during the configuration. In most
cases the traditional approach is enough.
5.8 Structures
The following macros check for the presence of certain members in C structures. If there is
no macro specifically defined to check for a member you need, then you can use the general
structure-member macros (see Section 5.8.2 [Generic Structures], page 66) or, for more
complex tests, you may use AC_COMPILE_IFELSE (see Section 6.4 [Running the Compiler],
page 95).
AC_STRUCT_DIRENT_D_INO [Macro]
Perform all the actions of AC_HEADER_DIRENT (see Section 5.6.2 [Particular Headers],
page 58). Then, if struct dirent contains a d_ino member, define HAVE_STRUCT_
DIRENT_D_INO.
HAVE_STRUCT_DIRENT_D_INO indicates only the presence of d_ino, not whether its
contents are always reliable. Traditionally, a zero d_ino indicated a deleted directory
entry, though current systems hide this detail from the user and never return zero
d_ino values. Many current systems report an incorrect d_ino for a directory entry
that is a mount point.
AC_STRUCT_DIRENT_D_TYPE [Macro]
Perform all the actions of AC_HEADER_DIRENT (see Section 5.6.2 [Particular Headers],
page 58). Then, if struct dirent contains a d_type member, define HAVE_STRUCT_
DIRENT_D_TYPE.
AC_STRUCT_ST_BLOCKS [Macro]
If struct stat contains an st_blocks member, define HAVE_STRUCT_STAT_ST_
BLOCKS. Otherwise, require an AC_LIBOBJ replacement of ‘fileblocks’. The former
name, HAVE_ST_BLOCKS is to be avoided, as its support will cease in the future.
AC_STRUCT_TM [Macro]
If ‘time.h’ does not define struct tm, define TM_IN_SYS_TIME, which means that
including ‘sys/time.h’ had better define struct tm.
This macro is obsolescent, as ‘time.h’ defines struct tm in current systems. New
programs need not use this macro.
AC_STRUCT_TIMEZONE [Macro]
Figure out how to get the current timezone. If struct tm has a tm_zone member,
define HAVE_STRUCT_TM_TM_ZONE (and the obsoleted HAVE_TM_ZONE). Otherwise, if
the external array tzname is found, define HAVE_TZNAME; if it is declared, define HAVE_
DECL_TZNAME.
5.9 Types
The following macros check for C types, either builtin or typedefs. If there is no macro
specifically defined to check for a type you need, and you don’t need to check for any
special properties of it, then you can use a general type-check macro.
AC_TYPE_GETGROUPS [Macro]
Define GETGROUPS_T to be whichever of gid_t or int is the base type of the array
argument to getgroups.
AC_TYPE_INT8_T [Macro]
If ‘stdint.h’ or ‘inttypes.h’ does not define the type int8_t, define int8_t to
a signed integer type that is exactly 8 bits wide and that uses two’s complement
representation, if such a type exists. If you are worried about porting to hosts that
lack such a type, you can use the results of this macro in C89-or-later code as follows:
#if HAVE_STDINT_H
# include <stdint.h>
#endif
#if defined INT8_MAX || defined int8_t
code using int8_t
#else
complicated alternative using >8-bit ’signed char’
#endif
AC_TYPE_INT16_T [Macro]
This is like AC_TYPE_INT8_T, except for 16-bit integers.
68 Autoconf
AC_TYPE_INT32_T [Macro]
This is like AC_TYPE_INT8_T, except for 32-bit integers.
AC_TYPE_INT64_T [Macro]
This is like AC_TYPE_INT8_T, except for 64-bit integers.
AC_TYPE_INTMAX_T [Macro]
If ‘stdint.h’ or ‘inttypes.h’ defines the type intmax_t, define HAVE_INTMAX_T.
Otherwise, define intmax_t to the widest signed integer type.
AC_TYPE_INTPTR_T [Macro]
If ‘stdint.h’ or ‘inttypes.h’ defines the type intptr_t, define HAVE_INTPTR_T.
Otherwise, define intptr_t to a signed integer type wide enough to hold a pointer,
if such a type exists.
AC_TYPE_LONG_DOUBLE [Macro]
If the C compiler supports a working long double type, define HAVE_LONG_DOUBLE.
The long double type might have the same range and precision as double.
This macro is obsolescent, as current C compilers support long double. New pro-
grams need not use this macro.
AC_TYPE_LONG_DOUBLE_WIDER [Macro]
If the C compiler supports a working long double type with more range or precision
than the double type, define HAVE_LONG_DOUBLE_WIDER.
AC_TYPE_LONG_LONG_INT [Macro]
If the C compiler supports a working long long int type, define HAVE_LONG_LONG_
INT. However, this test does not test long long int values in preprocessor #if
expressions, because too many compilers mishandle such expressions. See Section 12.3
[Preprocessor Arithmetic], page 214.
AC_TYPE_MBSTATE_T [Macro]
Define HAVE_MBSTATE_T if <wchar.h> declares the mbstate_t type. Also, define
mbstate_t to be a type if <wchar.h> does not declare it.
AC_TYPE_MODE_T [Macro]
Define mode_t to a suitable type, if standard headers do not define it.
AC_TYPE_OFF_T [Macro]
Define off_t to a suitable type, if standard headers do not define it.
AC_TYPE_PID_T [Macro]
Define pid_t to a suitable type, if standard headers do not define it.
AC_TYPE_SIGNAL [Macro]
If ‘signal.h’ declares signal as returning a pointer to a function returning void,
define RETSIGTYPE to be void; otherwise, define it to be int.
Define signal handlers as returning type RETSIGTYPE:
Chapter 5: Existing Tests 69
RETSIGTYPE
hup_handler ()
{
...
}
AC_TYPE_SIZE_T [Macro]
Define size_t to a suitable type, if standard headers do not define it.
AC_TYPE_SSIZE_T [Macro]
Define ssize_t to a suitable type, if standard headers do not define it.
AC_TYPE_UID_T [Macro]
Define uid_t and gid_t to suitable types, if standard headers do not define them.
AC_TYPE_UINT8_T [Macro]
If ‘stdint.h’ or ‘inttypes.h’ does not define the type uint8_t, define uint8_t to
an unsigned integer type that is exactly 8 bits wide, if such a type exists. This is like
AC_TYPE_INT8_T, except for unsigned integers.
AC_TYPE_UINT16_T [Macro]
This is like AC_TYPE_UINT8_T, except for 16-bit integers.
AC_TYPE_UINT32_T [Macro]
This is like AC_TYPE_UINT8_T, except for 32-bit integers.
AC_TYPE_UINT64_T [Macro]
This is like AC_TYPE_UINT8_T, except for 64-bit integers.
AC_TYPE_UINTMAX_T [Macro]
If ‘stdint.h’ or ‘inttypes.h’ defines the type uintmax_t, define HAVE_UINTMAX_T.
Otherwise, define uintmax_t to the widest unsigned integer type.
AC_TYPE_UINTPTR_T [Macro]
If ‘stdint.h’ or ‘inttypes.h’ defines the type uintptr_t, define HAVE_UINTPTR_
T. Otherwise, define uintptr_t to an unsigned integer type wide enough to hold a
pointer, if such a type exists.
AC_TYPE_UNSIGNED_LONG_LONG_INT [Macro]
If the C compiler supports a working unsigned long long int type, define HAVE_
UNSIGNED_LONG_LONG_INT. However, this test does not test unsigned long long
int values in preprocessor #if expressions, because too many compilers mishandle
such expressions. See Section 12.3 [Preprocessor Arithmetic], page 214.
AC_LANG_WERROR [Macro]
Normally Autoconf ignores warnings generated by the compiler, linker, and prepro-
cessor. If this macro is used, warnings count as fatal errors for the current language.
This macro is useful when the results of configuration are used where warnings are
unacceptable; for instance, if parts of a program are built with the GCC ‘-Werror’ op-
tion. If the whole program is built using ‘-Werror’ it is often simpler to put ‘-Werror’
in the compiler flags (CFLAGS, etc.).
72 Autoconf
AC_OPENMP [Macro]
OpenMP (http://www.openmp.org/) specifies extensions of C, C++, and Fortran
that simplify optimization of shared memory parallelism, which is a common problem
on multicore CPUs.
If the current language is C, the macro AC_OPENMP sets the variable OPENMP_CFLAGS to
the C compiler flags needed for supporting OpenMP. OPENMP_CFLAGS is set to empty
if the compiler already supports OpenMP, if it has no way to activate OpenMP
support, or if the user rejects OpenMP support by invoking ‘configure’ with the
‘--disable-openmp’ option.
OPENMP_CFLAGS needs to be used when compiling programs, when preprocessing pro-
gram source, and when linking programs. Therefore you need to add $(OPENMP_
CFLAGS) to the CFLAGS of C programs that use OpenMP. If you preprocess OpenMP-
specific C code, you also need to add $(OPENMP_CFLAGS) to CPPFLAGS. The presence
of OpenMP support is revealed at compile time by the preprocessor macro _OPENMP.
Linking a program with OPENMP_CFLAGS typically adds one more shared library to the
program’s dependencies, so its use is recommended only on programs that actually
require OpenMP.
If the current language is C++, AC_OPENMP sets the variable OPENMP_CXXFLAGS, suit-
ably for the C++ compiler. The same remarks hold as for C.
If the current language is Fortran 77 or Fortran, AC_OPENMP sets the variable OPENMP_
FFLAGS or OPENMP_FCFLAGS, respectively. Similar remarks as for C hold, except that
CPPFLAGS is not used for Fortran, and no preprocessor macro signals OpenMP sup-
port.
AC_PROG_CC_C_O [Macro]
If the C compiler does not accept the ‘-c’ and ‘-o’ options simultaneously, define
NO_MINUS_C_MINUS_O. This macro actually tests both the compiler found by AC_
PROG_CC, and, if different, the first cc in the path. The test fails if one fails. This
macro was created for GNU Make to choose the default C compilation rule.
AC_PROG_CPP [Macro]
Set output variable CPP to a command that runs the C preprocessor. If ‘$CC -E’
doesn’t work, ‘/lib/cpp’ is used. It is only portable to run CPP on files with a ‘.c’
extension.
Some preprocessors don’t indicate missing include files by the error status. For such
preprocessors an internal variable is set that causes other macros to check the standard
error from the preprocessor and consider the test failed if any warnings have been
reported. For most preprocessors, though, warnings do not cause include-file tests to
fail unless AC_PROG_CPP_WERROR is also specified.
AC_PROG_CPP_WERROR [Macro]
This acts like AC_PROG_CPP, except it treats warnings from the preprocessor as errors
even if the preprocessor exit status indicates success. This is useful for avoiding
headers that generate mandatory warnings, such as deprecation notices.
The following macros check for C compiler or machine architecture features. To check
for characteristics not listed here, use AC_COMPILE_IFELSE (see Section 6.4 [Running the
Compiler], page 95) or AC_RUN_IFELSE (see Section 6.6 [Runtime], page 96).
AC_PROG_CC_STDC [Macro]
If the C compiler cannot compile ISO Standard C (currently C99), try to add an
option to output variable CC to make it work. If the compiler does not support C99,
fall back to supporting ANSI C89 (ISO C90).
After calling this macro you can check whether the C compiler has been set to accept
Standard C; if not, the shell variable ac_cv_prog_cc_stdc is set to ‘no’.
AC_PROG_CC_C89 [Macro]
If the C compiler is not in ANSI C89 (ISO C90) mode by default, try to add an option
to output variable CC to make it so. This macro tries various options that select ANSI
C89 on some system or another. It considers the compiler to be in ANSI C89 mode if
it handles function prototypes correctly.
After calling this macro you can check whether the C compiler has been set to accept
ANSI C89; if not, the shell variable ac_cv_prog_cc_c89 is set to ‘no’.
This macro is called automatically by AC_PROG_CC.
AC_PROG_CC_C99 [Macro]
If the C compiler is not in C99 mode by default, try to add an option to output
variable CC to make it so. This macro tries various options that select C99 on some
system or another. It considers the compiler to be in C99 mode if it handles _Bool,
// comments, flexible array members, inline, signed and unsigned long long int,
mixed code and declarations, named initialization of structs, restrict, va_copy,
varargs macros, variable declarations in for loops, and variable length arrays.
Chapter 5: Existing Tests 75
After calling this macro you can check whether the C compiler has been set to accept
C99; if not, the shell variable ac_cv_prog_cc_c99 is set to ‘no’.
AC_C_BACKSLASH_A [Macro]
Define ‘HAVE_C_BACKSLASH_A’ to 1 if the C compiler understands ‘\a’.
This macro is obsolescent, as current C compilers understand ‘\a’. New programs
need not use this macro.
AC_C_CONST [Macro]
If the C compiler does not fully support the const keyword, define const to be empty.
Some C compilers that do not define __STDC__ do support const; some compilers that
define __STDC__ do not completely support const. Programs can simply use const
as if every C compiler supported it; for those that don’t, the makefile or configuration
header file defines it as empty.
Occasionally installers use a C++ compiler to compile C code, typically because they
lack a C compiler. This causes problems with const, because C and C++ treat const
differently. For example:
const int foo;
is valid in C but not in C++. These differences unfortunately cannot be papered over
by defining const to be empty.
If autoconf detects this situation, it leaves const alone, as this generally yields
better results in practice. However, using a C++ compiler to compile C code is not
76 Autoconf
recommended or supported, and installers who run into trouble in this area should
get a C compiler like GCC to compile their C code.
This macro is obsolescent, as current C compilers support const. New programs need
not use this macro.
AC_C_RESTRICT [Macro]
If the C compiler recognizes a variant spelling for the restrict keyword (__restrict,
__restrict__, or _Restrict), then define restrict to that; this is more likely to do
the right thing with compilers that support language variants where plain restrict
is not a keyword. Otherwise, if the C compiler recognizes the restrict keyword,
don’t do anything. Otherwise, define restrict to be empty. Thus, programs may
simply use restrict as if every C compiler supported it; for those that do not, the
makefile or configuration header defines it away.
Although support in C++ for the restrict keyword is not required, several C++
compilers do accept the keyword. This macro works for them, too.
AC_C_VOLATILE [Macro]
If the C compiler does not understand the keyword volatile, define volatile to be
empty. Programs can simply use volatile as if every C compiler supported it; for
those that do not, the makefile or configuration header defines it as empty.
If the correctness of your program depends on the semantics of volatile, simply
defining it to be empty does, in a sense, break your code. However, given that
the compiler does not support volatile, you are at its mercy anyway. At least
your program compiles, when it wouldn’t before. See Section 12.6 [Volatile Objects],
page 215, for more about volatile.
In general, the volatile keyword is a standard C feature, so you might expect that
volatile is available only when __STDC__ is defined. However, Ultrix 4.3’s native
compiler does support volatile, but does not define __STDC__.
This macro is obsolescent, as current C compilers support volatile. New programs
need not use this macro.
AC_C_INLINE [Macro]
If the C compiler supports the keyword inline, do nothing. Otherwise define inline
to __inline__ or __inline if it accepts one of those, otherwise define inline to be
empty.
AC_C_CHAR_UNSIGNED [Macro]
If the C type char is unsigned, define __CHAR_UNSIGNED__, unless the C compiler
predefines it.
AC_C_STRINGIZE [Macro]
If the C preprocessor supports the stringizing operator, define HAVE_STRINGIZE. The
stringizing operator is ‘#’ and is found in macros such as this:
#define x(y) #y
This macro is obsolescent, as current C compilers support the stringizing operator.
New programs need not use this macro.
Chapter 5: Existing Tests 77
AC_C_FLEXIBLE_ARRAY_MEMBER [Macro]
If the C compiler supports flexible array members, define FLEXIBLE_ARRAY_MEMBER
to nothing; otherwise define it to 1. That way, a declaration like this:
struct s
{
size_t n_vals;
double val[FLEXIBLE_ARRAY_MEMBER];
};
will let applications use the “struct hack” even with compilers that do not support
flexible array members. To allocate and use such an object, you can use code like
this:
size_t i;
size_t n = compute_value_count ();
struct s *p =
malloc (offsetof (struct s, val)
+ n * sizeof (double));
p->n_vals = n;
for (i = 0; i < n; i++)
p->val[i] = compute_value (i);
AC_C_VARARRAYS [Macro]
If the C compiler supports variable-length arrays, define HAVE_C_VARARRAYS. A
variable-length array is an array of automatic storage duration whose length is deter-
mined at run time, when the array is declared.
AC_C_TYPEOF [Macro]
If the C compiler supports GCC’s typeof syntax either directly or through a different
spelling of the keyword (e.g., __typeof__), define HAVE_TYPEOF. If the support is
available only through a different spelling, define typeof to that spelling.
AC_C_PROTOTYPES [Macro]
If function prototypes are understood by the compiler (as determined by AC_PROG_
CC), define PROTOTYPES and __PROTOTYPES. Defining __PROTOTYPES is for the benefit
of header files that cannot use macros that infringe on user name space.
This macro is obsolescent, as current C compilers support prototypes. New programs
need not use this macro.
AC_PROG_GCC_TRADITIONAL [Macro]
Add ‘-traditional’ to output variable CC if using the GNU C compiler and ioctl
does not work properly without ‘-traditional’. That usually happens when the
fixed header files have not been installed on an old system.
This macro is obsolescent, since current versions of the GNU C compiler fix the header
files automatically when installed.
78 Autoconf
AC_PROG_CXXCPP [Macro]
Set output variable CXXCPP to a command that runs the C++ preprocessor. If ‘$CXX
-E’ doesn’t work, ‘/lib/cpp’ is used. It is portable to run CXXCPP only on files with
a ‘.c’, ‘.C’, ‘.cc’, or ‘.cpp’ extension.
Some preprocessors don’t indicate missing include files by the error status. For such
preprocessors an internal variable is set that causes other macros to check the standard
error from the preprocessor and consider the test failed if any warnings have been
reported. However, it is not known whether such broken preprocessors exist for C++.
AC_PROG_CXX_C_O [Macro]
Test whether the C++ compiler accepts the options ‘-c’ and ‘-o’ simultaneously, and
define CXX_NO_MINUS_C_MINUS_O, if it does not.
AC_PROG_OBJCPP [Macro]
Set output variable OBJCPP to a command that runs the Objective C preprocessor. If
‘$OBJC -E’ doesn’t work, ‘/lib/cpp’ is used.
This macro may, however, be invoked with an optional first argument which, if spec-
ified, must be a blank-separated list of Fortran 77 compilers to search for. This just
gives the user an opportunity to specify an alternative search list for the Fortran 77
compiler. For example, if you didn’t like the default order, then you could invoke
AC_PROG_F77 like this:
AC_PROG_F77([fl32 f77 fort77 xlf g77 f90 xlf90])
If using g77 (the GNU Fortran 77 compiler), then set the shell variable G77 to ‘yes’.
If the output variable FFLAGS was not already set in the environment, then set it to
‘-g -02’ for g77 (or ‘-O2’ where g77 does not accept ‘-g’). Otherwise, set FFLAGS to
‘-g’ for all other Fortran 77 compilers.
AC_PROG_F77_C_O [Macro]
AC_PROG_FC_C_O [Macro]
Test whether the Fortran compiler accepts the options ‘-c’ and ‘-o’ simultaneously,
and define F77_NO_MINUS_C_MINUS_O or FC_NO_MINUS_C_MINUS_O, respectively, if it
does not.
The following macros check for Fortran compiler characteristics. To check for char-
acteristics not listed here, use AC_COMPILE_IFELSE (see Section 6.4 [Running the Com-
piler], page 95) or AC_RUN_IFELSE (see Section 6.6 [Runtime], page 96), making sure to
first set the current language to Fortran 77 or Fortran via AC_LANG([Fortran 77]) or AC_
LANG(Fortran) (see Section 6.1 [Language Choice], page 89).
AC_F77_LIBRARY_LDFLAGS [Macro]
AC_FC_LIBRARY_LDFLAGS [Macro]
Determine the linker flags (e.g., ‘-L’ and ‘-l’) for the Fortran intrinsic and runtime
libraries that are required to successfully link a Fortran program or shared library.
Chapter 5: Existing Tests 81
The output variable FLIBS or FCLIBS is set to these flags (which should be included
after LIBS when linking).
This macro is intended to be used in those situations when it is necessary to mix,
e.g., C++ and Fortran source code in a single program or shared library (see section
“Mixing Fortran 77 With C and C++” in GNU Automake).
For example, if object files from a C++ and Fortran compiler must be linked together,
then the C++ compiler/linker must be used for linking (since special C++-ish things
need to happen at link time like calling global constructors, instantiating templates,
enabling exception support, etc.).
However, the Fortran intrinsic and runtime libraries must be linked in as well, but the
C++ compiler/linker doesn’t know by default how to add these Fortran 77 libraries.
Hence, this macro was created to determine these Fortran libraries.
The macros AC_F77_DUMMY_MAIN and AC_FC_DUMMY_MAIN or AC_F77_MAIN and AC_
FC_MAIN are probably also necessary to link C/C++ with Fortran; see below.
AC_F77_MAIN [Macro]
AC_FC_MAIN [Macro]
As discussed above, many Fortran libraries allow you to provide an entry point called
(say) MAIN__ instead of the usual main, which is then called by a main function in
the Fortran libraries that initializes things like Fortran I/O. The AC_F77_MAIN and
AC_FC_MAIN macros detect whether it is possible to utilize such an alternate main
function, and defines F77_MAIN and FC_MAIN to the name of the function. (If no
alternate main function name is found, F77_MAIN and FC_MAIN are simply defined to
main.)
Thus, when calling Fortran routines from C that perform things like I/O, one should
use this macro and declare the "main" function like so:
#ifdef __cplusplus
extern "C"
#endif
int F77_MAIN(int argc, char *argv[]);
(Again, replace F77 with FC for Fortran instead of Fortran 77.)
AC_F77_WRAPPERS [Macro]
AC_FC_WRAPPERS [Macro]
Defines C macros F77_FUNC (name, NAME), FC_FUNC (name, NAME), F77_FUNC_
(name, NAME), and FC_FUNC_(name, NAME) to properly mangle the names of C/C++
identifiers, and identifiers with underscores, respectively, so that they match the
name-mangling scheme used by the Fortran compiler.
Fortran is case-insensitive, and in order to achieve this the Fortran compiler converts
all identifiers into a canonical case and format. To call a Fortran subroutine from C or
to write a C function that is callable from Fortran, the C program must explicitly use
identifiers in the format expected by the Fortran compiler. In order to do this, one
simply wraps all C identifiers in one of the macros provided by AC_F77_WRAPPERS or
AC_FC_WRAPPERS. For example, suppose you have the following Fortran 77 subroutine:
subroutine foobar (x, y)
double precision x, y
y = 3.14159 * x
return
end
You would then declare its prototype in C or C++ as:
#define FOOBAR_F77 F77_FUNC (foobar, FOOBAR)
#ifdef __cplusplus
extern "C" /* prevent C++ name mangling */
#endif
void FOOBAR_F77(double *x, double *y);
Note that we pass both the lowercase and uppercase versions of the function name to
F77_FUNC so that it can select the right one. Note also that all parameters to Fortran
77 routines are passed as pointers (see section “Mixing Fortran 77 With C and C++”
in GNU Automake).
(Replace F77 with FC for Fortran instead of Fortran 77.)
Chapter 5: Existing Tests 83
If AC_FC_SRCEXT succeeds in compiling files with the ext extension, it calls action-
if-success (defaults to nothing). If it fails, and cannot find a way to make the FC
compiler accept such files, it calls action-if-failure (defaults to exiting with an error
message).
AC_PATH_X [Macro]
Try to locate the X Window System include files and libraries. If the user gave
the command line options ‘--x-includes=dir ’ and ‘--x-libraries=dir ’, use those
directories.
If either or both were not given, get the missing values by running xmkmf (or an
executable pointed to by the XMKMF environment variable) on a trivial ‘Imakefile’
and examining the makefile that it produces. Setting XMKMF to ‘false’ disables this
method.
If this method fails to find the X Window System, configure looks for the files in
several directories where they often reside. If either method is successful, set the
shell variables x_includes and x_libraries to their locations, unless they are in
directories the compiler searches by default.
If both methods fail, or the user gave the command line option ‘--without-x’, set
the shell variable no_x to ‘yes’; otherwise set it to the empty string.
AC_PATH_XTRA [Macro]
An enhanced version of AC_PATH_X. It adds the C compiler flags that X needs to
output variable X_CFLAGS, and the X linker flags to X_LIBS. Define X_DISPLAY_
MISSING if X is not available.
This macro also checks for special libraries that some systems need in order to compile
X programs. It adds any that the system needs to output variable X_EXTRA_LIBS.
And it checks for special X11R6 libraries that need to be linked with before ‘-lX11’,
and adds any found to the output variable X_PRE_LIBS.
Chapter 5: Existing Tests 85
AC_SYS_INTERPRETER [Macro]
Check whether the system supports starting scripts with a line of the form ‘#!/bin/sh’
to select the interpreter to use for the script. After running this macro, shell code in
‘configure.ac’ can check the shell variable interpval; it is set to ‘yes’ if the system
supports ‘#!’, ‘no’ if not.
AC_SYS_LARGEFILE [Macro]
Arrange for large-file support. On some hosts, one must use special compiler options
to build programs that can access large files. Append any such options to the output
variable CC. Define _FILE_OFFSET_BITS and _LARGE_FILES if necessary.
Large-file support can be disabled by configuring with the ‘--disable-largefile’
option.
If you use this macro, check that your program works even when off_t is wider than
long int, since this is common when large-file support is enabled. For example, it is
not correct to print an arbitrary off_t value X with printf ("%ld", (long int) X).
The LFS introduced the fseeko and ftello functions to replace their C counterparts
fseek and ftell that do not use off_t. Take care to use AC_FUNC_FSEEKO to make
their prototypes available when using them and large-file support is enabled.
AC_SYS_LONG_FILE_NAMES [Macro]
If the system supports file names longer than 14 characters, define HAVE_LONG_FILE_
NAMES.
AC_SYS_POSIX_TERMIOS [Macro]
Check to see if the Posix termios headers and functions are available on the system. If
so, set the shell variable ac_cv_sys_posix_termios to ‘yes’. If not, set the variable
to ‘no’.
_ALL_SOURCE
Enable extensions for AIX 3, and for Interix.
_POSIX_SOURCE
Enable Posix functions for Minix.
_POSIX_1_SOURCE
Enable additional Posix functions for Minix.
_MINIX Identify Minix platform. This particular preprocessor macro is obsoles-
cent, and may be removed in a future release of Autoconf.
AC_ERLANG_SUBST_INSTALL_LIB_DIR [Macro]
Set the ERLANG_INSTALL_LIB_DIR output variable to the directory into which every
built Erlang library should be installed in a separate subdirectory. If this variable is
not set in the environment when configure runs, its default value is $ERLANG_LIB_
DIR, which value is set by the AC_ERLANG_SUBST_LIB_DIR macro.
6 Writing Tests
If the existing feature tests don’t do something you need, you have to write new ones. These
macros are the building blocks. They provide ways for other macros to check whether various
kinds of features are available and report the results.
This chapter contains some suggestions and some of the reasons why the existing tests
are written the way they are. You can also learn a lot about how to write Autoconf tests
by looking at the existing ones. If something goes wrong in one or more of the Autoconf
tests, this information can help you understand the assumptions behind them, which might
help you figure out how to best solve the problem.
These macros check the output of the compiler system of the current language (see
Section 6.1 [Language Choice], page 89). They do not cache the results of their tests for
future use (see Section 7.4 [Caching Results], page 105), because they don’t know enough
about the information they are checking for to generate a cache variable name. They also
do not print any messages, for the same reason. The checks for particular kinds of features
call these macros and do cache their results and print messages about what they’re checking
for.
When you write a feature test that could be applicable to more than one software
package, the best thing to do is encapsulate it in a new macro. See Chapter 9 [Writing
Autoconf Macros], page 143, for how to do that.
‘Erlang’ Compile and execute tests using ERLC and ERL and use extension ‘.erl’
for test Erlang modules. Use compilation flags: ERLCFLAGS.
‘Objective C’
Do compilation tests using OBJC and OBJCPP and use extension ‘.m’ for
test programs. Use compilation flags: CPPFLAGS with OBJCPP, and both
CPPFLAGS and OBJCFLAGS with OBJC.
AC_REQUIRE_CPP [Macro]
Ensure that whichever preprocessor would currently be used for tests has been found.
Calls AC_REQUIRE (see Section 9.4.1 [Prerequisite Macros], page 145) with an argu-
ment of either AC_PROG_CPP or AC_PROG_CXXCPP, depending on which language is
current.
If you include any header files, be sure to call the functions relevant to them with the
correct number of arguments, even if they are just 0, to avoid compilation errors due to
prototypes. GCC version 2 has internal prototypes for several functions that it automatically
inlines; for example, memcpy. To avoid errors when checking for them, either pass them the
correct number of arguments or redeclare them with a different return type (such as char).
For instance:
AC_INIT([Hello], [1.0], [[email protected]])
AC_DEFINE([HELLO_WORLD], ["Hello, World\n"],
[Greetings string.])
AC_LANG_CONFTEST(
[AC_LANG_PROGRAM([[const char hw[] = "Hello, World\n";]],
[[fputs (hw, stdout);]])])
gcc -E -dD -o - conftest.c
results in:
...
# 1 "conftest.c"
io:format("~s~n", [?HELLO_WORLD])
.
AC_LANG_CALL (prologue, function ) [Macro]
Expands into a source file which consists of the prologue, and then a call to the
function as body of the main function (e.g., main in C). Since it uses AC_LANG_
PROGRAM, the feature of the latter are available.
This function will probably be replaced in the future by a version which would enable
specifying the arguments. The use of this macro is not encouraged, as it violates
strongly the typing system.
This macro cannot be used for Erlang tests.
AC_LANG_FUNC_LINK_TRY (function ) [Macro]
Expands into a source file which uses the function in the body of the main func-
tion (e.g., main in C). Since it uses AC_LANG_PROGRAM, the features of the latter are
available.
As AC_LANG_CALL, this macro is documented only for completeness. It is considered
to be severely broken, and in the future will be removed in favor of actual function
calls (with properly typed arguments).
This macro cannot be used for Erlang tests.
The macro AC_TRY_CPP (see Section 17.4 [Obsolete Macros], page 241) used to play the
role of AC_PREPROC_IFELSE, but double quotes its argument, making it impossible to use it
to elaborate sources. You are encouraged to get rid of your old use of the macro AC_TRY_CPP
in favor of AC_PREPROC_IFELSE, but, in the first place, are you sure you need to run the
preprocessor and not the compiler?
AC_EGREP_HEADER (pattern, header-file, action-if-found, [Macro]
[action-if-not-found ])
If the output of running the preprocessor on the system header file header-file matches
the extended regular expression pattern, execute shell commands action-if-found, oth-
erwise execute action-if-not-found.
For tests in Erlang, the input must be the source code of a module named conftest. AC_
COMPILE_IFELSE generates a ‘conftest.beam’ file that can be interpreted by the Erlang
virtual machine (ERL). It is recommended to use AC_LANG_PROGRAM to specify the test
program, to ensure that the Erlang module has the right name.
The input can be made by AC_LANG_PROGRAM and friends. LDFLAGS and LIBS are
used for linking, in addition to the compilation flags of the current language (see
Section 6.1 [Language Choice], page 89).
If the compiler being used does not produce executables that run on the system
where configure is being run, then the test program is not run. If the optional
shell commands action-if-cross-compiling are given, they are run instead. Otherwise,
configure prints an error message and exits.
In the action-if-false section, the failing exit status is available in the shell variable
‘$?’. This exit status might be that of a failed compilation, or it might be that of a
failed program execution.
It is customary to report unexpected failures with AC_MSG_FAILURE.
Try to provide a pessimistic default value to use when cross-compiling makes runtime
tests impossible. You do this by passing the optional last argument to AC_RUN_IFELSE.
autoconf prints a warning message when creating configure each time it encounters a
call to AC_RUN_IFELSE with no action-if-cross-compiling argument given. You may ignore
the warning, though users cannot configure your package for cross-compiling. A few of the
macros distributed with Autoconf produce this warning message.
To configure for cross-compiling you can also choose a value for those parameters based
on the canonical system name (see Chapter 13 [Manual Configuration], page 219). Alter-
natively, set up a test results cache file with the correct values for the host system (see
Section 7.4 [Caching Results], page 105).
To provide a default for calls of AC_RUN_IFELSE that are embedded in other macros,
including a few of the ones that come with Autoconf, you can test whether the shell variable
cross_compiling is set to ‘yes’, and then use an alternate method to get the results instead
of calling the macros.
It is also permissible to temporarily assign to cross_compiling in order to force tests
to behave as though they are in a cross-compilation environment, particularly since this
provides a way to test your action-if-cross-compiling even when you are not using a cross-
compiler.
# We temporarily set cross-compile mode to force AC_COMPUTE_INT
# to use the slow link-only method
save_cross_compiling=$cross_compiling
cross_compiling=yes
AC_COMPUTE_INT([...])
cross_compiling=$save_cross_compiling
A C or C++ runtime test should be portable. See Chapter 12 [Portable C and C++],
page 209.
Erlang tests must exit themselves the Erlang VM by calling the halt/1 function: the
given status code is used to determine the success of the test (status is 0) or its failure
(status is different than 0), as explained above. It must be noted that data output through
the standard output (e.g., using io:format/2) may be truncated when halting the VM.
Therefore, if a test must output configuration information, it is recommended to create and
to output data into the temporary file named ‘conftest.out’, using the functions of module
file. The conftest.out file is automatically deleted by the AC_RUN_IFELSE macro. For
instance, a simplified implementation of Autoconf’s AC_ERLANG_SUBST_LIB_DIR macro is:
98 Autoconf
6.7 Systemology
This section aims at presenting some systems and pointers to documentation. It may help
you addressing particular problems reported by users.
Posix-conforming systems are derived from the Unix operating system.
The Rosetta Stone for Unix contains a table correlating the features of various Posix-
conforming systems. Unix History is a simplified diagram of how many Unix systems were
derived from each other.
The Heirloom Project provides some variants of traditional implementations of Unix
utilities.
Darwin Darwin is also known as Mac OS X. Beware that the file system can be case-
preserving, but case insensitive. This can cause nasty problems, since for in-
stance the installation attempt for a package having an ‘INSTALL’ file can result
in ‘make install’ report that nothing was to be done!
That’s all dependent on whether the file system is a UFS (case sensitive) or
HFS+ (case preserving). By default Apple wants you to install the OS on
HFS+. Unfortunately, there are some pieces of software which really need to be
built on UFS. We may want to rebuild Darwin to have both UFS and HFS+
available (and put the /local/build tree on the UFS).
QNX 4.25 QNX is a realtime operating system running on Intel architecture meant to
be scalable from the small embedded systems to the hundred processor super-
computer. It claims to be Posix certified. More information is available on the
QNX home page.
provide one; however, it is easy to simulate by using a shell variable to keep track of
whether a way to perform the operation has been found yet.
Here is an example that uses the shell variable fstype to keep track of whether the
remaining cases need to be checked.
AC_MSG_CHECKING([how to get file system type])
fstype=no
# The order of these tests is important.
AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[#include <sys/statvfs.h>
#include <sys/fstyp.h>]])],
[AC_DEFINE([FSTYPE_STATVFS], [1],
[Define if statvfs exists.])
fstype=SVR4])
if test $fstype = no; then
AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[#include <sys/statfs.h>
#include <sys/fstyp.h>]])],
[AC_DEFINE([FSTYPE_USG_STATFS], [1],
[Define if USG statfs.])
fstype=SVR3])
fi
if test $fstype = no; then
AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[#include <sys/statfs.h>
#include <sys/vmount.h>]])]),
[AC_DEFINE([FSTYPE_AIX_STATFS], [1],
[Define if AIX statfs.])
fstype=AIX])
fi
# (more cases omitted here)
AC_MSG_RESULT([$fstype])
100 Autoconf
Chapter 7: Results of Tests 101
7 Results of Tests
Once configure has determined whether a feature exists, what can it do to record that
information? There are four sorts of things it can do: define a C preprocessor symbol, set
a variable in the output files, save the result in a cache file for future configure runs, and
print a message letting the user know the result of the test.
AC_OUTPUT replaces instances of ‘@variable @’ in input files with the value that the
shell variable variable has when AC_OUTPUT is called. The value can contain any
non-NUL character, including newline. Variable occurrences should not overlap: e.g.,
an input file should not contain ‘@var1 @var2 @’ if var1 and var2 are variable names.
The substituted value is not rescanned for more output variables; occurrences of
‘@variable @’ in the value are inserted literally into the output file. (The algorithm
uses the special marker |#_!!_#| internally, so neither the substituted value nor the
output file may contain |#_!!_#|.)
If value is given, in addition assign it to variable.
The string variable is passed to m4_pattern_allow (see Section 8.3.9 [Forbidden
Patterns], page 139).
The commands-to-set-it must have no side effects except for setting the variable
cache-id, see below.
The commands-to-set-it must have no side effects except for setting the variable
cache-id, see below.
AC_DEFUN([AC_SHELL_TRUE],
[AC_CACHE_CHECK([whether true(1) works], [my_cv_shell_true_works],
[my_cv_shell_true_works=no
(true) 2>/dev/null && my_cv_shell_true_works=yes
if test "$my_cv_shell_true_works" = yes; then
AC_DEFINE([TRUE_WORKS], [1],
[Define if ‘true(1)’ works properly.])
fi])
])
This fails if the cache is enabled: the second time this macro is run, TRUE_WORKS will not
be defined. The proper implementation is:
106 Autoconf
AC_DEFUN([AC_SHELL_TRUE],
[AC_CACHE_CHECK([whether true(1) works], [my_cv_shell_true_works],
[my_cv_shell_true_works=no
(true) 2>/dev/null && my_cv_shell_true_works=yes])
if test "$my_cv_shell_true_works" = yes; then
AC_DEFINE([TRUE_WORKS], [1],
[Define if ‘true(1)’ works properly.])
fi
])
Also, commands-to-set-it should not print any messages, for example with AC_MSG_
CHECKING; do that before calling AC_CACHE_VAL, so the messages are printed regardless of
whether the results of the check are retrieved from the cache or determined by running the
shell commands.
By default, configure uses no cache file, to avoid problems caused by accidental use of
stale cache files.
To enable caching, configure accepts ‘--config-cache’ (or ‘-C’) to cache results in the
file ‘config.cache’. Alternatively, ‘--cache-file=file ’ specifies that file be the cache file.
The cache file is created if it does not exist already. When configure calls configure scripts
in subdirectories, it uses the ‘--cache-file’ argument so that they share the same cache.
See Section 4.12 [Subdirectories], page 35, for information on configuring subdirectories
with the AC_CONFIG_SUBDIRS macro.
‘config.status’ only pays attention to the cache file if it is given the ‘--recheck’
option, which makes it rerun configure.
It is wrong to try to distribute cache files for particular system types. There is too
much room for error in doing that, and too much administrative overhead in maintaining
them. For any features that can’t be guessed automatically, use the standard method of the
canonical system type and linking files (see Chapter 13 [Manual Configuration], page 219).
The site initialization script can specify a site-wide cache file to use, instead of the usual
per-program cache. In this case, the cache file gradually accumulates information whenever
someone runs a new configure script. (Running configure merges the new cache results
with the existing cache file.) This may cause problems, however, if the system configuration
(e.g., the installed libraries or compilers) changes and the stale cache file is not deleted.
AC_CACHE_LOAD [Macro]
Loads values from existing cache file, or creates a new cache file if a cache file is not
found. Called automatically from AC_INIT.
AC_CACHE_SAVE [Macro]
Flushes all cached values to the cache file. Called automatically from AC_OUTPUT, but
it can be quite useful to call AC_CACHE_SAVE at key points in ‘configure.ac’.
For instance:
. . . AC INIT, etc. . . .
# Checks for programs.
AC_PROG_CC
AC_PROG_AWK
. . . more program checks . . .
AC_CACHE_SAVE
# Might abort...
AM_PATH_GTK([1.0.2], [], [AC_MSG_ERROR([GTK not in path])])
AM_PATH_GTKMM([0.9.5], [], [AC_MSG_ERROR([GTK not in path])])
. . . AC OUTPUT, etc. . . .
8 Programming in M4
Autoconf is written on top of two layers: M4sugar, which provides convenient macros
for pure M4 programming, and M4sh, which provides macros dedicated to shell script
generation.
As of this version of Autoconf, these two layers still contain experimental macros, whose
interface might change in the future. As a matter of fact, anything that is not documented
must not be used.
8.1 M4 Quotation
The most common problem with existing macros is an improper quotation. This section,
which users of Autoconf can skip, but which macro writers must read, first justifies the
quotation scheme that was chosen for Autoconf and then ends with a rule of thumb. Un-
derstanding the former helps one to follow the latter.
1
Using defn.
112 Autoconf
define([none], [$1])
⇒
define([one], [[$1]])
⇒
define([two], [[[$1]]])
⇒
define([comment], [# $1])
⇒
define([active], [ACTIVE])
⇒
none([active])
⇒ACTIVE
one([active])
⇒active
two([active])
⇒[active]
comment([active])
⇒# active
On the other hand, since autoconf generates shell code, you often want to output shell
variable expansion, rather than performing M4 parameter expansion. To do this, you must
use M4 quoting to separate the ‘$’ from the next character in the definition of your macro.
If the macro definition occurs in single-quoted text, then insert another level of quoting; if
the usage is already inside a double-quoted string, then split it into concatenated strings.
define([first], [${1}])first
⇒${1}
114 Autoconf
Posix also states that ‘$11’ should expand to the first parameter concatenated with a
literal ‘1’, although some versions of GNU M4 expand the eleventh parameter instead. For
portability, you should only use single-digit M4 parameter expansion.
With this in mind, we can explore the cases where macros invoke macros. . .
As the author of the Autoconf macro car, you then consider it to be incorrect that your
users have to double-quote the arguments of car, so you “fix” your macro. Let’s call it qar
for quoted car:
define([qar], [[$1]])
and check that qar is properly fixed:
qar([int tab[10];])
⇒int tab[10];
Ahhh! That’s much better.
But note what you’ve done: now that the result of qar is always a literal string, the only
time a user can use nested macros is if she relies on an unquoted macro call:
qar(active)
⇒ACT
qar([active])
⇒active
leaving no way for her to reproduce what she used to do with car:
car([active])
⇒ACT, IVE
Worse yet: she wants to use a macro that produces a set of cpp macros:
define([my_includes], [#include <stdio.h>])
car([my_includes])
⇒#include <stdio.h>
qar(my_includes)
error EOF in argument list
This macro, qar, because it double quotes its arguments, forces its users to leave their
macro calls unquoted, which is dangerous. Commas and other active symbols are interpreted
by M4 before they are given to the macro, often not in the way the users expect. Also,
because qar behaves differently from the other macros, it’s an exception that should be
avoided in Autoconf.
There are other magic primitives, such as changecom to specify what syntactic forms
are comments (it is common to see ‘changecom(<!--, -->)’ when M4 is used to produce
HTML pages), changeword and changesyntax to change other syntactic details (such as
the character to denote the nth argument, ‘$’ by default, the parentheses around arguments,
etc.).
These primitives are really meant to make M4 more useful for specific domains: they
should be considered like command line options: ‘--quotes’, ‘--comments’, ‘--words’, and
‘--syntax’. Nevertheless, they are implemented as M4 builtins, as it makes M4 libraries
self contained (no need for additional options).
There lies the problem. . .
The problem is that it is then tempting to use them in the middle of an M4 script, as
opposed to its initialization. This, if not carefully thought out, can lead to disastrous effects:
you are changing the language in the middle of the execution. Changing and restoring the
syntax is often not enough: if you happened to invoke macros in between, these macros are
lost, as the current syntax is probably not the one they were implemented with.
8.1.6 Quadrigraphs
When writing an Autoconf macro you may occasionally need to generate special characters
that are difficult to express with the standard Autoconf quoting rules. For example, you
may need to output the regular expression ‘[^[]’, which matches any character other than
‘[’. This expression contains unbalanced brackets so it cannot be put easily into an M4
macro.
You can work around this problem by using one of the following quadrigraphs:
‘@<:@’ ‘[’
‘@:>@’ ‘]’
‘@S|@’ ‘$’
‘@%:@’ ‘#’
‘@&t@’ Expands to nothing.
Quadrigraphs are replaced at a late stage of the translation process, after m4 is run, so
they do not get in the way of M4 quoting. For example, the string ‘^@<:@’, independently
of its quotation, appears as ‘^[’ in the output.
The empty quadrigraph can be used:
− to mark trailing spaces explicitly
Trailing spaces are smashed by autom4te. This is a feature.
− to produce other quadrigraphs
For instance ‘@<@&t@:@’ produces ‘@<:@’.
− to escape occurrences of forbidden patterns
For instance you might want to mention AC_FOO in a comment, while still being sure
that autom4te still catches unexpanded ‘AC_*’. Then write ‘AC@&t@_FOO’.
Chapter 8: Programming in M4 117
[[]]
With macros that do not double quote their arguments (which is the rule), double-quote
the (risky) literals:
AC_LINK_IFELSE([AC_LANG_PROGRAM(
[[#include <time.h>
#ifndef tzname /* For SGI. */
extern char *tzname[]; /* RS6000 and others reject char **tzname. */
#endif]],
[atoi (*tzname);])],
[ac_cv_var_tzname=yes],
[ac_cv_var_tzname=no])
Please note that the macro AC_TRY_LINK is obsolete, so you really should be using AC_
LINK_IFELSE instead.
See Section 8.1.6 [Quadrigraphs], page 116, for what to do if you run into a hopeless
case where quoting does not suffice.
When you create a configure script using newly written macros, examine it carefully
to check whether you need to add more quotes in your macros. If one or more words have
disappeared in the M4 output, you need more quotes. When in doubt, quote.
However, it’s also possible to put on too many layers of quotes. If this happens, the
resulting configure script may contain unexpanded macros. The autoconf program checks
for this problem by looking for the string ‘AC_’ in ‘configure’. However, this heuristic does
not work in general: for example, it does not catch overquoting in AC_DEFINE descriptions.
‘file ?’ If found in the library path, the file is included for expansion, otherwise it is
ignored instead of triggering a failure.
As another additional feature over m4, autom4te caches its results. GNU M4 is able to
produce a regular output and traces at the same time. Traces are heavily used in the GNU
Build System: autoheader uses them to build ‘config.h.in’, autoreconf to determine
what GNU Build System components are used, automake to “parse” ‘configure.ac’ etc.
To avoid recomputation, traces are cached while performing regular expansion, and con-
versely. This cache is (actually, the caches are) stored in the directory ‘autom4te.cache’.
It can safely be removed at any moment (especially if for some reason autom4te considers
it trashed).
‘--cache=directory ’
‘-C directory ’
Specify the name of the directory where the result should be cached. Passing
an empty value disables caching. Be sure to pass a relative file name, as for the
time being, global caches are not supported.
‘--no-cache’
Don’t cache the results.
‘--force’
‘-f’ If a cache is used, consider it obsolete (but update it anyway).
Because traces are so important to the GNU Build System, autom4te provides high level
tracing features as compared to M4, and helps exploiting the cache:
‘--trace=macro [:format ]’
‘-t macro [:format ]’
Trace the invocations of macro according to the format. Multiple ‘--trace’
arguments can be used to list several macros. Multiple ‘--trace’ arguments
Chapter 8: Programming in M4 121
for a single macro are not cumulative; instead, you should just make format as
long as needed.
The format is a regular string, with newlines if desired, and several special
escape codes. It defaults to ‘$f:$l:$n:$%’. It can use the following special
escapes:
‘$$’ The character ‘$’.
‘$f’ The file name from which macro is called.
‘$l’ The line number from which macro is called.
‘$d’ The depth of the macro call. This is an M4 technical detail that
you probably don’t want to know about.
‘$n’ The name of the macro.
‘$num ’ The numth argument of the call to macro.
‘$@’
‘$sep @’
‘${separator }@’
All the arguments passed to macro, separated by the character sep
or the string separator (‘,’ by default). Each argument is quoted,
i.e., enclosed in a pair of square brackets.
‘$*’
‘$sep *’
‘${separator }*’
As above, but the arguments are not quoted.
‘$%’
‘$sep %’
‘${separator }%’
As above, but the arguments are not quoted, all new line characters
in the arguments are smashed, and the default separator is ‘:’.
The escape ‘$%’ produces single-line trace outputs (unless you put
newlines in the ‘separator’), while ‘$@’ and ‘$*’ do not.
See Section 3.4 [autoconf Invocation], page 10, for examples of trace uses.
‘--preselect=macro ’
‘-p macro ’
Cache the traces of macro, but do not enable traces. This is especially impor-
tant to save CPU cycles in the future. For instance, when invoked, autoconf
preselects all the macros that autoheader, automake, autoreconf, etc., trace,
so that running m4 is not needed to trace them: the cache suffices. This results
in a huge speed-up.
‘--language=language ’
‘-l language ’
Use the language Autom4te library. Current languages include:
M4sugar create M4sugar output.
M4sh create M4sh executable shell scripts.
Autotest create Autotest executable test suites.
Autoconf-without-aclocal-m4
create Autoconf executable configure scripts without reading
‘aclocal.m4’.
Autoconf create Autoconf executable configure scripts. This language inher-
its all the characteristics of Autoconf-without-aclocal-m4 and
additionally reads ‘aclocal.m4’.
‘--prepend-include=dir ’
‘-B dir ’ Prepend directory dir to the search path. This is used to include the language-
specific files before any third-party macros.
As an example, if Autoconf is installed in its default location, ‘/usr/local’, the com-
mand ‘autom4te -l m4sugar foo.m4’ is strictly equivalent to the command:
autom4te --prepend-include /usr/local/share/autoconf \
m4sugar/m4sugar.m4f --warnings syntax foo.m4
Recursive expansion applies here: the command ‘autom4te -l m4sh foo.m4’ is the same as
‘autom4te --language M4sugar m4sugar/m4sh.m4f foo.m4’, i.e.:
autom4te --prepend-include /usr/local/share/autoconf \
m4sugar/m4sugar.m4f m4sugar/m4sh.m4f --mode 777 foo.m4
The definition of the languages is stored in ‘autom4te.cfg’.
begin-language: "Autoconf-without-aclocal-m4"
args: --no-cache
end-language: "Autoconf-without-aclocal-m4"
− m4 traceoff
− m4 traceon
− m4 translit
Some M4 macros are redefined, and are slightly incompatible with their native equivalent.
__file__ [Macro]
__line__ [Macro]
All M4 macros starting with ‘__’ retain their original name: for example, no m4__
file__ is defined.
__oline__ [Macro]
This is not technically a macro, but a feature of Autom4te. The sequence __oline__
can be used similarly to the other m4sugar location macros, but rather than expanding
to the location of the input file, it is translated to the line number where it appears
in the output file after all other M4 expansions.
dnl [Macro]
This macro kept its original name: no m4_dnl is defined.
m4_bpatsubst (string, regexp, [replacement ]) [Macro]
This macro corresponds to patsubst. The name m4_patsubst is kept for future
versions of M4sugar, once GNU M4 2.0 is released and supports extended regular
expression syntax.
m4_bregexp (string, regexp, [replacement ]) [Macro]
This macro corresponds to regexp. The name m4_regexp is kept for future versions
of M4sugar, once GNU M4 2.0 is released and supports extended regular expression
syntax.
m4_defn (macro ) [Macro]
Unlike the M4 builtin, this macro fails if macro is not defined. Also, while newer
M4 can concatenate multiple definitions, this version currently only supports a single
macro. See m4_undefine.
m4_divert (diversion ) [Macro]
M4sugar relies heavily on diversions, so rather than behaving as a primitive, m4_
divert behaves like:
m4_divert_pop()m4_divert_push([diversion ])
See Section 8.3.3 [Diversion support], page 126, for more details about the use of the
diversion stack.
m4_exit (exit-status ) [Macro]
This macro corresponds to m4exit.
m4_if (comment ) [Macro]
m4_if (string-1, string-2, equal, [not-equal ]) [Macro]
m4_if (string-1, string-2, equal, . . . ) [Macro]
This macro corresponds to ifelse. string-1 and string-2 are compared literally, so
usually one of the two arguments is passed unquoted. See Section 8.3.4 [Conditional
constructs], page 128, for more conditional idioms.
Chapter 8: Programming in M4 125
m4_location [Macro]
Useful as a prefix in a message line. Short for:
__file__:__line__
GROW This diversion is used behind the scenes by topological sorting macros, such as
AC_REQUIRE.
M4sh adds several more named diversions.
BINSH This diversion is reserved for the ‘#!’ interpreter line.
HEADER-REVISION
This diversion holds text from AC_REVISION.
HEADER-COMMENT
This diversion holds comments about the purpose of a file.
HEADER-COPYRIGHT
This diversion is managed by AC_COPYRIGHT.
M4SH-SANITIZE
This diversion contains M4sh sanitization code, used to ensure M4sh is execut-
ing in a reasonable shell environment.
M4SH-INIT
This diversion contains M4sh initialization code, initializing variables that are
required by other M4sh macros.
BODY This diversion contains the body of the shell code, and is the default diversion
once M4sh is initialized.
Autotest inherits diversions from M4sh, and changes the default diversion from BODY back
to KILL. It also adds several more named diversions, with the following subset designed for
developer use.
PREPARE_TESTS
This diversion contains initialization sequences which are executed after
‘atconfig’ and ‘atlocal’, and after all command line arguments have been
parsed, but prior to running any tests. It can be used to set up state that is
required across all tests. This diversion will work even before AT_INIT.
For now, the named diversions of Autoconf and Autoheader, and the remaining diversions
of Autotest, are not documented. In other words, intentionally outputting text into an
undocumented diversion is subject to breakage in a future release of Autoconf.
m4_init [Macro]
Initialize the M4sugar environment, setting up the default named diversion to be
KILL.
instead of five times, for faster computation if this is a common case for ‘$1’. Notice
that every third argument is unquoted for m4_if, and quoted for m4_cond:
m4_if(m4_index([$1], [\]), [-1], [$2],
m4_eval(m4_index([$1], [\\]) >= 0), [1], [$2],
m4_eval(m4_index([$1], [\$]) >= 0), [1], [$2],
m4_eval(m4_index([$1], [\‘]) >= 0), [1], [$3],
m4_eval(m4_index([$1], [\"]) >= 0), [1], [$3],
[$2])
m4_cond([m4_index([$1], [\])], [-1], [$2],
[m4_eval(m4_index([$1], [\\]) >= 0)], [1], [$2],
[m4_eval(m4_index([$1], [\$]) >= 0)], [1], [$2],
[m4_eval(m4_index([$1], [\‘]) >= 0)], [1], [$3],
[m4_eval(m4_index([$1], [\"]) >= 0)], [1], [$3],
[$2])
m4_map([m4_count], [])
⇒
m4_map([ m4_count], [[],
[[1]],
[[1], [2]]])
⇒ 0 1 2
m4_map_sep([m4_eval], [,], [[[1+2]],
[[10], [16]]])
⇒3,a
m4_define([zero],[0])m4_define([one],[1])m4_define([two],[2])dnl
m4_dquote(zero, [one], [[two]])
⇒[0],[one],[[two]]
m4_make_list(zero, [one], [[two]])
⇒[0],
⇒[one],
⇒[[two]]
m4_foreach([number], m4_dquote(zero, [one], [[two]]), [ number])
⇒ 0 1 two
m4_foreach([number], m4_make_list(zero, [one], [[two]]), [ number])
⇒ 0 1 two
m4_quote (arg, . . . ) [Macro]
Return the arguments as a single entity, i.e., wrap them into a pair of quotes. This
effectively collapses multiple arguments into one, although it loses whitespace after
unquoted commas in the process.
m4_unquote (arg, . . . ) [Macro]
This macro was introduced in Autoconf 2.62. Expand each argument, separated
by commas. For a single arg, this effectively removes a layer of quoting, and m4_
unquote([arg ]) is more efficient than the equivalent m4_do([arg ]). For multiple
arguments, this results in an unquoted list of expansions. This is commonly used with
m4_split, in order to convert a single quoted list into a series of quoted elements.
The following example aims at emphasizing the difference between several scenarios:
not using these macros, using m4_defn, using m4_quote, using m4_dquote, and using m4_
expand.
$ cat example.m4
dnl Overquote, so that quotes are visible.
m4_define([show], [$[]1 = [$1], $[]@ = [$@]])
m4_define([a], [A])
m4_define([mkargs], [1, 2[,] 3])
m4_define([arg1], [[$1]])
m4_divert([0])dnl
show(a, b)
show([a, b])
show(m4_quote(a, b))
show(m4_dquote(a, b))
show(m4_expand([a, b]))
arg1(mkargs)
arg1([mkargs])
arg1(m4_defn([mkargs]))
arg1(m4_quote(mkargs))
arg1(m4_dquote(mkargs))
arg1(m4_expand([mkargs]))
$ autom4te -l m4sugar example.m4
$1 = A, $@ = [A],[b]
134 Autoconf
$1 = a, b, $@ = [a, b]
$1 = A,b, $@ = [A,b]
$1 = [A],[b], $@ = [[A],[b]]
$1 = A, b, $@ = [A, b]
1
mkargs
1, 2[,] 3
1,2, 3
[1],[2, 3]
1, 2, 3
⇒existing
list
⇒one, two, three
m4_dquote(list)
⇒[one],[two],[three]
m4_append([list2], [one], [[, ]])dnl
m4_append_uniq([list2], [two], [[, ]])dnl
m4_append([list2], [three], [[, ]])dnl
list2
⇒one, two, three
m4_dquote(list2)
⇒[one, two, three]
m4_newline [Macro]
This macro was introduced in Autoconf 2.62, and expands to a newline. It is primarily
useful for maintaining macro formatting, and ensuring that M4 does not discard
leading whitespace during argument collection.
longer than prefix1, padding is inserted so that the first word of string begins at the
same indentation as all wrapped lines. Note that using literal tab characters in any
of the arguments will interfere with the calculation of width. No expansions occur on
prefix, prefix1, or the words of string, although quadrigraphs are recognized.
For some examples:
m4_text_wrap([Short string */], [ ], [/* ], [20])
⇒/* Short string */
m4_text_wrap([Much longer string */], [ ], [/* ], [20])
⇒/* Much longer
⇒ string */
m4_text_wrap([Short doc.], [ ], [ --short ], [30])
⇒ --short Short doc.
m4_text_wrap([Short doc.], [ ], [ --too-wide ], [30])
⇒ --too-wide
⇒ Short doc.
m4_text_wrap([Super long documentation.], [ ],
[ --too-wide ], 30)
⇒ --too-wide
⇒ Super long
⇒ documentation.
⇒1
m4_list_cmp([1, 2, -3], [1, 2])
⇒-1
m4_list_cmp([1, 0], [1, 2])
⇒-1
m4_list_cmp([1], [1, 2])
⇒-1
⇒-1
m4_version_compare([2.61a], [2.61a-248-dc51])
⇒-1
m4_version_compare([2.61b], [2.61a-248-dc51])
⇒1
Of course, you might encounter exceptions to these generic rules, for instance you might
have to refer to ‘$m4_flags’.
M4sh provides portable alternatives for some common shell constructs that unfortunately
are not portable in practice.
AS_BOURNE_COMPATIBLE [Macro]
Set up the shell to be more compatible with the Bourne shell as standardized by
Posix, if possible. This may involve setting environment variables, or setting options,
or similar implementation-specific actions.
AS_INIT [Macro]
Initialize the M4sh environment. This macro calls m4_init, then outputs the #!
/bin/sh line, a notice about where the output was generated from, and code to
sanitize the environment for the rest of the script. Finally, it changes the current
diversion to BODY.
AS_SHELL_SANITIZE [Macro]
Initialize the shell suitably for configure scripts. This has the effect of AS_BOURNE_
COMPATIBLE, and sets some other environment variables for predictable results from
configuration tests. For example, it sets LC_ALL to change to the default C locale.
See Section 10.10 [Special Shell Variables], page 166.
Chapter 8: Programming in M4 141
AS_MESSAGE_FD [Macro]
The file descriptor for ‘checking for...’ messages and results. Normally this directs
messages to the standard output, however when configure is run with the ‘-q’ option,
messages sent to AS_MESSAGE_FD are discarded.
If you want to display some messages, consider using one of the printing macros (see
Section 7.5 [Printing Messages], page 108) instead. Copies of messages output via
these macros are also recorded in ‘config.log’.
AS_MESSAGE_LOG_FD [Macro]
The file descriptor for messages logged to ‘config.log’. Macros that run tools, like
AC_COMPILE_IFELSE (see Section 6.4 [Running the Compiler], page 95), redirect all
output to this descriptor. You may want to do so if you develop such a low-level
macro.
AS_ORIGINAL_STDIN_FD [Macro]
The file descriptor for the original standard input.
When configure runs, it may accidentally execute an interactive command that has
the same name as the non-interactive meant to be used or checked. If the standard
input was the terminal, such interactive programs would cause configure to stop,
pending some user input. Therefore configure redirects its standard input from
142 Autoconf
‘/dev/null’ during its initialization. This is not normally a problem, since configure
normally does not need user input.
In the extreme case where your ‘configure’ script really needs to obtain some values
from the original standard input, you can read them explicitly from AS_ORIGINAL_
STDIN_FD.
Chapter 9: Writing Autoconf Macros 143
of the ‘^_?A[HNUM]_’ namespaces. In general, you should not use the namespace of a package
that does not own the macro or shell code you are writing.
To ensure that your macros don’t conflict with present or future Autoconf macros, you
should prefix your own macro names and any shell variables they use with some other
sequence. Possibilities include your initials, or an abbreviation for the name of your orga-
nization or software package. Historically, people have not always followed the rule of using
a namespace appropriate for their package, and this has made it difficult for determining
the origin of a macro (and where to report bugs about that macro), as well as difficult for
the true namespace owner to add new macros without interference from pre-existing uses
of third-party macros. Perhaps the best example of this confusion is the AM_GNU_GETTEXT
macro, which belongs, not to Automake, but to Gettext.
Most of the Autoconf macros’ names follow a structured naming convention that indi-
cates the kind of feature check by the name. The macro names consist of several words,
separated by underscores, going from most general to most specific. The names of their
cache variables use the same convention (see Section 7.4.1 [Cache Variable Names], page 106,
for more information on them).
The first word of the name after the namepace initials (such as ‘AC_’) usually tells the
category of the feature being tested. Here are the categories used in Autoconf for specific
test macros, the kind of macro that you are more likely to write. They are also used for
cache variables, in all-lowercase. Use them where applicable; where they’re not, invent your
own categories.
C C language builtin features.
DECL Declarations of C variables in header files.
FUNC Functions in libraries.
GROUP Posix group owners of files.
HEADER Header files.
LIB C libraries.
PROG The base names of programs.
MEMBER Members of aggregates.
SYS Operating system features.
TYPE C builtin or declared types.
VAR C variables in libraries.
After the category comes the name of the particular feature being tested. Any further
words in the macro name indicate particular aspects of the feature. For example, AC_PROG_
CC_STDC checks whether the C compiler supports ISO Standard C.
An internal macro should have a name that starts with an underscore; Autoconf internals
should therefore start with ‘_AC_’. Additionally, a macro that is an internal subroutine of
another macro should have a name that starts with an underscore and the name of that
other macro, followed by one or more words saying what the internal macro does. For
example, AC_PATH_X has internal macros _AC_PATH_X_XMKMF and _AC_PATH_X_DIRECT.
Chapter 9: Writing Autoconf Macros 145
When the user runs ‘autoconf -W error’, warnings from m4_warn (including those issued
through AC_DIAGNOSE and AC_WARNING) are reported as errors, see Section 3.4 [autoconf
Invocation], page 10.
AC_DEFUN([RESERVE_DANCE_FLOOR],
[if date | grep ’^Sat.*pm’ >/dev/null 2>&1; then
AC_REQUIRE([TRAVOLTA])
AC_REQUIRE([NEWTON_JOHN])
fi])
with this ‘configure.ac’
AC_INIT([Dance Manager], [1.0], [[email protected]])
RESERVE_DANCE_FLOOR
if test "$dance_floor" = occupied; then
AC_MSG_ERROR([cannot pick up here, let’s move])
fi
does not leave you with a better chance to meet a kindred soul at other times than Saturday
night since it expands into:
test "$body_temperature_in_Celsius" -gt "38" &&
dance_floor=occupied
test "$hair_style" = "curly" &&
dance_floor=occupied
fi
if date | grep ’^Sat.*pm’ >/dev/null 2>&1; then
fi
This behavior was chosen on purpose: (i) it prevents messages in required macros from
interrupting the messages in the requiring macros; (ii) it avoids bad surprises when shell
conditionals are used, as in:
Chapter 9: Writing Autoconf Macros 147
if ...; then
AC_REQUIRE([SOME_CHECK])
fi
...
SOME_CHECK
The helper macros AS_IF and AS_CASE may be used to enforce expansion of required
macros outside of shell conditional constructs. You are furthermore encouraged to put all
AC_REQUIRE calls at the beginning of a macro. You can use dnl to avoid the empty lines
they leave.
No Autoconf macro should ever enter the user-variable name space; i.e., except for the
variables that are the actual result of running the macro, all shell variables should start
with ac_. In addition, small macros or any macro that is likely to be embedded in other
macros should be careful not to use obvious names.
Do not use dnl to introduce comments: most of the comments you are likely to write
are either header comments which are not output anyway, or comments that should make
their way into ‘configure’. There are exceptional cases where you do want to comment
special M4 constructs, in which case dnl is right, but keep in mind that it is unlikely.
M4 ignores the leading blanks and newlines before each argument. Use this feature to
indent in such a way that arguments are (more or less) aligned with the opening parenthesis
of the macro being called. For instance, instead of
AC_CACHE_CHECK(for EMX OS/2 environment,
ac_cv_emxos2,
[AC_COMPILE_IFELSE([AC_LANG_PROGRAM(, [return __EMX__;])],
[ac_cv_emxos2=yes], [ac_cv_emxos2=no])])
write
AC_CACHE_CHECK([for EMX OS/2 environment], [ac_cv_emxos2],
[AC_COMPILE_IFELSE([AC_LANG_PROGRAM([], [return __EMX__;])],
[ac_cv_emxos2=yes],
[ac_cv_emxos2=no])])
or even
AC_CACHE_CHECK([for EMX OS/2 environment],
[ac_cv_emxos2],
[AC_COMPILE_IFELSE([AC_LANG_PROGRAM([],
[return __EMX__;])],
[ac_cv_emxos2=yes],
[ac_cv_emxos2=no])])
When using AC_RUN_IFELSE or any macro that cannot work when cross-compiling, pro-
vide a pessimistic value (typically ‘no’).
Feel free to use various tricks to prevent auxiliary tools, such as syntax-highlighting
editors, from behaving improperly. For instance, instead of:
m4_bpatsubst([$1], [$"])
use
m4_bpatsubst([$1], [$""])
so that Emacsen do not open an endless “string” at the first quote. For the same reasons,
avoid:
test $[#] != 0
and use:
test $[@%:@] != 0
Otherwise, the closing bracket would be hidden inside a ‘#’-comment, breaking the bracket-
matching highlighting from Emacsen. Note the preferred style to escape from M4: ‘$[1]’,
‘$[@]’, etc. Do not escape when it is unnecessary. Common examples of useless quotation
are ‘[$]$1’ (write ‘$$1’), ‘[$]var’ (use ‘$var’), etc. If you add portability issues to the
150 Autoconf
picture, you’ll prefer ‘${1+"$[@]"}’ to ‘"[$]@"’, and you’ll prefer do something better than
hacking Autoconf :-).
When using sed, don’t use ‘-e’ except for indenting purposes. With the s and y com-
mands, the preferred separator is ‘/’ unless ‘/’ itself might appear in the pattern or re-
placement, in which case you should use ‘|’, or optionally ‘,’ if you know the pattern and
replacement cannot contain a file name. If none of these characters will do, choose a print-
able character that cannot appear in the pattern or replacement. Characters from the set
‘"#$&’()*;<=>¿|~’ are good choices if the pattern or replacement might contain a file name,
since they have special meaning to the shell and are less likely to occur in file names.
See Section 9.1 [Macro Definitions], page 143, for details on how to define a macro.
If a macro doesn’t use AC_REQUIRE, is expected to never be the object of an AC_REQUIRE
directive, and macros required by other macros inside arguments do not need to be expanded
before this macro, then use m4_define. In case of doubt, use AC_DEFUN. All the AC_REQUIRE
statements should be at the beginning of the macro, and each statement should be followed
by dnl.
You should not rely on the number of arguments: instead of checking whether an argu-
ment is missing, test that it is not empty. It provides both a simpler and a more predictable
interface to the user, and saves room for further arguments.
Unless the macro is short, try to leave the closing ‘])’ at the beginning of a line, followed
by a comment that repeats the name of the macro being defined. This introduces an
additional newline in configure; normally, that is not a problem, but if you want to remove
it you can use ‘[]dnl’ on the last line. You can similarly use ‘[]dnl’ after a macro call to
remove its newline. ‘[]dnl’ is recommended instead of ‘dnl’ to ensure that M4 does not
interpret the ‘dnl’ as being attached to the preceding text or macro output. For example,
instead of:
AC_DEFUN([AC_PATH_X],
[AC_MSG_CHECKING([for X])
AC_REQUIRE_CPP()
# . . . omitted. . .
AC_MSG_RESULT([libraries $x_libraries, headers $x_includes])
fi])
you would write:
AC_DEFUN([AC_PATH_X],
[AC_REQUIRE_CPP()[]dnl
AC_MSG_CHECKING([for X])
# . . . omitted. . .
AC_MSG_RESULT([libraries $x_libraries, headers $x_includes])
fi[]dnl
])# AC_PATH_X
If the macro is long, try to split it into logical chunks. Typically, macros that check for
a bug in a function and prepare its AC_LIBOBJ replacement should have an auxiliary macro
to perform this setup. Do not hesitate to introduce auxiliary macros to factor your code.
In order to highlight the recommended coding style, here is a macro written the old way:
dnl Check for EMX on OS/2.
dnl _AC_EMXOS2
Chapter 9: Writing Autoconf Macros 151
AC_DEFUN(_AC_EMXOS2,
[AC_CACHE_CHECK(for EMX OS/2 environment, ac_cv_emxos2,
[AC_COMPILE_IFELSE([AC_LANG_PROGRAM(, return __EMX__;)],
ac_cv_emxos2=yes, ac_cv_emxos2=no)])
test "$ac_cv_emxos2" = yes && EMXOS2=yes])
and the new way:
# _AC_EMXOS2
# ----------
# Check for EMX on OS/2.
m4_define([_AC_EMXOS2],
[AC_CACHE_CHECK([for EMX OS/2 environment], [ac_cv_emxos2],
[AC_COMPILE_IFELSE([AC_LANG_PROGRAM([], [return __EMX__;])],
[ac_cv_emxos2=yes],
[ac_cv_emxos2=no])])
test "$ac_cv_emxos2" = yes && EMXOS2=yes[]dnl
])# _AC_EMXOS2
152 Autoconf
Chapter 10: Portable Shell Programming 153
10.1 Shellology
There are several families of shells, most prominently the Bourne family and the C shell
family which are deeply incompatible. If you want to write portable shell scripts, avoid
members of the C shell family. The the Shell difference FAQ includes a small history of
Posix shells, and a comparison between several of them.
Below we describe some of the members of the Bourne shell family.
Ash Ash is often used on GNU/Linux and BSD systems as a light-weight Bourne-
compatible shell. Ash 0.2 has some bugs that are fixed in the 0.3.x series, but
portable shell scripts should work around them, since version 0.2 is still shipped
with many GNU/Linux distributions.
To be compatible with Ash 0.2:
− don’t use ‘$?’ after expanding empty or unset variables, or at the start of
an eval:
foo=
false
$foo
154 Autoconf
Zsh To detect whether you are running zsh, test whether ZSH_VERSION is set. By
default zsh is not compatible with the Bourne shell: you must execute ‘emulate
sh’, and for zsh versions before 3.1.6-dev-18 you must also set NULLCMD to ‘:’.
See section “Compatibility” in The Z Shell Manual, for details.
The default Mac OS X sh was originally Zsh; it was changed to Bash in Mac
OS X 10.2.
The following discussion between Russ Allbery and Robert Lipe is worth reading:
Russ Allbery:
The GNU assumption that /bin/sh is the one and only shell leads to a perma-
nent deadlock. Vendors don’t want to break users’ existing shell scripts, and
there are some corner cases in the Bourne shell that are not completely com-
patible with a Posix shell. Thus, vendors who have taken this route will never
(OK. . . “never say never”) replace the Bourne shell (as /bin/sh) with a Posix
shell.
Robert Lipe:
This is exactly the problem. While most (at least most System V’s) do have
a Bourne shell that accepts shell functions most vendor /bin/sh programs are
not the Posix shell.
So while most modern systems do have a shell somewhere that meets the Posix
standard, the challenge is to find it.
10.2 Here-Documents
Don’t rely on ‘\’ being preserved just because it has no special meaning together with the
next symbol. In the native sh on OpenBSD 2.7 ‘\"’ expands to ‘"’ in here-documents with
unquoted delimiter. As a general rule, if ‘\\’ expands to ‘\’ use ‘\\’ to get ‘\’.
With OpenBSD 2.7’s sh
$ cat <<EOF
> \" \\
> EOF
" \
and with Bash:
bash-2.04$ cat <<EOF
> \" \\
> EOF
\" \
Some shells mishandle large here-documents: for example, Solaris 10 dtksh and the
UnixWare 7.1.1 Posix shell, which are derived from Korn shell version M-12/28/93d, mis-
handle braced variable expansion that crosses a 1024- or 4096-byte buffer boundary within
a here-document. Only the part of the variable name after the boundary is used. For
example, ${variable} could be replaced by the expansion of ${ble}. If the end of the
variable name is aligned with the block boundary, the shell reports an error, as if you used
${}. Instead of ${variable-default}, the shell may expand ${riable-default}, or even
${fault}. This bug can often be worked around by omitting the braces: $variable. The
156 Autoconf
bug was fixed in ‘ksh93g’ (1998-04-30) but as of 2006 many operating systems were still
shipping older versions with the bug.
Many shells (including the Bourne shell) implement here-documents inefficiently. In
particular, some shells can be extremely inefficient when a single statement contains many
here-documents. For instance if your ‘configure.ac’ includes something like:
if <cross_compiling>; then
assume this and that
else
check this
check that
check something else
...
on and on forever
...
fi
A shell parses the whole if/fi construct, creating temporary files for each here-document
in it. Some shells create links for such here-documents on every fork, so that the clean-up
code they had installed correctly removes them. It is creating the links that can take the
shell forever.
Moving the tests out of the if/fi, or creating multiple if/fi constructs, would improve
the performance significantly. Anyway, this kind of construct is not exactly the typical use
of Autoconf. In fact, it’s even not recommended, because M4 macros can’t look into shell
conditionals, so we may fail to expand a macro when it was expanded before in a conditional
path, and the condition turned out to be false at runtime, and we end up not executing the
macro at all.
foo
One workaround is to grep out uninteresting lines, hoping not to remove good ones.
If you intend to redirect both standard error and standard output, redirect standard
output first. This works better with HP-UX, since its shell mishandles tracing if standard
error is redirected first:
$ sh -x -c ’: 2>err >out’
+ :
+ 2> err $ cat err
1> out
Don’t try to redirect the standard error of a command substitution. It must be done
inside the command substitution. When running ‘: ‘cd /zorglub‘ 2>/dev/null’ expect
the error message to escape, while ‘: ‘cd /zorglub 2>/dev/null‘’ works properly.
It is worth noting that Zsh (but not Ash nor Bash) makes it possible in assignments
though: ‘foo=‘cd /zorglub‘ 2>/dev/null’.
When catering to old systems, don’t redirect the same file descriptor several times, as
you are doomed to failure under Ultrix.
ULTRIX V4.4 (Rev. 69) System #31: Thu Aug 10 19:42:23 GMT 1995
UWS V4.4 (Rev. 11)
$ eval ’echo matter >fullness’ >void
illegal io
$ eval ’(echo matter >fullness)’ >void
illegal io
$ (eval ’(echo matter >fullness)’) >void
Ambiguous output redirect.
In each case the expected result is of course ‘fullness’ containing ‘matter’ and ‘void’
being empty. However, this bug is probably not of practical concern to modern platforms.
Don’t rely on file descriptors 0, 1, and 2 remaining closed in a subsidiary program. If
any of these descriptors is closed, the operating system may open an unspecified file for the
descriptor in the new process image. Posix says this may be done only if the subsidiary
program is set-user-ID or set-group-ID, but HP-UX 11.23 does it even for ordinary programs.
Don’t rely on open file descriptors being open in child processes. In ksh, file descriptors
above 2 which are opened using ‘exec n >file’ are closed by a subsequent ‘exec’ (such as
that involved in the fork-and-exec which runs a program or script). Thus, using sh, we
have:
$ cat ./descrips
#!/bin/sh -
echo hello >&5
$ exec 5>t
$ ./descrips
$ cat t
hello
$
But using ksh:
158 Autoconf
$ exec 5>t
$ ./descrips
hello
$ cat t
$
Within the process which runs the ‘descrips’ script, file descriptor 5 is closed.
DOS variants cannot rename or remove open files, such as in ‘mv foo bar >foo’ or ‘rm
foo >foo’, even though this is perfectly portable among Posix hosts.
A few ancient systems reserved some file descriptors. By convention, file descriptor 3 was
opened to ‘/dev/tty’ when you logged into Eighth Edition (1985) through Tenth Edition
Unix (1989). File descriptor 4 had a special use on the Stardent/Kubota Titan (circa 1990),
though we don’t now remember what it was. Both these systems are obsolete, so it’s now
safe to treat file descriptors 3 and 4 like any other file descriptors.
case $foo_dir in
[\\/]* | ?:[\\/]* ) # Absolute
;;
*)
foo_dir=$dots$foo_dir ;;
esac
Make sure you quote the brackets if appropriate and keep the backslash as first character
(see Section 10.12 [Limitations of Builtins], page 171).
Also, because the colon is used as part of a drivespec, these systems don’t use it as
path separator. When creating or accessing paths, you can use the PATH_SEPARATOR output
variable instead. configure sets this to the appropriate value for the build system (‘:’ or
‘;’) when it starts up.
File names need extra care as well. While DOS variants that are Posixy enough to run
autoconf (such as DJGPP) are usually able to handle long file names properly, there are
still limitations that can seriously break packages. Several of these issues can be easily
detected by the doschk package.
A short overview follows; problems are marked with sfn/lfn to indicate where they
apply: sfn means the issues are only relevant to plain DOS, not to DOS under Microsoft
Windows variants, while lfn identifies problems that exist even under Microsoft Windows
variants.
Worse yet, not all shells understand "‘...\"...\"...‘" the same way. There is just no
portable way to use double-quoted strings inside double-quoted back-quoted expressions
(pfew!).
$@ One of the most famous shell-portability issues is related to ‘"$@"’. When there
are no positional arguments, Posix says that ‘"$@"’ is supposed to be equivalent
to nothing, but the original Unix version 7 Bourne shell treated it as equivalent
to ‘""’ instead, and this behavior survives in later implementations like Digital
Unix 5.0.
The traditional way to work around this portability problem is to use
‘${1+"$@"}’. Unfortunately this method does not work with Zsh (3.x and
4.x), which is used on Mac OS X. When emulating the Bourne shell, Zsh
performs word splitting on ‘${1+"$@"}’:
zsh $ emulate sh
zsh $ for i in "$@"; do echo $i; done
Hello World
!
zsh $ for i in ${1+"$@"}; do echo $i; done
Hello
World
!
Zsh handles plain ‘"$@"’ properly, but we can’t use plain ‘"$@"’ because of the
portability problems mentioned above. One workaround relies on Zsh’s “global
aliases” to convert ‘${1+"$@"}’ into ‘"$@"’ by itself:
test "${ZSH_VERSION+set}" = set && alias -g ’${1+"$@"}’=’"$@"’
Zsh only recognizes this alias when a shell word matches it exactly;
‘"foo"${1+"$@"}’ remains subject to word splitting. Since this case always
yields at least one shell word, use plain ‘"$@"’.
A more conservative workaround is to avoid ‘"$@"’ if it is possible that there
may be no positional arguments. For example, instead of:
cat conftest.c "$@"
you can use this instead:
case $# in
0) cat conftest.c;;
*) cat conftest.c "$@";;
esac
Autoconf macros often use the set command to update ‘$@’, so if you are writing
shell code intended for configure you should not assume that the value of ‘$@’
persists for any length of time.
${10} The 10th, 11th, . . . positional parameters can be accessed only after a shift.
The 7th Edition shell reported an error if given ${10}, and Solaris 10 /bin/sh
still acts that way:
$ set 1 2 3 4 5 6 7 8 9 10
$ echo ${10}
bad substitution
162 Autoconf
${var :-value }
Old BSD shells, including the Ultrix sh, don’t accept the colon for any shell
substitution, and complain and die. Similarly for ${var:=value}, ${var:?value},
etc.
${var =literal }
Be sure to quote:
: ${var=’Some words’}
otherwise some shells, such as on Digital Unix V 5.0, die because of a “bad
substitution”.
Solaris /bin/sh has a frightening bug in its interpretation of this. Imagine you
need set a variable to a string containing ‘}’. This ‘}’ character confuses Solaris
/bin/sh when the affected variable was already set. This bug can be exercised
by running:
$ unset foo
$ foo=${foo=’}’}
$ echo $foo
}
$ foo=${foo=’}’ # no error; this hints to what the bug is
$ echo $foo
}
$ foo=${foo=’}’}
$ echo $foo
}}
^ ugh!
It seems that ‘}’ is interpreted as matching ‘${’, even though it is enclosed in
single quotes. The problem doesn’t happen using double quotes.
${var =expanded-value }
On Ultrix, running
default="yu,yaa"
: ${var="$default"}
sets var to ‘M-yM-uM-,M-yM-aM-a’, i.e., the 8th bit of each char is set. You
don’t observe the phenomenon using a simple ‘echo $var’ since apparently the
shell resets the 8th bit when it expands $var. Here are two means to make this
shell confess its sins:
$ cat -v <<EOF
$var
EOF
and
$ set | grep ’^var=’ | cat -v
One classic incarnation of this bug is:
default="a b c"
: ${list="$default"}
Chapter 10: Portable Shell Programming 163
for c in $list; do
echo $c
done
You’ll get ‘a b c’ on a single line. Why? Because there are no spaces in ‘$list’:
there are ‘M- ’, i.e., spaces with the 8th bit set, hence no IFS splitting is per-
formed!!!
One piece of good news is that Ultrix works fine with ‘: ${list=$default}’;
i.e., if you don’t quote. The bad news is then that QNX 4.25 then sets list to
the last item of default!
The portable way out consists in using a double assignment, to switch the 8th
bit twice on Ultrix:
list=${list="$default"}
. . . but beware of the ‘}’ bug from Solaris (see above). For safety, use:
test "${var+set}" = set || var={value}
${#var }
${var %word }
${var %%word }
${var #word }
${var ##word }
Posix requires support for these usages, but they do not work with many tra-
ditional shells, e.g., Solaris 10 /bin/sh.
Also, pdksh 5.2.14 mishandles some word forms. For example if ‘$1’ is ‘a/b’
and ‘$2’ is ‘a’, then ‘${1#$2}’ should yield ‘/b’, but with pdksh it yields the
empty string.
‘commands ‘
Posix requires shells to trim all trailing newlines from command output before
substituting it, so assignments like ‘dir=‘echo "$file" | tr a A‘’ do not work
as expected if ‘$file’ ends in a newline.
While in general it makes no sense, do not substitute a single builtin with side
effects, because Ash 0.2, trying to optimize, does not fork a subshell to perform
the command.
For instance, if you wanted to check that cd is silent, do not use ‘test -z "‘cd
/‘"’ because the following can happen:
$ pwd
/tmp
$ test -z "‘cd /‘" && pwd
/
The result of ‘foo=‘exit 1‘’ is left as an exercise to the reader.
The MSYS shell leaves a stray byte in the expansion of a double-quoted com-
mand substitution of a native program, if the end of the substitution is not
aligned with the end of the double quote. This may be worked around by
inserting another pair of quotes:
$ echo "‘printf ’foo\r\n’‘ bar" > broken
164 Autoconf
10.7 Assignments
When setting several variables in a row, be aware that the order of the evaluation is unde-
fined. For instance ‘foo=1 foo=2; echo $foo’ gives ‘1’ with Solaris /bin/sh, but ‘2’ with
Bash. You must use ‘;’ to enforce the order: ‘foo=1; foo=2; echo $foo’.
Don’t rely on the following to find ‘subdir/program’:
PATH=subdir$PATH_SEPARATOR$PATH program
as this does not work with Zsh 3.0.6. Use something like this instead:
(PATH=subdir$PATH_SEPARATOR$PATH; export PATH; exec program)
Don’t rely on the exit status of an assignment: Ash 0.2 does not change the status and
propagates that of the last statement:
Chapter 10: Portable Shell Programming 165
/
$ set -x
$ echo abc | tr -t ab //
+ echo abc
+ tr -t ab /
/bc
Unpatched Tru64 4.0 sh adds a slash after ‘"$var"’ if the variable is empty and the
second double-quote is followed by a word that begins and ends with slash:
$ sh -xc ’p=; echo "$p"/ouch/’
p=
+ echo //ouch/
//ouch/
However, our understanding is that patches are available, so perhaps it’s not worth
worrying about working around these horrendous bugs.
LANGUAGE
LC_ADDRESS
LC_IDENTIFICATION
LC_MEASUREMENT
LC_NAME
LC_PAPER
LC_TELEPHONE
These locale environment variables are GNU extensions. They are treated like
their Posix brethren (LC_COLLATE, etc.) as described above.
LINENO Most modern shells provide the current line number in LINENO. Its value is
the line number of the beginning of the current command. Autoconf attempts
to execute configure with a shell that supports LINENO. If no such shell is
available, it attempts to implement LINENO with a Sed prepass that replaces
each instance of the string $LINENO (not followed by an alphanumeric character)
with the line’s number.
You should not rely on LINENO within eval, as the behavior differs in practice.
Also, the possibility of the Sed prepass means that you should not rely on
$LINENO when quoted, when in here-documents, or when in long commands
that cross line boundaries. Subshells should be OK, though. In the following
example, lines 1, 6, and 9 are portable, but the other instances of LINENO are
not:
$ cat lineno
echo 1. $LINENO
cat <<EOF
3. $LINENO
4. $LINENO
EOF
( echo 6. $LINENO )
eval ’echo 7. $LINENO’
echo 8. ’$LINENO’
echo 9. $LINENO ’
10.’ $LINENO
Chapter 10: Portable Shell Programming 169
$ bash-2.05 lineno
1. 1
3. 2
4. 2
6. 6
7. 1
8. $LINENO
9. 9
10. 9
$ zsh-3.0.6 lineno
1. 1
3. 2
4. 2
6. 6
7. 7
8. $LINENO
9. 9
10. 9
$ pdksh-5.2.14 lineno
1. 1
3. 2
4. 2
6. 6
7. 0
8. $LINENO
9. 9
10. 9
$ sed ’=’ <lineno |
> sed ’
> N
> s,$,-,
> t loop
> :loop
> s,^\([0-9]*\)\(.*\)[$]LINENO\([^a-zA-Z0-9_]\),\1\2\1\3,
> t loop
> s,-$,,
> s,^[0-9]*\n,,
> ’ |
> sh
1. 1
3. 3
4. 4
6. 6
7. 7
8. 8
9. 9
10. 10
170 Autoconf
NULLCMD When executing the command ‘>foo’, zsh executes ‘$NULLCMD >foo’ unless it
is operating in Bourne shell compatibility mode and the zsh version is newer
than 3.1.6-dev-18. If you are using an older zsh and forget to set NULLCMD, your
script might be suspended waiting for data on its standard input.
PATH_SEPARATOR
On DJGPP systems, the PATH_SEPARATOR environment variable can be set to
either ‘:’ or ‘;’ to control the path separator Bash uses to set up certain envi-
ronment variables (such as PATH). You can set this variable to ‘;’ if you want
configure to use ‘;’ as a separator; this might be useful if you plan to use
non-Posix shells to execute files. See Section 10.4 [File System Conventions],
page 158, for more information about PATH_SEPARATOR.
PWD Posix 1003.1-2001 requires that cd and pwd must update the PWD environment
variable to point to the logical name of the current directory, but traditional
shells do not support this. This can cause confusion if one shell instance main-
tains PWD but a subsidiary and different shell does not know about PWD and
executes cd; in this case PWD points to the wrong directory. Use ‘‘pwd‘’ rather
than ‘$PWD’.
RANDOM Many shells provide RANDOM, a variable that returns a different integer each
time it is used. Most of the time, its value does not change when it is not used,
but on irix 6.5 the value changes all the time. This can be observed by using
set. It is common practice to use $RANDOM as part of a file name, but code
shouldn’t rely on $RANDOM expanding to a nonempty string.
status This variable is an alias to ‘$?’ for zsh (at least 3.1.6), hence read-only. Do not
use it.
With AIX sh, a trap on 0 installed in a shell function triggers at function exit rather
than at script exit, see See Section 10.12 [Limitations of Builtins], page 171.
You don’t need the final ‘;;’, but you should use it.
Posix requires support for case patterns with opening parentheses like this:
case $file_name in
(*.c) echo "C source code";;
esac
but the ( in this example is not portable to many Bourne shell implementations.
It can be omitted safely.
Zsh handles pattern fragments derived from parameter expansions or command
substitutions as though quoted:
$ pat=\?; case aa in ?$pat) echo match;; esac
$ pat=\?; case a? in ?$pat) echo match;; esac
match
Because of a bug in its fnmatch, Bash fails to properly handle backslashes in
character classes:
bash-2.02$ case /tmp in [/\\]*) echo OK;; esac
bash-2.02$
This is extremely unfortunate, since you are likely to use this code to handle
Posix or ms-dos absolute file names. To work around this bug, always put the
backslash first:
bash-2.02$ case ’\TMP’ in [\\/]*) echo OK;; esac
OK
bash-2.02$ case /tmp in [\\/]*) echo OK;; esac
OK
Many Bourne shells cannot handle closing brackets in character classes correctly.
Some shells also have problems with backslash escaping in case you do not want
to match the backslash: both a backslash and the escaped character match this
pattern. To work around this, specify the character class in a variable, so that
quote removal does not apply afterwards, and the special characters don’t have
to be backslash-escaped:
$ case ’\’ in [\<]) echo OK;; esac
OK
$ scanset=’[<]’; case ’\’ in $scanset) echo OK;; esac
$
Even with this, Solaris ksh matches a backslash if the set contains any of the
characters ‘|’, ‘&’, ‘(’, or ‘)’.
Conversely, Tru64 ksh (circa 2003) erroneously always matches a closing paren-
thesis if not specified in a character class:
$ case foo in *\)*) echo fail ;; esac
fail
$ case foo in *’)’*) echo fail ;; esac
fail
Some shells, such as Ash 0.3.8, are confused by an empty case/esac:
ash-0.3.8 $ case foo in esac;
Chapter 10: Portable Shell Programming 173
‘cat test?.c’, ‘eval $cmd’ might expand to the equivalent of ‘cat test;.c’ if
there happens to be a file named ‘test;.c’ in the current directory; and this
in turn mistakenly attempts to invoke cat on the file ‘test’ and then execute
the command .c. To avoid this problem, use ‘eval "$cmd"’ rather than ‘eval
$cmd’.
However, suppose that you want to output the text of the evaluated command
just before executing it. Assuming the previous example, ‘echo "Executing:
$cmd"’ outputs ‘Executing: cat test?.c’, but this output doesn’t show the
user that ‘test;.c’ is the actual name of the copied file. Conversely, ‘eval
"echo Executing: $cmd"’ works on this example, but it fails with ‘cmd=’cat
foo >bar’’, since it mistakenly replaces the contents of ‘bar’ by the string ‘cat
foo’. No simple, general, and portable solution to this problem is known.
You should also be wary of common bugs in eval implementations. In
some shell implementations (e.g., older ash, OpenBSD 3.8 sh, pdksh v5.2.14
99/07/13.2, and zsh 4.2.5), the arguments of ‘eval’ are evaluated in a context
where ‘$?’ is 0, so they exhibit behavior like this:
$ false; eval ’echo $?’
0
The correct behavior here is to output a nonzero value, but portable scripts
should not rely on this.
You should not rely on LINENO within eval. See Section 10.10 [Special Shell
Variables], page 166.
exit The default value of exit is supposed to be $?; unfortunately, some shells, such
as the DJGPP port of Bash 2.04, just perform ‘exit 0’.
bash-2.04$ foo=‘exit 1‘ || echo fail
fail
bash-2.04$ foo=‘(exit 1)‘ || echo fail
fail
bash-2.04$ foo=‘(exit 1); exit‘ || echo fail
bash-2.04$
Using ‘exit $?’ restores the expected behavior.
Some shell scripts, such as those generated by autoconf, use a trap to clean
up before exiting. If the last shell command exited with nonzero status, the
trap also exits with nonzero status so that the invoker can tell that an error
occurred.
Unfortunately, in some shells, such as Solaris /bin/sh, an exit trap ignores the
exit command’s argument. In these shells, a trap cannot determine whether
it was invoked by plain exit or by exit 1. Instead of calling exit directly, use
the AC_MSG_ERROR macro that has a workaround for this problem.
export The builtin export dubs a shell variable environment variable. Each update
of exported variables corresponds to an update of the environment variables.
Conversely, each environment variable received by the shell when it is launched
should be imported as a shell variable marked as exported.
Chapter 10: Portable Shell Programming 175
Alas, many shells, such as Solaris /bin/sh, irix 6.3, irix 5.2, AIX 4.1.5, and
Digital Unix 4.0, forget to export the environment variables they receive. As
a result, two variables coexist: the environment variable and the shell variable.
The following code demonstrates this failure:
#!/bin/sh
echo $FOO
FOO=bar
echo $FOO
exec /bin/sh $0
when run with ‘FOO=foo’ in the environment, these shells print alternately ‘foo’
and ‘bar’, although they should print only ‘foo’ and then a sequence of ‘bar’s.
Therefore you should export again each environment variable that you update.
false Don’t expect false to exit with status 1: in native Solaris ‘/bin/false’ exits
with status 255.
for To loop over positional arguments, use:
for arg
do
echo "$arg"
done
You may not leave the do on the same line as for, since some shells improperly
grok:
for arg; do
echo "$arg"
done
If you want to explicitly refer to the positional arguments, given the ‘$@’ bug
(see Section 10.6 [Shell Substitutions], page 160), use:
for arg in ${1+"$@"}; do
echo "$arg"
done
But keep in mind that Zsh, even in Bourne shell emulation mode, performs
word splitting on ‘${1+"$@"}’; see Section 10.6 [Shell Substitutions], page 160,
item ‘$@’, for more.
if Using ‘!’ is not portable. Instead of:
if ! cmp -s file file.new; then
mv file.new file
fi
use:
if cmp -s file file.new; then :; else
mv file.new file
fi
There are shells that do not reset the exit status from an if:
$ if (exit 42); then true; fi; echo $?
176 Autoconf
42
whereas a proper shell should have printed ‘0’. This is especially bad in make-
files since it produces false failures. This is why properly written makefiles,
such as Automake’s, have such hairy constructs:
if test -f "$file"; then
install "$file" "$dest"
else
:
fi
printf A format string starting with a ‘-’ can cause problems. Bash interprets it as an
option and gives an error. And ‘--’ to mark the end of options is not good in
the NetBSD Almquist shell (e.g., 0.4.6) which takes that literally as the format
string. Putting the ‘-’ in a ‘%c’ or ‘%s’ is probably easiest:
printf %s -foo
Bash 2.03 mishandles an escape sequence that happens to evaluate to ‘%’:
$ printf ’\045’
bash: printf: ‘%’: missing format character
Large outputs may cause trouble. On Solaris 2.5.1 through 10, for example,
‘/usr/bin/printf’ is buggy, so when using /bin/sh the command ‘printf
%010000x 123’ normally dumps core.
read Not all shells support ‘-r’ (Solaris /bin/sh for example).
pwd With modern shells, plain pwd outputs a “logical” directory name, some of
whose components may be symbolic links. These directory names are in contrast
to “physical” directory names, whose components are all directories.
Posix 1003.1-2001 requires that pwd must support the ‘-L’ (“logical”) and ‘-P’
(“physical”) options, with ‘-L’ being the default. However, traditional shells do
not support these options, and their pwd command has the ‘-P’ behavior.
Portable scripts should assume neither option is supported, and should assume
neither behavior is the default. Also, on many hosts ‘/bin/pwd’ is equivalent to
‘pwd -P’, but Posix does not require this behavior and portable scripts should
not rely on it.
Typically it’s best to use plain pwd. On modern hosts this outputs logical
directory names, which have the following advantages:
• Logical names are what the user specified.
• Physical names may not be portable from one installation host to another
due to network file system gymnastics.
• On modern hosts ‘pwd -P’ may fail due to lack of permissions to some
parent directory, but plain pwd cannot fail for this reason.
Also please see the discussion of the cd command.
set With the FreeBSD 6.0 shell, the set command (without any options) does not
sort its output.
Chapter 10: Portable Shell Programming 177
The set builtin faces the usual problem with arguments starting with a dash.
Modern shells such as Bash or Zsh understand ‘--’ to specify the end of the
options (any argument after ‘--’ is a parameter, even ‘-x’ for instance), but
many traditional shells (e.g., Solaris 10 /bin/sh) simply stop option processing
as soon as a non-option argument is found. Therefore, use ‘dummy’ or simply
‘x’ to end the option processing, and use shift to pop it out:
set x $my_list; shift
Avoid ‘set -’, e.g., ‘set - $my_list’. Posix no longer requires support for this
command, and in traditional shells ‘set - $my_list’ resets the ‘-v’ and ‘-x’
options, which makes scripts harder to debug.
Some nonstandard shells do not recognize more than one option (e.g., ‘set -e
-x’ assigns ‘-x’ to the command line). It is better to combine them:
set -ex
The BSD shell has had several problems with the ‘-e’ option, partly because
BSD make traditionally used ‘-e’ even though this was incompatible with Posix
(see Section 11.2 [Failure in Make Rules], page 195). Older versions of the
BSD shell (circa 1990) mishandled ‘&&’, ‘||’, ‘if’, and ‘case’ when ‘-e’ was in
effect, causing the shell to exit unexpectedly in some cases. This was particu-
larly a problem with makefiles, and led to circumlocutions like ‘sh -c ’test -f
file || touch file’’, where the seemingly-unnecessary ‘sh -c ’...’’ wrap-
per works around the bug.
Even relatively-recent versions of the BSD shell (e.g., OpenBSD 3.4) wrongly
exit with ‘-e’ if a command within ‘&&’ fails inside a compound statement. For
example:
#! /bin/sh
set -e
foo=’’
test -n "$foo" && exit 1
echo one
if :; then
test -n "$foo" && exit 1
fi
echo two
does not print ‘two’. One workaround is to use ‘if test -n "$foo"; then exit
1; fi’ rather than ‘test -n "$foo" && exit 1’. Another possibility is to warn
BSD users not to use ‘sh -e’.
shift Not only is shifting a bad idea when there is nothing left to shift, but in
addition it is not portable: the shell of MIPS RISC/OS 4.52 refuses to do it.
Don’t use ‘shift 2’ etc.; it was not in the 7th Edition Bourne shell, and it is
also absent in many pre-Posix shells.
source This command is not portable, as Posix does not require it; use . instead.
test The test program is the way to perform many file and string tests. It is often
invoked by the alternate name ‘[’, but using that name in Autoconf code is
asking for trouble since it is an M4 quote character.
178 Autoconf
The ‘-a’, ‘-o’, ‘(’, and ‘)’ operands are not portable and should be avoided.
Thus, portable uses of test should never have more than four arguments, and
scripts should use shell constructs like ‘&&’ and ‘||’ instead. If you combine ‘&&’
and ‘||’ in the same statement, keep in mind that they have equal precedence,
so it is often better to parenthesize even when this is redundant. For example:
# Not portable:
test "X$a" = "X$b" -a \
’(’ "X$c" != "X$d" -o "X$e" = "X$f" ’)’
# Portable:
test "X$a" = "X$b" &&
{ test "X$c" != "X$d" || test "X$e" = "X$f"; }
test does not process options like most other commands do; for example, it
does not recognize the ‘--’ argument as marking the end of options.
It is safe to use ‘!’ as a test operator. For example, ‘if test ! -d foo; ...’
is portable even though ‘if ! test -d foo; ...’ is not.
test (files)
To enable configure scripts to support cross-compilation, they shouldn’t do
anything that tests features of the build system instead of the host system.
But occasionally you may find it necessary to check whether some arbitrary file
exists. To do so, use ‘test -f’ or ‘test -r’. Do not use ‘test -x’, because
4.3BSD does not have it. Do not use ‘test -e’ either, because Solaris /bin/sh
lacks it. To test for symbolic links on systems that have them, use ‘test -h’
rather than ‘test -L’; either form conforms to Posix 1003.1-2001, but older
shells like Solaris 8 /bin/sh support only ‘-h’.
test (strings)
Posix says that ‘test "string "’ succeeds if string is not null, but this usage is
not portable to traditional platforms like Solaris 10 /bin/sh, which mishandle
strings like ‘!’ and ‘-n’.
Posix also says that ‘test ! "string "’, ‘test -n "string "’ and ‘test -z
"string "’ work with any string, but many shells (such as Solaris, AIX 3.2,
unicos 10.0.0.6, Digital Unix 4, etc.) get confused if string looks like an
operator:
$ test -n =
test: argument expected
$ test ! -n
test: argument expected
Similarly, Posix says that both ‘test "string1 " = "string2"’ and ‘test
"string1 " != "string2"’ work for any pairs of strings, but in practice this
is not true for troublesome strings that look like operators or parentheses, or
that begin with ‘-’.
It is best to protect such strings with a leading ‘X’, e.g., ‘test "Xstring " !=
X’ rather than ‘test -n "string "’ or ‘test ! "string "’.
It is common to find variations of the following idiom:
test -n "‘echo $ac_feature | sed ’s/[-a-zA-Z0-9_]//g’‘" &&
Chapter 10: Portable Shell Programming 179
action
to take an action when a token matches a given pattern. Such constructs should
be avoided by using:
case $ac_feature in
*[!-a-zA-Z0-9_]*) action ;;
esac
If the pattern is a complicated regular expression that cannot be expressed as
a shell pattern, use something like this instead:
expr "X$ac_feature" : ’X.*[^-a-zA-Z0-9_]’ >/dev/null &&
action
‘expr "Xfoo " : "Xbar "’ is more robust than ‘echo "Xfoo " | grep "^Xbar "’,
because it avoids problems when ‘foo ’ contains backslashes.
trap It is safe to trap at least the signals 1, 2, 13, and 15. You can also trap 0, i.e.,
have the trap run when the script ends (either via an explicit exit, or the end
of the script). The trap for 0 should be installed outside of a shell function, or
AIX 5.3 /bin/sh will invoke the trap at the end of this function.
Posix says that ‘trap - 1 2 13 15’ resets the traps for the specified signals to
their default values, but many common shells (e.g., Solaris /bin/sh) misinter-
pret this and attempt to execute a “command” named - when the specified
conditions arise. There is no portable workaround, except for ‘trap - 0’, for
which ‘trap ’’ 0’ is a portable substitute.
Although Posix is not absolutely clear on this point, it is widely admitted that
when entering the trap ‘$?’ should be set to the exit status of the last command
run before the trap. The ambiguity can be summarized as: “when the trap is
launched by an exit, what is the last command run: that before exit, or exit
itself?”
Bash considers exit to be the last command, while Zsh and Solaris /bin/sh
consider that when the trap is run it is still in the exit, hence it is the previous
exit status that the trap receives:
$ cat trap.sh
trap ’echo $?’ 0
(exit 42); exit 0
$ zsh trap.sh
42
$ bash trap.sh
0
The portable solution is then simple: when you want to ‘exit 42’, run ‘(exit
42); exit 42’, the first exit being used to set the exit status to 42 for Zsh,
and the second to trigger the trap and pass 42 as exit status for Bash.
The shell in FreeBSD 4.0 has the following bug: ‘$?’ is reset to 0 by empty lines
if the code is inside trap.
$ trap ’false
echo $?’ 0
180 Autoconf
$ exit
0
Fortunately, this bug only affects trap.
true Don’t worry: as far as we know true is portable. Nevertheless, it’s not always a
builtin (e.g., Bash 1.x), and the portable shell community tends to prefer using
:. This has a funny side effect: when asked whether false is more portable
than true Alexandre Oliva answered:
In a sense, yes, because if it doesn’t exist, the shell will produce an
exit status of failure, which is correct for false, but not for true.
unset In some nonconforming shells (e.g., Bash 2.05a), unset FOO fails when FOO is
not set. Also, Bash 2.01 mishandles unset MAIL in some cases and dumps core.
A few ancient shells lack unset entirely. Nevertheless, because it is extremely
useful to disable embarrassing variables such as PS1, you can test for its ex-
istence and use it provided you give a neutralizing value when unset is not
supported:
# "|| exit" suppresses any "Segmentation fault" message.
if ( (MAIL=60; unset MAIL) || exit) >/dev/null 2>&1; then
unset=unset
else
unset=false
fi
$unset PS1 || PS1=’$ ’
See Section 10.10 [Special Shell Variables], page 166, for some neutralizing val-
ues. Also, see Section 10.12 [Limitations of Builtins], page 171, documentation
of export, for the case of environment variables.
Posix says that in an ‘END’ action, ‘$NF’ (and presumably, ‘$1’) retain their
value from the last record read, if no intervening ‘getline’ occurred. However,
some implementations (such as Solaris 10 ‘/usr/bin/awk’, ‘nawk’, or Darwin
‘awk’) reset these variables. A workaround is to use an intermediate variable
prior to the ‘END’ block. For example:
$ cat end.awk
{ tmp = $1 }
END { print "a", $1, $NF, "b", tmp }
$ echo 1 | awk -f end.awk
a b 1
$ echo 1 | gawk -f end.awk
a 1 1 b 1
If you want your program to be deterministic, don’t depend on for on arrays:
$ cat for.awk
END {
arr["foo"] = 1
arr["bar"] = 1
for (i in arr)
print i
}
$ gawk -f for.awk </dev/null
foo
bar
$ nawk -f for.awk </dev/null
bar
foo
Some Awk implementations, such as HP-UX 11.0’s native one, mishandle an-
chors:
$ echo xfoo | $AWK ’/foo|^bar/ { print }’
$ echo bar | $AWK ’/foo|^bar/ { print }’
bar
$ echo xfoo | $AWK ’/^bar|foo/ { print }’
xfoo
$ echo bar | $AWK ’/^bar|foo/ { print }’
bar
Either do not depend on such patterns (i.e., use ‘/^(.*foo|bar)/’, or use a
simple test to reject such implementations.
On ‘ia64-hp-hpux11.23’, Awk mishandles printf conversions after %u:
$ awk ’BEGIN { printf "%u %d\n", 0, -1 }’
0 0
AIX version 5.2 has an arbitrary limit of 399 on the length of regular expressions
and literal strings in an Awk program.
Traditional Awk implementations derived from Unix version 7, such as Solaris
/bin/awk, have many limitations and do not conform to Posix. Nowadays AC_
PROG_AWK (see Section 5.2.1 [Particular Programs], page 39) finds you an Awk
182 Autoconf
that doesn’t have these problems, but if for some reason you prefer not to use
AC_PROG_AWK you may need to address them.
Traditional Awk does not support multidimensional arrays or user-defined func-
tions.
Traditional Awk does not support the ‘-v’ option. You can use assignments af-
ter the program instead, e.g., $AWK ’{print v $1}’ v=x; however, don’t forget
that such assignments are not evaluated until they are encountered (e.g., after
any BEGIN action).
Traditional Awk does not support the keywords delete or do.
Traditional Awk does not support the expressions a ?b :c , !a , a ^b , or a ^=b .
Traditional Awk does not support the predefined CONVFMT variable.
Traditional Awk supports only the predefined functions exp, index, int,
length, log, split, sprintf, sqrt, and substr.
Traditional Awk getline is not at all compatible with Posix; avoid it.
Traditional Awk has for (i in a) ... but no other uses of the in keyword.
For example, it lacks if (i in a) ....
In code portable to both traditional and modern Awk, FS must be a string
containing just one ordinary character, and similarly for the field-separator
argument to split.
Traditional Awk has a limit of 99 fields in a record. Since some Awk imple-
mentations, like Tru64’s, split the input even if you don’t refer to any field in
the script, to circumvent this problem, set ‘FS’ to an unusual character and use
split.
Traditional Awk has a limit of at most 99 bytes in a number formatted by OFMT;
for example, OFMT="%.300e"; print 0.1; typically dumps core.
The original version of Awk had a limit of at most 99 bytes per split field, 99
bytes per substr substring, and 99 bytes per run of non-special characters in
a printf format, but these bugs have been fixed on all practical hosts that we
know of.
basename Not all hosts have a working basename. You can use expr instead.
cat Don’t rely on any option.
cc The command ‘cc -c foo.c’ traditionally produces an object file named
‘foo.o’. Most compilers allow ‘-c’ to be combined with ‘-o’ to specify a
different object file name, but Posix does not require this combination and a
few compilers lack support for it. See Section 5.10.3 [C Compiler], page 72, for
how GNU Make tests for this feature with AC_PROG_CC_C_O.
When a compilation such as ‘cc -o foo foo.c’ fails, some compilers (such as
cds on Reliant Unix) leave a ‘foo.o’.
HP-UX cc doesn’t accept ‘.S’ files to preprocess and assemble. ‘cc -c foo.S’
appears to succeed, but in fact does nothing.
The default executable, produced by ‘cc foo.c’, can be
• ‘a.out’ — usual Posix convention.
Chapter 10: Portable Shell Programming 183
In Unix System V any user can chown files to any other user, and System V
also has a non-sticky ‘/tmp’. That probably derives from the heritage of System
V in a business environment without hostile users. BSD changed this to be a
more secure model where only root can chown files and a sticky ‘/tmp’ is used.
That undoubtedly derives from the heritage of BSD in a campus environment.
GNU/Linux and Solaris by default follow BSD, but can be configured to allow
a System V style chown. On the other hand, HP-UX follows System V, but can
be configured to use the modern security model and disallow chown. Since it is
an administrator-configurable parameter you can’t use the name of the kernel
as an indicator of the behavior.
date Some versions of date do not recognize special ‘%’ directives, and unfortunately,
instead of complaining, they just pass them through, and exit with success:
$ uname -a
OSF1 medusa.sis.pasteur.fr V5.1 732 alpha
$ date "+%s"
%s
diff Option ‘-u’ is nonportable.
Some implementations, such as Tru64’s, fail when comparing to ‘/dev/null’.
Use an empty file instead.
dirname Not all hosts have a working dirname, and you should instead use AS_DIRNAME
(see Section 8.4 [Programming in M4sh], page 139). For example:
dir=‘dirname "$file"‘ # This is not portable.
dir=‘AS_DIRNAME(["$file"])‘ # This is more portable.
egrep Posix 1003.1-2001 no longer requires egrep, but many hosts do not yet support
the Posix replacement grep -E. Also, some traditional implementations do not
work on long input lines. To work around these problems, invoke AC_PROG_
EGREP and then use $EGREP.
Portable extended regular expressions should use ‘\’ only to escape characters
in the string ‘$()*+.?[\^{|’. For example, ‘\}’ is not portable, even though it
typically matches ‘}’.
The empty alternative is not portable. Use ‘?’ instead. For instance with Digital
Unix v5.0:
> printf "foo\n|foo\n" | $EGREP ’^(|foo|bar)$’
|foo
> printf "bar\nbar|\n" | $EGREP ’^(foo|bar|)$’
bar|
> printf "foo\nfoo|\n|bar\nbar\n" | $EGREP ’^(foo||bar)$’
foo
|bar
$EGREP also suffers the limitations of grep.
expr No expr keyword starts with ‘X’, so use ‘expr X"word " : ’Xregex ’’ to keep
expr from misinterpreting word.
Don’t use length, substr, match and index.
Chapter 10: Portable Shell Programming 185
expr (‘|’) You can use ‘|’. Although Posix does require that ‘expr ’’’ return the empty
string, it does not specify the result when you ‘|’ together the empty string (or
zero) with the empty string. For example:
expr ’’ \| ’’
Posix 1003.2-1992 returns the empty string for this case, but traditional Unix
returns ‘0’ (Solaris is one such example). In Posix 1003.1-2001, the specification
was changed to match traditional Unix’s behavior (which is bizarre, but it’s too
late to fix this). Please note that the same problem does arise when the empty
string results from a computation, as in:
expr bar : foo \| foo : bar
Avoid this portability problem by avoiding the empty string.
expr (‘:’) Portable expr regular expressions should use ‘\’ to escape only characters in the
string ‘$()*.0123456789[\^n{}’. For example, alternation, ‘\|’, is common
but Posix does not require its support, so it should be avoided in portable
scripts. Similarly, ‘\+’ and ‘\?’ should be avoided.
Portable expr regular expressions should not begin with ‘^’. Patterns are au-
tomatically anchored so leading ‘^’ is not needed anyway.
The Posix standard is ambiguous as to whether ‘expr ’a’ : ’\(b\)’’ outputs
‘0’ or the empty string. In practice, it outputs the empty string on most plat-
forms, but portable scripts should not assume this. For instance, the QNX 4.25
native expr returns ‘0’.
One might think that a way to get a uniform behavior would be to use the
empty string as a default value:
expr a : ’\(b\)’ \| ’’
Unfortunately this behaves exactly as the original expression; see the expr (‘|’)
entry for more information.
Some ancient expr implementations (e.g., SunOS 4 expr and Solaris 8
/usr/ucb/expr) have a silly length limit that causes expr to fail if the
matched substring is longer than 120 bytes. In this case, you might want to
fall back on ‘echo|sed’ if expr fails. Nowadays this is of practical importance
only for the rare installer who mistakenly puts ‘/usr/ucb’ before ‘/usr/bin’
in PATH.
On Mac OS X 10.4, expr mishandles the pattern ‘[^-]’ in some cases. For
example, the command
expr Xpowerpc-apple-darwin8.1.0 : ’X[^-]*-[^-]*-\(.*\)’
outputs ‘apple-darwin8.1.0’ rather than the correct ‘darwin8.1.0’. This
particular case can be worked around by substituting ‘[^--]’ for ‘[^-]’.
Don’t leave, there is some more!
The QNX 4.25 expr, in addition of preferring ‘0’ to the empty string, has a
funny behavior in its exit status: it’s always 1 when parentheses are used!
$ val=‘expr ’a’ : ’a’‘; echo "$?: $val"
0: 1
$ val=‘expr ’a’ : ’b’‘; echo "$?: $val"
186 Autoconf
1: 0
Also, many implementations do not support multiple regexps with ‘-e’: they
either reject ‘-e’ entirely (e.g., Solaris) or honor only the last pattern (e.g.,
IRIX 6.5 and NeXT). To work around these problems, invoke AC_PROG_GREP
and then use $GREP.
Another possible workaround for the multiple ‘-e’ problem is to separate the
patterns by newlines, for example:
grep ’foo
bar’ in.txt
except that this fails with traditional grep implementations and with OpenBSD
3.8 grep.
Traditional grep implementations (e.g., Solaris) do not support the ‘-E’ or ‘-F’
options. To work around these problems, invoke AC_PROG_EGREP and then use
$EGREP, and similarly for AC_PROG_FGREP and $FGREP. Even if you are willing
to require support for Posix grep, your script should not use both ‘-E’ and ‘-F’,
since Posix does not allow this combination.
Portable grep regular expressions should use ‘\’ only to escape characters in
the string ‘$()*.0123456789[\^{}’. For example, alternation, ‘\|’, is common
but Posix does not require its support in basic regular expressions, so it should
be avoided in portable scripts. Solaris and HP-UX grep do not support it.
Similarly, the following escape sequences should also be avoided: ‘\<’, ‘\>’,
‘\+’, ‘\?’, ‘\‘’, ‘\’’, ‘\B’, ‘\b’, ‘\S’, ‘\s’, ‘\W’, and ‘\w’.
Posix does not specify the behavior of grep on binary files. An example where
this matters is using BSD grep to search text that includes embedded ANSI
escape sequences for colored output to terminals (‘\033[m’ is the sequence to
restore normal output); the behavior depends on whether input is seekable:
$ printf ’esc\033[mape\n’ > sample
$ grep . sample
Binary file sample matches
$ cat sample | grep .
escape
join Solaris 8 join has bugs when the second operand is standard input, and when
standard input is a pipe. For example, the following shell script causes Solaris
8 join to loop forever:
cat >file <<’EOF’
1 x
2 y
EOF
cat file | join file -
Use ‘join - file’ instead.
ln Don’t rely on ln having a ‘-f’ option. Symbolic links are not available on old
systems; use ‘$(LN_S)’ as a portable substitute.
For versions of the DJGPP before 2.04, ln emulates symbolic links to executables
by generating a stub that in turn calls the real program. This feature also works
with nonexistent files like in the Posix spec. So ‘ln -s file link’ generates
188 Autoconf
‘link.exe’, which attempts to call ‘file.exe’ if run. But this feature only
works for executables, so ‘cp -p’ is used instead for these systems. DJGPP
versions 2.04 and later have full support for symbolic links.
ls The portable options are ‘-acdilrtu’. Current practice is for ‘-l’ to output
both owner and group, even though ancient versions of ls omitted the group.
On ancient hosts, ‘ls foo’ sent the diagnostic ‘foo not found’ to standard
output if ‘foo’ did not exist. Hence a shell command like ‘sources=‘ls *.c
2>/dev/null‘’ did not always work, since it was equivalent to ‘sources=’*.c
not found’’ in the absence of ‘.c’ files. This is no longer a practical problem,
since current ls implementations send diagnostics to standard error.
mkdir No mkdir option is portable to older systems. Instead of ‘mkdir -p file-
name ’, you should use AS_MKDIR_P(file-name ) (see Section 8.4 [Programming
in M4sh], page 139) or AC_PROG_MKDIR_P (see Section 5.2.1 [Particular Pro-
grams], page 39).
Combining the ‘-m’ and ‘-p’ options, as in ‘mkdir -m go-w -p dir ’, often leads
to trouble. FreeBSD mkdir incorrectly attempts to change the permissions of
dir even if it already exists. HP-UX 11.23 and IRIX 6.5 mkdir often assign the
wrong permissions to any newly-created parents of dir.
Posix does not clearly specify whether ‘mkdir -p foo’ should succeed when ‘foo’
is a symbolic link to an already-existing directory. The GNU Core Utilities 5.1.0
mkdir succeeds, but Solaris mkdir fails.
Traditional mkdir -p implementations suffer from race conditions. For example,
if you invoke mkdir -p a/b and mkdir -p a/c at the same time, both processes
might detect that ‘a’ is missing, one might create ‘a’, then the other might try
to create ‘a’ and fail with a File exists diagnostic. The GNU Core Utilities
(‘fileutils’ version 4.1), FreeBSD 5.0, NetBSD 2.0.2, and OpenBSD 2.4 are
known to be race-free when two processes invoke mkdir -p simultaneously, but
earlier versions are vulnerable. Solaris mkdir is still vulnerable as of Solaris
10, and other traditional Unix systems are probably vulnerable too. This pos-
sible race is harmful in parallel builds when several Make rules call mkdir -p
to construct directories. You may use install-sh -d as a safe replacement,
provided this script is recent enough; the copy shipped with Autoconf 2.60 and
Automake 1.10 is OK, but copies from older versions are vulnerable.
mktemp Shell scripts can use temporary files safely with mktemp, but it does not exist
on all systems. A portable way to create a safe temporary file name is to create
a temporary directory with mode 700 and use a file inside this directory. Both
methods prevent attackers from gaining control, though mktemp is far less likely
to fail gratuitously under attack.
Here is sample code to create a new temporary directory safely:
# Create a temporary directory $tmp in $TMPDIR (default /tmp).
# Use mktemp if possible; otherwise fall back on mkdir,
# with $RANDOM to make collisions less likely.
: ${TMPDIR=/tmp}
{
Chapter 10: Portable Shell Programming 189
tmp=‘
(umask 077 && mktemp -d "$TMPDIR/fooXXXXXX") 2>/dev/null
‘ &&
test -n "$tmp" && test -d "$tmp"
} || {
tmp=$TMPDIR/foo$$-$RANDOM
(umask 077 && mkdir "$tmp")
} || exit $?
mv The only portable options are ‘-f’ and ‘-i’.
Moving individual files between file systems is portable (it was in Unix version
6), but it is not always atomic: when doing ‘mv new existing’, there’s a critical
section where neither the old nor the new version of ‘existing’ actually exists.
On some systems moving files from ‘/tmp’ can sometimes cause undesirable
(but perfectly valid) warnings, even if you created these files. This is because
‘/tmp’ belongs to a group that ordinary users are not members of, and files
created in ‘/tmp’ inherit the group of ‘/tmp’. When the file is copied, mv issues
a diagnostic without failing:
$ touch /tmp/foo
$ mv /tmp/foo .
error mv: ./foo: set owner/group (was: 100/0): Operation not permitted
$ echo $?
0
$ ls foo
foo
This annoying behavior conforms to Posix, unfortunately.
Moving directories across mount points is not portable, use cp and rm.
DOS variants cannot rename or remove open files, and do not support com-
mands like ‘mv foo bar >foo’, even though this is perfectly portable among
Posix hosts.
od
In Mac OS X 10.3, od does not support the standard Posix options ‘-A’, ‘-j’,
‘-N’, or ‘-t’, or the XSI option ‘-s’. The only supported Posix option is ‘-v’,
and the only supported XSI options are those in ‘-bcdox’. The BSD hexdump
program can be used instead.
This problem no longer exists in Mac OS X 10.4.3.
rm The ‘-f’ and ‘-r’ options are portable.
It is not portable to invoke rm without operands. For example, on many systems
‘rm -f -r’ (with no other arguments) silently succeeds without doing anything,
but it fails with a diagnostic on NetBSD 2.0.2.
A file might not be removed even if its parent directory is writable and search-
able. Many Posix hosts cannot remove a mount point, a named stream, a
working directory, or a last link to a file that is being executed.
DOS variants cannot rename or remove open files, and do not support commands
like ‘rm foo >foo’, even though this is perfectly portable among Posix hosts.
190 Autoconf
sed Patterns should not include the separator (unless escaped), even as part of a
character class. In conformance with Posix, the Cray sed rejects ‘s/[^/]*$//’:
use ‘s,[^/]*$,,’.
Avoid empty patterns within parentheses (i.e., ‘\(\)’). Posix does not require
support for empty patterns, and Unicos 9 sed rejects them.
Unicos 9 sed loops endlessly on patterns like ‘.*\n.*’.
Sed scripts should not use branch labels longer than 7 characters and should
not contain comments. HP-UX sed has a limit of 99 commands (not counting
‘:’ commands) and 48 labels, which can not be circumvented by using more
than one script file. It can execute up to 19 reads with the ‘r’ command per
cycle. Solaris /usr/ucb/sed rejects usages that exceed an limit of about 6000
bytes for the internal representation of commands.
Avoid redundant ‘;’, as some sed implementations, such as NetBSD 1.4.2’s,
incorrectly try to interpret the second ‘;’ as a command:
$ echo a | sed ’s/x/x/;;s/x/x/’
sed: 1: "s/x/x/;;s/x/x/": invalid command code ;
Input should not have unreasonably long lines, since some sed implementations
have an input buffer limited to 4000 bytes.
Portable sed regular expressions should use ‘\’ only to escape characters in the
string ‘$()*.0123456789[\^n{}’. For example, alternation, ‘\|’, is common
but Posix does not require its support, so it should be avoided in portable
scripts. Solaris sed does not support alternation; e.g., ‘sed ’/a\|b/d’’ deletes
only lines that contain the literal string ‘a|b’. Similarly, ‘\+’ and ‘\?’ should
be avoided.
Anchors (‘^’ and ‘$’) inside groups are not portable.
Nested parentheses in patterns (e.g., ‘\(\(a*\)b*)\)’) are quite portable to
current hosts, but was not supported by some ancient sed implementations like
SVR3.
Some sed implementations, e.g., Solaris, restrict the special role of the asterisk
to one-character regular expressions. This may lead to unexpected behavior:
$ echo ’1*23*4’ | /usr/bin/sed ’s/\(.\)*/x/g’
x2x4
$ echo ’1*23*4’ | /usr/xpg4/bin/sed ’s/\(.\)*/x/g’
x
The ‘-e’ option is mostly portable. However, its argument cannot start with
‘a’, ‘c’, or ‘i’, as this runs afoul of a Tru64 5.1 bug. Also, its argument cannot
be empty, as this fails on AIX 5.3. Some people prefer to use ‘-e’:
sed -e ’command-1 ’ \
-e ’command-2 ’
as opposed to the equivalent:
sed ’
command-1
command-2
’
Chapter 10: Portable Shell Programming 191
Posix requires that with an empty regular expression, the last non-empty regu-
lar expression from either an address specification or substitution command is
applied. However, busybox 1.6.1 complains when using a substitution command
with a replacement containing a back-reference to an empty regular expression;
the workaround is repeating the regular expression.
$ echo abc | busybox sed ’/a\(b\)c/ s//\1/’
sed: No previous regexp.
$ echo abc | busybox sed ’/a\(b\)c/ s/a\(b\)c/\1/’
b
sed (‘t’) Some old systems have sed that “forget” to reset their ‘t’ flag when starting
a new cycle. For instance on MIPS RISC/OS, and on irix 5.3, if you run the
following sed script (the line numbers are not actual part of the texts):
s/keep me/kept/g # a
t end # b
s/.*/deleted/g # c
:end # d
on
delete me # 1
delete me # 2
keep me # 3
delete me # 4
you get
deleted
delete me
kept
deleted
instead of
deleted
deleted
kept
deleted
Why? When processing line 1, (c) matches, therefore sets the ‘t’ flag, and the
output is produced. When processing line 2, the ‘t’ flag is still set (this is the
bug). Command (a) fails to match, but sed is not supposed to clear the ‘t’
flag when a substitution fails. Command (b) sees that the flag is set, therefore
it clears it, and jumps to (d), hence you get ‘delete me’ instead of ‘deleted’.
When processing line (3), ‘t’ is clear, (a) matches, so the flag is set, hence (b)
clears the flags and jumps. Finally, since the flag is clear, line 4 is processed
properly.
There are two things one should remember about ‘t’ in sed. Firstly, always
remember that ‘t’ jumps if some substitution succeeded, not only the imme-
diately preceding substitution. Therefore, always use a fake ‘t clear’ followed
by a ‘:clear’ on the next line, to reset the ‘t’ flag where needed.
Secondly, you cannot rely on sed to clear the flag at each new cycle.
Chapter 10: Portable Shell Programming 193
BAR = two
test:
: FOO is "$(FOO)"
: BAR is "$(BAR)"
shows FOO equal to one BAR = two. Other implementations sensibly let a backslash continue
only to the immediately following line.
all:
@echo ok
$ make # GNU make
ok
However this is not always the case. Some implementations discard everything from #
through the end of the line, ignoring any trailing backslash.
$ pmake # BSD make
"Makefile", line 3: Need an operator
Fatal errors encountered -- cannot continue
Therefore, if you want to comment out a multi-line definition, prefix each line with #, not
only the first.
# A = foo \
# bar \
# baz
subsidiary invocations of make. Some other implementations do not pass the substitution
along to submakes.
$ cat Makefile
foo = foo
one:
@echo $(foo)
$(MAKE) two
two:
@echo $(foo)
$ make foo=bar # GNU make 3.79.1
bar
make two
make[1]: Entering directory ‘/home/adl’
bar
make[1]: Leaving directory ‘/home/adl’
$ pmake foo=bar # BSD make
bar
pmake two
foo
You have a few possibilities if you do want the foo=bar override to propagate to sub-
makes. One is to use the ‘-e’ option, which causes all environment variables to have
precedence over the makefile macro definitions, and declare foo as an environment variable:
$ env foo=bar make -e
The ‘-e’ option is propagated to submakes automatically, and since the environment is
inherited between make invocations, the foo macro is overridden in submakes as expected.
This syntax (foo=bar make -e) is portable only when used outside of a makefile, for
instance from a script or from the command line. When run inside a make rule, GNU make
3.80 and prior versions forget to propagate the ‘-e’ option to submakes.
Moreover, using ‘-e’ could have unexpected side effects if your environment contains
some other macros usually defined by the makefile. (See also the note about make -e and
SHELL below.)
Another way to propagate overrides to submakes is to do it manually, from your makefile:
foo = foo
one:
@echo $(foo)
$(MAKE) foo=$(foo) two
two:
@echo $(foo)
You need to foresee all macros that a user might want to override if you do that.
in effect. For example, you cannot assume that the first space-separated word in $MAKEFLAGS
contains single-letter options, since in the Cygwin version of GNU make it is either ‘--unix’
or ‘--win32’ with the second word containing single-letter options.
$ cat Makefile
all:
@echo MAKEFLAGS = $(MAKEFLAGS)
$ make
MAKEFLAGS = --unix
$ make -k
MAKEFLAGS = --unix -k
Some make treat anything starting with a tab as a command for the current rule, even
if the tab is immediately followed by a #. The make from Tru64 Unix V5.1 is one of them.
The following makefile runs # foo through the shell.
all:
# foo
complicated and are often poorly understood, and installers who use VPATH should expect
to find many bugs in this area. If you use VPATH, the simplest way to avoid these portability
bugs is to stick with GNU make, since it is the most commonly-used make among Autoconf
users.
Here are some known issues with some VPATH implementations.
cp $? $@
but this does not generalize well to commands with multiple prerequisites. A more general
workaround is to rewrite the rule so that the prerequisite ‘if.c’ never appears as a plain
word. For example, these three rules would be safe, assuming ‘if.c’ is in ‘../pkg/src’ and
the other files are in the working directory:
VPATH = ../pkg/src
f.c: if.c f1.c
cat ‘test -f ./if.c || echo $(VPATH)/‘if.c f1.c >$@
g.c: if.c g1.c
cat ‘test -f ’if.c’ || echo $(VPATH)/‘if.c g1.c >$@
h.c: if.c h1.c
cat ‘test -f "if.c" || echo $(VPATH)/‘if.c h1.c >$@
Things get worse when your prerequisites are in a macro.
VPATH = ../pkg/src
HEADERS = f.h g.h h.h
install-HEADERS: $(HEADERS)
for i in $(HEADERS); do \
$(INSTALL) -m 644 \
‘test -f $$i || echo $(VPATH)/‘$$i \
$(DESTDIR)$(includedir)/$$i; \
done
The above install-HEADERS rule is not Solaris-proof because for i in $(HEADERS);
is expanded to for i in f.h g.h h.h; where f.h and g.h are plain words and are hence
subject to VPATH adjustments.
If the three files are in ‘../pkg/src’, the rule is run as:
for i in ../pkg/src/f.h ../pkg/src/g.h h.h; do \
install -m 644 \
‘test -f $i || echo ../pkg/src/‘$i \
/usr/local/include/$i; \
done
where the two first install calls fail. For instance, consider the f.h installation:
install -m 644 \
‘test -f ../pkg/src/f.h || \
echo ../pkg/src/ \
‘../pkg/src/f.h \
/usr/local/include/../pkg/src/f.h;
It reduces to:
install -m 644 \
../pkg/src/f.h \
/usr/local/include/../pkg/src/f.h;
Note that the manual VPATH search did not cause any problems here; however this
command installs ‘f.h’ in an incorrect directory.
Trying to quote $(HEADERS) in some way, as we did for foo.c a few makefiles ago, does
not help:
202 Autoconf
install-HEADERS: $(HEADERS)
headers=’$(HEADERS)’; \
for i in $$headers; do \
$(INSTALL) -m 644 \
‘test -f $$i || echo $(VPATH)/‘$$i \
$(DESTDIR)$(includedir)/$$i; \
done
Now, headers=’$(HEADERS)’ macro-expands to:
headers=’f.h g.h h.h’
but g.h is still a plain word. (As an aside, the idiom headers=’$(HEADERS)’; for i in
$$headers; is a good idea if $(HEADERS) can be empty, because some shells diagnose a
syntax error on for i in;.)
One workaround is to strip this unwanted ‘../pkg/src/’ prefix manually:
VPATH = ../pkg/src
HEADERS = f.h g.h h.h
install-HEADERS: $(HEADERS)
headers=’$(HEADERS)’; \
for i in $$headers; do \
i=‘expr "$$i" : ’$(VPATH)/\(.*\)’‘;
$(INSTALL) -m 644 \
‘test -f $$i || echo $(VPATH)/‘$$i \
$(DESTDIR)$(includedir)/$$i; \
done
Automake does something similar. However the above hack works only if the files listed
in HEADERS are in the current directory or a subdirectory; they should not be in an enclosing
directory. If we had HEADERS = ../f.h, the above fragment would fail in a VPATH build
with Tru64 make. The reason is that not only does Tru64 make rewrite dependencies, but it
also simplifies them. Hence ../f.h becomes ../pkg/f.h instead of ../pkg/src/../f.h.
This obviously defeats any attempt to strip a leading ‘../pkg/src/’ component.
The following example makes the behavior of Tru64 make more apparent.
$ cat Makefile
VPATH = sub
all: ../foo
echo ../foo
$ ls
Makefile foo
$ make
echo foo
foo
Dependency ‘../foo’ was found in ‘sub/../foo’, but Tru64 make simplified it as ‘foo’.
(Note that the ‘sub/’ directory does not even exist, this just means that the simplification
occurred before the file was checked for.)
For the record here is how SunOS 4 make behaves on this example.
$ make
make: Fatal error: Don’t know how to make target ‘../foo’
Chapter 11: Portable Make Programming 203
$ mkdir sub
$ make
echo sub/../foo
sub/../foo
@echo Building $@
$ touch ../bar.x
$ touch ../newer.x
$ make # GNU make
Building foo.x
Building bar.x
$ pmake # NetBSD make
Building foo.x
Building ../bar.x
$ fmake # FreeBSD make, OpenBSD make
Building foo.x
Building bar.x
$ tmake # Tru64 make
Building foo.x
Building bar.x
$ touch ../bar.x
$ make # GNU make
Building foo.x
$ pmake # NetBSD make
Building foo.x
$ fmake # FreeBSD make, OpenBSD make
Building foo.x
Building bar.x
$ tmake # Tru64 make
Building foo.x
Building bar.x
Note how NetBSD make updates ‘../bar.x’ in its VPATH location, and how FreeBSD,
OpenBSD, and Tru64 make always update ‘bar.x’, even when ‘../bar.x’ is up to date.
Another point worth mentioning is that once GNU make has decided to ignore a VPATH
file name (e.g., it ignored ‘../bar.x’ in the above example) it continues to ignore it when
the target occurs as a prerequisite of another rule.
The following example shows that GNU make does not look up ‘bar.x’ in VPATH before
performing the .x.y rule, because it ignored the VPATH result of ‘bar.x’ while running the
bar.x: newer.x rule.
$ cat Makefile
VPATH = ..
all: bar.y
bar.x: newer.x
@echo Building $@
.SUFFIXES: .x .y
.x.y:
cp $< $@
$ touch ../bar.x
$ touch ../newer.x
$ make # GNU make
Building bar.x
Chapter 11: Portable Make Programming 205
cp bar.x bar.y
cp: cannot stat ‘bar.x’: No such file or directory
make: *** [bar.y] Error 1
$ pmake # NetBSD make
Building ../bar.x
cp ../bar.x bar.y
$ rm bar.y
$ fmake # FreeBSD make, OpenBSD make
echo Building bar.x
cp bar.x bar.y
cp: cannot stat ‘bar.x’: No such file or directory
*** Error code 1
$ tmake # Tru64 make
Building bar.x
cp: bar.x: No such file or directory
*** Exit 1
Note that if you drop away the command from the bar.x: newer.x rule, GNU make
magically starts to work: it knows that bar.x hasn’t been updated, therefore it doesn’t
discard the result from VPATH (‘../bar.x’) in succeeding uses. Tru64 also works, but
FreeBSD and OpenBSD still don’t.
$ cat Makefile
VPATH = ..
all: bar.y
bar.x: newer.x
.SUFFIXES: .x .y
.x.y:
cp $< $@
$ touch ../bar.x
$ touch ../newer.x
$ make # GNU make
cp ../bar.x bar.y
$ rm bar.y
$ pmake # NetBSD make
cp ../bar.x bar.y
$ rm bar.y
$ fmake # FreeBSD make, OpenBSD make
cp bar.x bar.y
cp: cannot stat ‘bar.x’: No such file or directory
*** Error code 1
$ tmake # Tru64 make
cp ../bar.x bar.y
It seems the sole solution that would please every make implementation is to never rely
on VPATH searches for targets. In other words, VPATH should be reserved to unbuilt sources.
206 Autoconf
Normally this is not a problem, but in some extreme cases you may need to use tricks like
‘sleep 1’ to work around timestamp truncation bugs.
Commands like ‘cp -p’ and ‘touch -r’ typically do not copy file timestamps to their full
resolutions (see Section 10.13 [Limitations of Usual Tools], page 180). Hence you should be
wary of rules like this:
dest: src
cp -p src dest
as ‘dest’ often appears to be older than ‘src’ after the timestamp is truncated, and this
can cause make to do needless rework the next time it is invoked. To work around this
problem, you can use a timestamp file, e.g.:
dest-stamp: src
cp -p src dest
date >dest-stamp
208 Autoconf
Chapter 12: Portable C and C++ Programming 209
C and C++ programs often use low-level features of the underlying system, and therefore
are often more difficult to make portable to other platforms.
Several standards have been developed to help make your programs more portable. If
you write programs with these standards in mind, you can have greater confidence that your
programs work on a wide variety of systems. See section “Language Standards Supported
by GCC” in Using the GNU Compiler Collection (GCC), for a list of C-related standards.
Many programs also assume the Posix standard.
Some old code is written to be portable to K&R C, which predates any C standard. K&R
C compilers are no longer of practical interest, though, and the rest of section assumes at
least C89, the first C standard.
Program portability is a huge topic, and this section can only briefly introduce common
pitfalls. See section “Portability between System Types” in GNU Coding Standards, for
more information.
Here, the loop attempts to iterate through all powers of 2 that int can represent, but the
C standard allows a compiler to optimize away the comparison and generate an infinite
loop, under the argument that behavior is undefined on overflow. As of this writing this
optimization is not done by any production version of GCC with ‘-O2’, but it might be
performed by other compilers, or by more aggressive GCC optimization options, and the
GCC developers have not decided whether it will continue to work with GCC and ‘-O2’.
If you add or multiply two numbers to calculate an array size, e.g., malloc (x * sizeof
y + z), havoc ensues if the addition or multiplication overflows.
Many implementations of the alloca function silently misbehave and can generate buffer
overflows if given sizes that are too large. The size limits are implementation dependent,
but are at least 4000 bytes on all platforms that we know about.
The standard functions asctime, asctime_r, ctime, ctime_r, and gets are prone to
buffer overflows, and portable code should not use them unless the inputs are known to
be within certain limits. The time-related functions can overflow their buffers if given
timestamps out of range (e.g., a year less than -999 or greater than 9999). Time-related
buffer overflows cannot happen with recent-enough versions of the GNU C library, but
are possible with other implementations. The gets function is the worst, since it almost
invariably overflows its buffer when presented with an input line larger than the buffer.
Programmers often wish that volatile meant “Perform the memory access here and
now, without merging several memory accesses, without changing the memory word size,
and without reordering.” But the C standard does not require this. For objects defined with
a volatile type, accesses must be done before the next sequence point; but otherwise merging,
reordering, and word-size change is allowed. Worse, it is not clear from the standard whether
volatile lvalues provide more guarantees in general than nonvolatile lvalues, if the underlying
objects are ordinary.
Even when accessing objects defined with a volatile type, the C standard allows only
extremely limited signal handlers: the behavior is undefined if a signal handler reads any
nonlocal object, or writes to any nonlocal object whose type is not sig_atomic_t volatile,
or calls any standard library function other than abort, signal, and (if C99) _Exit. Hence
C compilers need not worry about a signal handler disturbing ordinary computation, unless
the computation accesses a sig_atomic_t volatile lvalue that is not a local variable.
(There is an obscure exception for accesses via a pointer to a volatile character, since it
may point into part of a sig_atomic_t volatile object.) Posix adds to the list of library
functions callable from a portable signal handler, but otherwise is like the C standard in
this area.
Some C implementations allow memory-access optimizations within each translation
unit, such that actual behavior agrees with the behavior required by the standard only when
calling a function in some other translation unit, and a signal handler acts like it was called
from a different translation unit. The C standard hints that in these implementations,
objects referred to by signal handlers “would require explicit specification of volatile
storage, as well as other implementation-defined restrictions.” But unfortunately even for
this special case these other restrictions are often not documented well. See section “When
is a Volatile Object Accessed?” in Using the GNU Compiler Collection (GCC), for some
restrictions imposed by GCC. See section “Defining Signal Handlers” in The GNU C Library,
for some restrictions imposed by the GNU C library. Restrictions differ on other platforms.
If possible, it is best to use a signal handler that fits within the limits imposed by the C
and Posix standards.
If this is not practical, you can try the following rules of thumb. A signal handler should
access only volatile lvalues, preferably lvalues that refer to objects defined with a volatile
type, and should not assume that the accessed objects have an internally consistent state if
they are larger than a machine word. Furthermore, installers should employ compilers and
compiler options that are commonly used for building operating system kernels, because
kernels often need more from volatile than the C Standard requires, and installers who
compile an application in a similar environment can sometimes benefit from the extra con-
straints imposed by kernels on compilers. Admittedly we are handwaving somewhat here,
as there are few guarantees in this area; the rules of thumb may help to fix some bugs but
there is a good chance that they will not fix them all.
For volatile, C++ has the same problems that C does. Multithreaded applications have
even more problems with volatile, but they are beyond the scope of this section.
The bottom line is that using volatile typically hurts performance but should not hurt
correctness. In some cases its use does help correctness, but these cases are often so poorly
understood that all too often adding volatile to a data structure merely alleviates some
symptoms of a bug while not fixing the bug in general.
Chapter 12: Portable C and C++ Programming 217
13 Manual Configuration
A few kinds of features can’t be guessed automatically by running test programs. For
example, the details of the object-file format, or special options that need to be passed
to the compiler or linker. You can check for such features using ad-hoc means, such as
having configure check the output of the uname program, or looking for libraries that are
unique to particular systems. However, Autoconf provides a uniform method for handling
unguessable features.
make bogus assumptions on the host: if you know what you are doing, please create symbolic
links from the host compiler to the build compiler.
configure recognizes short aliases for many system types; for example, ‘decstation’
can be used instead of ‘mips-dec-ultrix4.2’. configure runs a script called config.sub
to canonicalize system type aliases.
This section deliberately omits the description of the obsolete interface; see Section 17.6.3
[Hosts and Cross-Compilation], page 258.
AC_CANONICAL_BUILD [Macro]
Compute the canonical build-system type variable, build, and its three individual
parts build_cpu, build_vendor, and build_os.
If ‘--build’ was specified, then build is the canonicalization of build_alias by
config.sub, otherwise it is determined by the shell script config.guess.
AC_CANONICAL_HOST [Macro]
Compute the canonical host-system type variable, host, and its three individual parts
host_cpu, host_vendor, and host_os.
If ‘--host’ was specified, then host is the canonicalization of host_alias by
config.sub, otherwise it defaults to build.
AC_CANONICAL_TARGET [Macro]
Compute the canonical target-system type variable, target, and its three individual
parts target_cpu, target_vendor, and target_os.
If ‘--target’ was specified, then target is the canonicalization of target_alias by
config.sub, otherwise it defaults to host.
Note that there can be artifacts due to the backward compatibility code. See See Sec-
tion 17.6.3 [Hosts and Cross-Compilation], page 258, for more.
Chapter 13: Manual Configuration 221
14 Site Configuration
configure scripts support several kinds of local configuration decisions. There are ways for
users to specify where external software packages are, include or exclude optional features,
install programs under modified names, and set default values for configure options.
Optional Packages:
...
--with-foo use foo
AC_PRESERVE_HELP_ORDER [Macro]
Request an alternate ‘--help’ format, in which options of all types appear together,
in the order defined. Call this macro before any AC_ARG_ENABLE or AC_ARG_WITH.
Optional Features and Packages:
...
--enable-bar include bar
--with-foo use foo
For each external software package that may be used, ‘configure.ac’ should call AC_
ARG_WITH to detect whether the configure user asked to use it. Whether each package is
used or not by default, and which arguments are valid, is up to you.
LIBREADLINE=
AS_IF([test "x$with_readline" != xno],
[AC_CHECK_LIB([readline], [main],
[AC_SUBST([LIBREADLINE], ["-lreadline -lncurses"])
AC_DEFINE([HAVE_LIBREADLINE], [1],
[Define if you have libreadline])
],
[if test "x$with_readline" != xcheck; then
AC_MSG_FAILURE(
[--with-readline was given, but test for readline failed])
fi
], -lncurses)])
Chapter 14: Site Configuration 225
The next example shows how to use AC_ARG_WITH to give the user the possibility to
enable support for the readline library, in case it is still experimental and not well
tested, and is therefore disabled by default.
AC_ARG_WITH([readline],
[AS_HELP_STRING([--with-readline],
[enable experimental support for readline])],
[],
[with_readline=no])
LIBREADLINE=
AS_IF([test "x$with_readline" != xno],
[AC_CHECK_LIB([readline], [main],
[AC_SUBST([LIBREADLINE], ["-lreadline -lncurses"])
AC_DEFINE([HAVE_LIBREADLINE], [1],
[Define if you have libreadline])
],
[AC_MSG_FAILURE(
[--with-readline was given, but test for readline failed])],
[-lncurses])])
The last example shows how to use AC_ARG_WITH to give the user the possibility to
disable support for the readline library, given that it is an important feature and that
it should be enabled by default.
AC_ARG_WITH([readline],
[AS_HELP_STRING([--without-readline],
[disable support for readline])],
[],
[with_readline=yes])
LIBREADLINE=
AS_IF([test "x$with_readline" != xno],
[AC_CHECK_LIB([readline], [main],
[AC_SUBST([LIBREADLINE], ["-lreadline -lncurses"])
AC_DEFINE([HAVE_LIBREADLINE], [1],
[Define if you have libreadline])
],
[AC_MSG_FAILURE(
[readline test failed (--without-readline to disable)])],
[-lncurses])])
These three examples can be easily adapted to the case where AC_ARG_ENABLE should
be preferred to AC_ARG_WITH (see Section 14.3 [Package Options], page 225).
--enable-feature [=arg ]
--disable-feature
These options allow users to choose which optional features to build and install.
‘--enable-feature ’ options should never make a feature behave differently or cause one
feature to replace another. They should only cause parts of the program to be built rather
than left out.
The user can give an argument by following the feature name with ‘=’ and the argument.
Giving an argument of ‘no’ requests that the feature not be made available. A feature with
an argument looks like ‘--enable-debug=stabs’. If no argument is given, it defaults to
‘yes’. ‘--disable-feature ’ is equivalent to ‘--enable-feature =no’.
Normally configure scripts complain about ‘--enable-package ’ options that they do
not support. See Section 14.5 [Option Checking], page 227, for details, and for how to
override the defaults.
For each optional feature, ‘configure.ac’ should call AC_ARG_ENABLE to detect whether
the configure user asked to include it. Whether each feature is included or not by default,
and which arguments are valid, is up to you.
page 223) or AC_ARG_ENABLE (see Section 14.3 [Package Options], page 225). The
following example makes this clearer.
AC_ARG_WITH([foo],
[AS_HELP_STRING([--with-foo],
[use foo (default is no)])],
[use_foo=$withval],
[use_foo=no])
Then the last few lines of ‘configure --help’ appear like this:
--enable and --with options recognized:
--with-foo use foo (default is no)
Macro expansion is performed on the first argument. However, the second argument
of AS_HELP_STRING is treated as a whitespace separated list of text to be reformatted,
and is not subject to macro expansion. Since it is not expanded, it should not be
double quoted. See Section 3.1.2 [Autoconf Language], page 7, for a more detailed
explanation.
The AS_HELP_STRING macro is particularly helpful when the left-hand-side and/or
right-hand-side are composed of macro arguments, as shown in the following example.
Be aware that left-hand-side may not contain unbalanced quotes or parentheses.
AC_DEFUN([MY_ARG_WITH],
[AC_ARG_WITH(m4_translit([[$1]], [_], [-]),
[AS_HELP_STRING([--with-m4_translit([$1], [_], [-])],
[use $1 (default is $2)])],
[use_[]$1=$withval],
[use_[]$1=$2])])
MY_ARG_WITH([a_b], [no])
Here, the last few lines of ‘configure --help’ will include:
--enable and --with options recognized:
--with-a-b use a_b (default is no)
The parameters indent-column and wrap-column were introduced in Autoconf 2.62.
Generally, they should not be specified; they exist for fine-tuning of the wrapping.
AS_HELP_STRING([--option], [description of option])
⇒ --option description of option
AS_HELP_STRING([--option], [description of option], [15], [30])
⇒ --option description of
⇒ option
‘--program-suffix=suffix ’
append suffix to the names;
‘--program-transform-name=expression ’
perform sed substitution expression on the names.
uninstall:
for p in $(PROGRAMS); do \
rm -f $(DESTDIR)$(bindir)/‘echo $$p | sed ’$(transform)’‘; \
done
It is guaranteed that program_transform_name is never empty, and that there are no
useless separators. Therefore you may safely embed program_transform_name within a sed
program using ‘;’:
230 Autoconf
transform = @program_transform_name@
transform_exe = s/$(EXEEXT)$$//;$(transform);s/$$/$(EXEEXT)/
Whether to do the transformations on documentation files (Texinfo or man) is a tricky
question; there seems to be no perfect answer, due to the several reasons for name trans-
forming. Documentation is not usually particular to a specific architecture, and Texinfo
files do not conflict with system documentation. But they might conflict with earlier ver-
sions of the same files, and man pages sometimes do conflict with system documentation.
As a compromise, it is probably best to do name transformations on man pages but not on
Texinfo manuals.
variables such as prefix and cache_file have their default values (as set near the top of
configure) before changing them.
Here is a sample file ‘/usr/share/local/gnu/share/config.site’. The command
‘configure --prefix=/usr/share/local/gnu’ would read this file (if CONFIG_SITE is not
set to a different file).
# config.site for configure
#
# Change some defaults.
test "$prefix" = NONE && prefix=/usr/share/local/gnu
test "$exec_prefix" = NONE && exec_prefix=/usr/local/gnu
test "$sharedstatedir" = ’${prefix}/com’ && sharedstatedir=/var
test "$localstatedir" = ’${prefix}/var’ && localstatedir=/var
‘--version’
‘-V’ Print the version of Autoconf used to generate the configure script, and exit.
‘--cache-file=file ’
Enable the cache: use and save the results of the tests in file, traditionally
‘config.cache’. file defaults to ‘/dev/null’ to disable caching.
‘--config-cache’
‘-C’ Alias for ‘--cache-file=config.cache’.
‘--quiet’
‘--silent’
‘-q’ Do not print messages saying which checks are being made. To suppress all nor-
mal output, redirect it to ‘/dev/null’ (any error messages will still be shown).
‘--srcdir=dir ’
Look for the package’s source code in directory dir. Usually configure can
determine that directory automatically.
configure also accepts some other, not widely useful, options. Run ‘configure --help’
for more details.
Chapter 16: config.status Invocation 237
16 config.status Invocation
The configure script creates a file named ‘config.status’, which actually configures,
instantiates, the template files. It also records the configuration options that were specified
when the package was last configured in case reconfiguring is needed.
Synopsis:
./config.status option ... [file ...]
It configures the files; if none are specified, all the templates are instantiated. The files
must be specified without their dependencies, as in
./config.status foobar
not
./config.status foobar:foo.in:bar.in
The supported options are:
‘--help’
‘-h’ Print a summary of the command line options, the list of the template files,
and exit.
‘--version’
‘-V’ Print the version number of Autoconf and the configuration settings, and exit.
‘--silent’
‘--quiet’
‘-q’ Do not print progress messages.
‘--debug’
‘-d’ Don’t remove the temporary files.
‘--file=file [:template ]’
Require that file be instantiated as if ‘AC_CONFIG_FILES(file :template )’ was
used. Both file and template may be ‘-’ in which case the standard output
and/or standard input, respectively, is used. If a template file name is relative,
it is first looked for in the build tree, and then in the source tree. See Section 4.6
[Configuration Actions], page 18, for more details.
This option and the following ones provide one way for separately distributed
packages to share the values computed by configure. Doing so can be useful if
some of the packages need a superset of the features that one of them, perhaps
a common library, does. These options allow a ‘config.status’ file to create
files other than the ones that its ‘configure.ac’ specifies, so it can be used for
a different package.
‘--header=file [:template ]’
Same as ‘--file’ above, but with ‘AC_CONFIG_HEADERS’.
‘--recheck’
Ask ‘config.status’ to update itself and exit (no instantiation). This option
is useful if you change configure, so that the results of some tests might be
different from the previous run. The ‘--recheck’ option reruns configure with
the same arguments you used before, plus the ‘--no-create’ option, which
238 Autoconf
CONFIG_SHELL [Variable]
The shell with which to run configure for the ‘--recheck’ option. It must be Bourne-
compatible. The default is a shell that supports LINENO if available, and ‘/bin/sh’
otherwise. Invoking configure by hand bypasses this setting, so you may need to use
a command like ‘CONFIG_SHELL=/bin/bash /bin/bash ./configure’ to insure that
the same shell is used everywhere. The absolute name of the shell should be passed.
CONFIG_STATUS [Variable]
The file name to use for the shell script that records the configuration. The default
is ‘./config.status’. This variable is useful when one package uses parts of an-
other and the configure scripts shouldn’t be merged because they are maintained
separately.
You can use ‘./config.status’ in your makefiles. For example, in the dependencies
given above (see Section 4.8.5 [Automatic Remaking], page 29), ‘config.status’ is run
twice when ‘configure.ac’ has changed. If that bothers you, you can make each run only
regenerate the files for that rule:
config.h: stamp-h
stamp-h: config.h.in config.status
./config.status config.h
echo > stamp-h
17 Obsolete Constructs
Autoconf changes, and throughout the years some constructs have been obsoleted. Most
of the changes involve the macros, but in some cases the tools themselves, or even some
concepts, are now considered obsolete.
You may completely skip this chapter if you are new to Autoconf. Its intention is mainly
to help maintainers updating their packages by understanding how to move to more modern
constructs.
CONFIG_COMMANDS [Variable]
The tags of the commands to execute. The default is the arguments given to AC_
OUTPUT and AC_CONFIG_COMMANDS in ‘configure.ac’.
CONFIG_FILES [Variable]
The files in which to perform ‘@variable @’ substitutions. The default is the argu-
ments given to AC_OUTPUT and AC_CONFIG_FILES in ‘configure.ac’.
CONFIG_HEADERS [Variable]
The files in which to substitute C #define statements. The default is the arguments
given to AC_CONFIG_HEADERS; if that macro was not called, ‘config.status’ ignores
this variable.
CONFIG_LINKS [Variable]
The symbolic links to establish. The default is the arguments given to AC_CONFIG_
LINKS; if that macro was not called, ‘config.status’ ignores this variable.
In Chapter 16 [config.status Invocation], page 237, using this old interface, the example
would be:
config.h: stamp-h
stamp-h: config.h.in config.status
CONFIG_COMMANDS= CONFIG_LINKS= CONFIG_FILES= \
CONFIG_HEADERS=config.h ./config.status
echo > stamp-h
17.2 ‘acconfig.h’
In order to produce ‘config.h.in’, autoheader needs to build or to find templates for each
symbol. Modern releases of Autoconf use AH_VERBATIM and AH_TEMPLATE (see Section 4.9.3
[Autoheader Macros], page 33), but in older releases a file, ‘acconfig.h’, contained the list
of needed templates. autoheader copied comments and #define and #undef statements
from ‘acconfig.h’ in the current directory, if present. This file used to be mandatory if
you AC_DEFINE any additional symbols.
Modern releases of Autoconf also provide AH_TOP and AH_BOTTOM if you need to
prepend/append some information to ‘config.h.in’. Ancient versions of Autoconf had a
similar feature: if ‘./acconfig.h’ contains the string ‘@TOP@’, autoheader copies the lines
before the line containing ‘@TOP@’ into the top of the file that it generates. Similarly, if
‘./acconfig.h’ contains the string ‘@BOTTOM@’, autoheader copies the lines after that line
to the end of the file it generates. Either or both of those strings may be omitted. An even
older alternate way to produce the same effect in ancient versions of Autoconf is to create
the files ‘file.top’ (typically ‘config.h.top’) and/or ‘file.bot’ in the current directory.
If they exist, autoheader copies them to the beginning and end, respectively, of its output.
In former versions of Autoconf, the files used in preparing a software package for distri-
bution were:
configure.ac --. .------> autoconf* -----> configure
+---+
[aclocal.m4] --+ ‘---.
[acsite.m4] ---’ |
+--> [autoheader*] -> [config.h.in]
[acconfig.h] ----. |
+-----’
[config.h.top] --+
[config.h.bot] --’
Using only the AH_ macros, ‘configure.ac’ should be self-contained, and should not
depend upon ‘acconfig.h’ etc.
‘--help’
‘-h’ Print a summary of the command line options and exit.
‘--version’
‘-V’ Print the version number of Autoconf and exit.
‘--verbose’
‘-v’ Report processing steps.
‘--debug’
‘-d’ Don’t remove the temporary files.
‘--force’
‘-f’ Force the update even if the file has not changed. Disregard the cache.
‘--include=dir ’
‘-I dir ’ Also look for input files in dir. Multiple invocations accumulate. Directories
are browsed from last to first.
AC_AIX [Macro]
This macro is a platform-specific subset of AC_USE_SYSTEM_EXTENSIONS (see
[AC USE SYSTEM EXTENSIONS], page 85).
AC_ALLOCA [Macro]
Replaced by AC_FUNC_ALLOCA (see [AC FUNC ALLOCA], page 48).
AC_ARG_ARRAY [Macro]
Removed because of limited usefulness.
AC_C_CROSS [Macro]
This macro is obsolete; it does nothing.
AC_C_LONG_DOUBLE [Macro]
If the C compiler supports a working long double type with more range or precision
than the double type, define HAVE_LONG_DOUBLE.
You should use AC_TYPE_LONG_DOUBLE or AC_TYPE_LONG_DOUBLE_WIDER instead. See
Section 5.9.1 [Particular Types], page 67.
242 Autoconf
AC_CANONICAL_SYSTEM [Macro]
Determine the system type and set output variables to the names of the canonical sys-
tem types. See Section 13.2 [Canonicalizing], page 220, for details about the variables
this macro sets.
The user is encouraged to use either AC_CANONICAL_BUILD, or AC_CANONICAL_HOST,
or AC_CANONICAL_TARGET, depending on the needs. Using AC_CANONICAL_TARGET is
enough to run the two other macros (see Section 13.2 [Canonicalizing], page 220).
AC_CHAR_UNSIGNED [Macro]
Replaced by AC_C_CHAR_UNSIGNED (see [AC C CHAR UNSIGNED], page 76).
AC_CHECK_TYPE (type, default ) [Macro]
Autoconf, up to 2.13, used to provide this version of AC_CHECK_TYPE, deprecated
because of its flaws. First, although it is a member of the CHECK clan, it does more
than just checking. Secondly, missing types are defined using #define, not typedef,
and this can lead to problems in the case of pointer types.
This use of AC_CHECK_TYPE is obsolete and discouraged; see Section 5.9.2 [Generic
Types], page 69, for the description of the current macro.
If the type type is not defined, define it to be the C (or C++) builtin type default,
e.g., ‘short int’ or ‘unsigned int’.
This macro is equivalent to:
AC_CHECK_TYPE([type ], [],
[AC_DEFINE_UNQUOTED([type ], [default ],
[Define to ‘default ’
if <sys/types.h> does not define.])])
In order to keep backward compatibility, the two versions of AC_CHECK_TYPE are
implemented, selected using these heuristics:
1. If there are three or four arguments, the modern version is used.
2. If the second argument appears to be a C or C++ type, then the obsolete version
is used. This happens if the argument is a C or C++ builtin type or a C identifier
ending in ‘_t’, optionally followed by one of ‘[(* ’ and then by a string of zero
or more characters taken from the set ‘[]()* _a-zA-Z0-9’.
3. If the second argument is spelled with the alphabet of valid C and C++ types,
the user is warned and the modern version is used.
4. Otherwise, the modern version is used.
You are encouraged either to use a valid builtin type, or to use the equivalent modern
code (see above), or better yet, to use AC_CHECK_TYPES together with
#ifndef HAVE_LOFF_T
typedef loff_t off_t;
#endif
AC_CHECKING (feature-description ) [Macro]
Same as
AC_MSG_NOTICE([checking feature-description ...]
See [AC MSG NOTICE], page 108.
Chapter 17: Obsolete Constructs 243
AC_FUNC_SETVBUF_REVERSED [Macro]
Do nothing. Formerly, this macro checked whether setvbuf takes the buffering type
as its second argument and the buffer pointer as the third, instead of the other
way around, and defined SETVBUF_REVERSED. However, the last systems to have the
problem were those based on SVR2, which became obsolete in 1987, and the macro
is no longer needed.
AC_FUNC_WAIT3 [Macro]
If wait3 is found and fills in the contents of its third argument (a ‘struct rusage
*’), which HP-UX does not do, define HAVE_WAIT3.
These days portable programs should use waitpid, not wait3, as wait3 has been
removed from Posix.
Chapter 17: Obsolete Constructs 245
AC_GCC_TRADITIONAL [Macro]
Replaced by AC_PROG_GCC_TRADITIONAL (see [AC PROG GCC TRADITIONAL],
page 77).
AC_GETGROUPS_T [Macro]
Replaced by AC_TYPE_GETGROUPS (see [AC TYPE GETGROUPS], page 67).
AC_GETLOADAVG [Macro]
Replaced by AC_FUNC_GETLOADAVG (see [AC FUNC GETLOADAVG], page 50).
AC_GNU_SOURCE [Macro]
This macro is a platform-specific subset of AC_USE_SYSTEM_EXTENSIONS (see
[AC USE SYSTEM EXTENSIONS], page 85).
AC_HAVE_FUNCS [Macro]
Replaced by AC_CHECK_FUNCS (see [AC CHECK FUNCS], page 55).
AC_HAVE_HEADERS [Macro]
Replaced by AC_CHECK_HEADERS (see [AC CHECK HEADERS], page 63).
AC_HAVE_LIBRARY (library, [action-if-found ], [Macro]
[action-if-not-found ], [other-libraries ])
This macro is equivalent to calling AC_CHECK_LIB with a function argument of main.
In addition, library can be written as any of ‘foo’, ‘-lfoo’, or ‘libfoo.a’. In all
of those cases, the compiler is passed ‘-lfoo’. However, library cannot be a shell
variable; it must be a literal name. See [AC CHECK LIB], page 44.
AC_HAVE_POUNDBANG [Macro]
Replaced by AC_SYS_INTERPRETER (see [AC SYS INTERPRETER], page 84).
AC_HEADER_CHECK [Macro]
Replaced by AC_CHECK_HEADER (see [AC CHECK HEADER], page 63).
AC_HEADER_EGREP [Macro]
Replaced by AC_EGREP_HEADER (see [AC EGREP HEADER], page 95).
AC_HELP_STRING [Macro]
Replaced by AS_HELP_STRING (see [AS HELP STRING], page 226).
AC_INIT (unique-file-in-source-dir ) [Macro]
Formerly AC_INIT used to have a single argument, and was equivalent to:
AC_INIT
AC_CONFIG_SRCDIR(unique-file-in-source-dir )
See [AC INIT], page 15 and [AC CONFIG SRCDIR], page 17.
AC_INLINE [Macro]
Replaced by AC_C_INLINE (see [AC C INLINE], page 76).
AC_INT_16_BITS [Macro]
If the C type int is 16 bits wide, define INT_16_BITS. Use ‘AC_CHECK_SIZEOF(int)’
instead (see [AC CHECK SIZEOF], page 71).
246 Autoconf
AC_IRIX_SUN [Macro]
If on irix (Silicon Graphics Unix), add ‘-lsun’ to output LIBS. If you were using it to
get getmntent, use AC_FUNC_GETMNTENT instead. If you used it for the NIS versions
of the password and group functions, use ‘AC_CHECK_LIB(sun, getpwnam)’. Up to
Autoconf 2.13, it used to be
AC_CHECK_LIB([sun], [getmntent], [LIBS="-lsun $LIBS"])
now it is defined as
AC_FUNC_GETMNTENT
AC_CHECK_LIB([sun], [getpwnam])
See [AC FUNC GETMNTENT], page 51 and [AC CHECK LIB], page 44.
AC_ISC_POSIX [Macro]
This macro adds ‘-lcposix’ to output variable LIBS if necessary for Posix facilities.
Sun dropped support for the obsolete interactive Systems Corporation Unix on
2006-07-23. New programs need not use this macro. It is implemented as AC_SEARCH_
LIBS([strerror], [cposix]) (see [AC SEARCH LIBS], page 45).
AC_LANG_C [Macro]
Same as ‘AC_LANG([C])’ (see [AC LANG], page 89).
AC_LANG_CPLUSPLUS [Macro]
Same as ‘AC_LANG([C++])’ (see [AC LANG], page 89).
AC_LANG_FORTRAN77 [Macro]
Same as ‘AC_LANG([Fortran 77])’ (see [AC LANG], page 89).
AC_LANG_RESTORE [Macro]
Select the language that is saved on the top of the stack, as set by AC_LANG_SAVE,
remove it from the stack, and call AC_LANG(language ). See Section 6.1 [Language
Choice], page 89, for the preferred way to change languages.
AC_LANG_SAVE [Macro]
Remember the current language (as set by AC_LANG) on a stack. The current language
does not change. AC_LANG_PUSH is preferred (see [AC LANG PUSH], page 90).
AC_LN_S [Macro]
Replaced by AC_PROG_LN_S (see [AC PROG LN S], page 41).
Chapter 17: Obsolete Constructs 247
AC_LONG_64_BITS [Macro]
Define LONG_64_BITS if the C type long int is 64 bits wide. Use the generic macro
‘AC_CHECK_SIZEOF([long int])’ instead (see [AC CHECK SIZEOF], page 71).
AC_LONG_DOUBLE [Macro]
If the C compiler supports a working long double type with more range or precision
than the double type, define HAVE_LONG_DOUBLE.
You should use AC_TYPE_LONG_DOUBLE or AC_TYPE_LONG_DOUBLE_WIDER instead. See
Section 5.9.1 [Particular Types], page 67.
AC_LONG_FILE_NAMES [Macro]
Replaced by
AC_SYS_LONG_FILE_NAMES
See [AC SYS LONG FILE NAMES], page 85.
AC_MAJOR_HEADER [Macro]
Replaced by AC_HEADER_MAJOR (see [AC HEADER MAJOR], page 59).
AC_MEMORY_H [Macro]
Used to define NEED_MEMORY_H if the mem functions were defined in ‘memory.h’. Today
it is equivalent to ‘AC_CHECK_HEADERS([memory.h])’ (see [AC CHECK HEADERS],
page 63). Adjust your code to depend upon HAVE_MEMORY_H, not NEED_MEMORY_H; see
Section 5.1.1 [Standard Symbols], page 37.
AC_MINGW32 [Macro]
Similar to AC_CYGWIN but checks for the MinGW compiler environment and sets
MINGW32. Don’t use this macro, the dignified means to check the nature of the host
is using AC_CANONICAL_HOST (see Section 13.2 [Canonicalizing], page 220).
AC_MINIX [Macro]
This macro is a platform-specific subset of AC_USE_SYSTEM_EXTENSIONS (see
[AC USE SYSTEM EXTENSIONS], page 85).
AC_MINUS_C_MINUS_O [Macro]
Replaced by AC_PROG_CC_C_O (see [AC PROG CC C O], page 73).
AC_MMAP [Macro]
Replaced by AC_FUNC_MMAP (see [AC FUNC MMAP], page 52).
AC_MODE_T [Macro]
Replaced by AC_TYPE_MODE_T (see [AC TYPE MODE T], page 68).
AC_OBJEXT [Macro]
Defined the output variable OBJEXT based on the output of the compiler, after .c files
have been excluded. Typically set to ‘o’ if Posix, ‘obj’ if a DOS variant. Now the
compiler checking macros handle this automatically.
should be the name of the macro that is calling AC_OBSOLETE. If suggestion is given,
it is printed at the end of the warning message; for example, it can be a suggestion
for what to use instead of this-macro-name.
For instance
AC_OBSOLETE([$0], [; use AC_CHECK_HEADERS(unistd.h) instead])dnl
You are encouraged to use AU_DEFUN instead, since it gives better services to the user
(see [AU DEFUN], page 148).
AC_OFF_T [Macro]
Replaced by AC_TYPE_OFF_T (see [AC TYPE OFF T], page 68).
AC_PID_T [Macro]
Replaced by AC_TYPE_PID_T (see [AC TYPE PID T], page 68).
Chapter 17: Obsolete Constructs 249
AC_PREFIX [Macro]
Replaced by AC_PREFIX_PROGRAM (see [AC PREFIX PROGRAM], page 36).
AC_PROGRAMS_CHECK [Macro]
Replaced by AC_CHECK_PROGS (see [AC CHECK PROGS], page 42).
AC_PROGRAMS_PATH [Macro]
Replaced by AC_PATH_PROGS (see [AC PATH PROGS], page 43).
AC_PROGRAM_CHECK [Macro]
Replaced by AC_CHECK_PROG (see [AC CHECK PROG], page 42).
AC_PROGRAM_EGREP [Macro]
Replaced by AC_EGREP_CPP (see [AC EGREP CPP], page 95).
AC_PROGRAM_PATH [Macro]
Replaced by AC_PATH_PROG (see [AC PATH PROG], page 43).
AC_REMOTE_TAPE [Macro]
Removed because of limited usefulness.
AC_RESTARTABLE_SYSCALLS [Macro]
This macro was renamed AC_SYS_RESTARTABLE_SYSCALLS. However, these days
portable programs should use sigaction with SA_RESTART if they want restartable
system calls. They should not rely on HAVE_RESTARTABLE_SYSCALLS, since nowadays
whether a system call is restartable is a dynamic issue, not a configuration-time
issue.
AC_RETSIGTYPE [Macro]
Replaced by AC_TYPE_SIGNAL (see [AC TYPE SIGNAL], page 68).
AC_RSH [Macro]
Removed because of limited usefulness.
AC_SCO_INTL [Macro]
If on SCO Unix, add ‘-lintl’ to output variable LIBS. This macro used to do this:
AC_CHECK_LIB([intl], [strftime], [LIBS="-lintl $LIBS"])
Now it just calls AC_FUNC_STRFTIME instead (see [AC FUNC STRFTIME], page 53).
AC_SETVBUF_REVERSED [Macro]
Replaced by
AC_FUNC_SETVBUF_REVERSED
See [AC FUNC SETVBUF REVERSED], page 244.
AC_SET_MAKE [Macro]
Replaced by AC_PROG_MAKE_SET (see [AC PROG MAKE SET], page 18).
AC_SIZEOF_TYPE [Macro]
Replaced by AC_CHECK_SIZEOF (see [AC CHECK SIZEOF], page 71).
250 Autoconf
AC_SIZE_T [Macro]
Replaced by AC_TYPE_SIZE_T (see [AC TYPE SIZE T], page 69).
AC_STAT_MACROS_BROKEN [Macro]
Replaced by AC_HEADER_STAT (see [AC HEADER STAT], page 60).
AC_STDC_HEADERS [Macro]
Replaced by AC_HEADER_STDC (see [AC HEADER STDC], page 60).
AC_STRCOLL [Macro]
Replaced by AC_FUNC_STRCOLL (see [AC FUNC STRCOLL], page 53).
AC_STRUCT_ST_BLKSIZE [Macro]
If struct stat contains an st_blksize member, define HAVE_STRUCT_STAT_ST_
BLKSIZE. The former name, HAVE_ST_BLKSIZE is to be avoided, as its support will
cease in the future. This macro is obsoleted, and should be replaced by
AC_CHECK_MEMBERS([struct stat.st_blksize])
See [AC CHECK MEMBERS], page 66.
AC_STRUCT_ST_RDEV [Macro]
If struct stat contains an st_rdev member, define HAVE_STRUCT_STAT_ST_RDEV.
The former name for this macro, HAVE_ST_RDEV, is to be avoided as it will cease to
be supported in the future. Actually, even the new macro is obsolete and should be
replaced by:
AC_CHECK_MEMBERS([struct stat.st_rdev])
See [AC CHECK MEMBERS], page 66.
AC_ST_BLKSIZE [Macro]
Replaced by AC_CHECK_MEMBERS (see [AC CHECK MEMBERS], page 66).
AC_ST_BLOCKS [Macro]
Replaced by AC_STRUCT_ST_BLOCKS (see [AC STRUCT ST BLOCKS], page 66).
AC_ST_RDEV [Macro]
Replaced by AC_CHECK_MEMBERS (see [AC CHECK MEMBERS], page 66).
AC_SYS_RESTARTABLE_SYSCALLS [Macro]
If the system automatically restarts a system call that is interrupted by a signal, define
HAVE_RESTARTABLE_SYSCALLS. This macro does not check whether system calls are
restarted in general—it checks whether a signal handler installed with signal (but
not sigaction) causes system calls to be restarted. It does not check whether system
calls can be restarted when interrupted by signals that have no handler.
These days portable programs should use sigaction with SA_RESTART if they want
restartable system calls. They should not rely on HAVE_RESTARTABLE_SYSCALLS, since
nowadays whether a system call is restartable is a dynamic issue, not a configuration-
time issue.
AC_SYS_SIGLIST_DECLARED [Macro]
This macro was renamed AC_DECL_SYS_SIGLIST. However, even that name is
obsolete, as the same functionality is now acheived via AC_CHECK_DECLS (see
[AC CHECK DECLS], page 64).
Chapter 17: Obsolete Constructs 251
AC_TEST_CPP [Macro]
This macro was renamed AC_TRY_CPP, which in turn was replaced by AC_PREPROC_
IFELSE (see [AC PREPROC IFELSE], page 94).
AC_TEST_PROGRAM [Macro]
This macro was renamed AC_TRY_RUN, which in turn was replaced by AC_RUN_IFELSE
(see [AC RUN IFELSE], page 96).
AC_TIMEZONE [Macro]
Replaced by AC_STRUCT_TIMEZONE (see [AC STRUCT TIMEZONE], page 66).
AC_TIME_WITH_SYS_TIME [Macro]
Replaced by AC_HEADER_TIME (see [AC HEADER TIME], page 62).
AC_VFORK [Macro]
Replaced by AC_FUNC_FORK (see [AC FUNC FORK], page 50).
AC_VPRINTF [Macro]
Replaced by AC_FUNC_VPRINTF (see [AC FUNC VPRINTF], page 54).
AC_WAIT3 [Macro]
This macro was renamed AC_FUNC_WAIT3. However, these days portable programs
should use waitpid, not wait3, as wait3 has been removed from Posix.
AC_WARN [Macro]
Replaced by AC_MSG_WARN (see [AC MSG WARN], page 109).
AC_WORDS_BIGENDIAN [Macro]
Replaced by AC_C_BIGENDIAN (see [AC C BIGENDIAN], page 75).
AC_XENIX_DIR [Macro]
This macro used to add ‘-lx’ to output variable LIBS if on Xenix. Also, if ‘dirent.h’
is being checked for, added ‘-ldir’ to LIBS. Now it is merely an alias of AC_HEADER_
DIRENT instead, plus some code to detect whether running xenix on which you should
not depend:
AC_MSG_CHECKING([for Xenix])
AC_EGREP_CPP([yes],
[#if defined M_XENIX && !defined M_UNIX
yes
#endif],
[AC_MSG_RESULT([yes]); XENIX=yes],
[AC_MSG_RESULT([no]); XENIX=])
Don’t use this macro, the dignified means to check the nature of the host is using
AC_CANONICAL_HOST (see Section 13.2 [Canonicalizing], page 220).
AC_YYTEXT_POINTER [Macro]
This macro was renamed AC_DECL_YYTEXT, which in turn was integrated into AC_
PROG_LEX (see [AC PROG LEX], page 40).
no actual harm in continuing to use the older way, but it’s less convenient and attractive.
See Section 9.1 [Macro Definitions], page 143.
You probably looked at the macros that came with Autoconf as a guide for how to do
things. It would be a good idea to take a look at the new versions of them, as the style is
somewhat improved and they take advantage of some new features.
If you were doing tricky things with undocumented Autoconf internals (macros, variables,
diversions), check whether you need to change anything to account for changes that have
been made. Perhaps you can even use an officially supported technique in version 2 instead
of kludging. Or perhaps not.
To speed up your locally written feature tests, add caching to them. See whether any of
your tests are of general enough usefulness to encapsulate them into macros that you can
share.
Modern versions of Automake no longer define most of these macros, and properly quote
the names of the remaining macros. If you must use an old Automake, do not depend upon
macros from Automake as it is simply not its job to provide macros (but the one it requires
itself):
$ cat configure.ac
AC_INIT([Example], [1.0], [[email protected]])
AM_TYPE_PTRDIFF_T
$ rm aclocal.m4
$ autoupdate
autoupdate: ‘configure.ac’ is updated
$ cat configure.ac
AC_INIT([Example], [1.0], [[email protected]])
AC_CHECK_TYPES([ptrdiff_t])
$ aclocal-1.4
$ autoconf
$
The relationship between build, host, and target have been cleaned up: the chain of
default is now simply: target defaults to host, host to build, and build to the result of
config.guess. Nevertheless, in order to ease the transition from 2.13 to 2.50, the following
transition scheme is implemented. Do not rely on it, as it will be completely disabled in a
couple of releases (we cannot keep it, as it proves to cause more problems than it cures).
They all default to the result of running config.guess, unless you specify either
‘--build’ or ‘--host’. In this case, the default becomes the system type you specified. If
you specify both, and they’re different, configure enters cross compilation mode, so it
doesn’t run any tests that require execution.
Hint: if you mean to override the result of config.guess, prefer ‘--build’ over ‘--host’.
In the future, ‘--host’ will not override the name of the build system type. Whenever you
specify ‘--host’, be sure to specify ‘--build’ too.
In Autoconf 2.13 and before, the variables build, host, and target had a different
semantics before and after the invocation of AC_CANONICAL_BUILD etc. Now, the argument
of ‘--build’ is strictly copied into build_alias, and is left empty otherwise. After the
AC_CANONICAL_BUILD, build is set to the canonicalized build type. To ease the transition,
before, its contents is the same as that of build_alias. Do not rely on this broken feature.
For consistency with the backward compatibility scheme exposed above, when ‘--host’
is specified but ‘--build’ isn’t, the build system is assumed to be the same as ‘--host’,
and ‘build_alias’ is set to that value. Eventually, this historically incorrect behavior will
go away.
The former scheme to enable cross-compilation proved to cause more harm than good,
in particular, it used to be triggered too easily, leaving regular end users puzzled in front of
cryptic error messages. configure could even enter cross-compilation mode only because
the compiler was not functional. This is mainly because configure used to try to detect
cross-compilation, instead of waiting for an explicit flag from the user.
Now, configure enters cross-compilation mode if and only if ‘--host’ is passed.
That’s the short documentation. To ease the transition between 2.13 and its successors,
a more complicated scheme is implemented. Do not rely on the following, as it will be
removed in the near future.
If you specify ‘--host’, but not ‘--build’, when configure performs the first compiler
test it tries to run an executable produced by the compiler. If the execution fails, it enters
cross-compilation mode. This is fragile. Moreover, by the time the compiler test is per-
formed, it may be too late to modify the build-system type: other tests may have already
been performed. Therefore, whenever you specify ‘--host’, be sure to specify ‘--build’
too.
./configure --build=i686-pc-linux-gnu --host=m68k-coff
enters cross-compilation mode. The former interface, which consisted in setting the compiler
to a cross-compiler without informing configure is obsolete. For instance, configure fails
if it can’t run the code generated by the specified compiler if you configure as follows:
./configure CC=m68k-coff-gcc
As for function replacement, the fix is immediate: use AC_LIBOBJ. For instance:
260 Autoconf
LIBOBJS="$LIBOBJS fnmatch.o"
LIBOBJS="$LIBOBJS malloc.$ac_objext"
should be replaced with:
AC_LIBOBJ([fnmatch])
AC_LIBOBJ([malloc])
When used with Automake 1.10 or newer, a suitable value for LIBOBJDIR is set so that
the LIBOBJS and LTLIBOBJS can be referenced from any ‘Makefile.am’. Even without
Automake, arranging for LIBOBJDIR to be set correctly enables referencing LIBOBJS and
LTLIBOBJS in another directory. The LIBOBJDIR feature is experimental.
suite, and sometimes does elementary health checking, before listing include statements
for all other test files. The special file ‘package.m4’, containing the identification of the
package, is automatically included if found.
A convenient alternative consists in moving all the global issues (local Autotest macros,
elementary health checking, and AT_INIT invocation) into the file local.at, and making
‘testsuite.at’ be a simple list of m4_include of sub test suites. In such case, generating
the whole test suite or pieces of it is only a matter of choosing the autom4te command line
arguments.
The validation scripts that Autotest produces are by convention called testsuite. When
run, testsuite executes each test group in turn, producing only one summary line per test
to say if that particular test succeeded or failed. At end of all tests, summarizing counters
get printed. One debugging directory is left for each test group which failed, if any: such
directories are named ‘testsuite.dir/nn ’, where nn is the sequence number of the test
group, and they include:
• a debugging script named ‘run’ which reruns the test in debug mode (see Section 18.3
[testsuite Invocation], page 265). The automatic generation of debugging scripts has
the purpose of easing the chase for bugs.
• all the files created with AT_DATA
• a log of the run, named ‘testsuite.log’
In the ideal situation, none of the tests fail, and consequently no debugging directory is
left behind for validation.
It often happens in practice that individual tests in the validation suite need to get
information coming out of the configuration process. Some of this information, common
for all validation suites, is provided through the file ‘atconfig’, automatically created
by AC_CONFIG_TESTDIR. For configuration informations which your testing environment
specifically needs, you might prepare an optional file named ‘atlocal.in’, instantiated
by AC_CONFIG_FILES. The configuration process produces ‘atconfig’ and ‘atlocal’ out of
these two input files, and these two produced files are automatically read by the ‘testsuite’
script.
Here is a diagram showing the relationship between files.
Files used in preparing a software package for distribution:
[package.m4] -->.
\
subfile-1.at ->. [local.at] ---->+
... \ \
subfile-i.at ---->-- testsuite.at -->-- autom4te* -->testsuite
... /
subfile-n.at ->’
Files used in configuring a software package:
.--> atconfig
/
[atlocal.in] --> config.status* --<
\
‘--> [atlocal]
Chapter 18: Generating Test Suites with Autotest 263
source file for tests. Each such included file, or the remainder of ‘testsuite.at’ if include
files are not used, contain a sequence of test groups. Each test group begins with a call
to AT_SETUP, then an arbitrary number of shell commands or calls to AT_CHECK, and then
completes with a call to AT_CLEANUP. Multiple test groups can be categorized by a call to
AT_BANNER.
Autotest test suites rely on PATH to find the tested program. This avoids the need to
generate absolute names of the various tools, and makes it possible to test installed pro-
grams. Therefore, knowing which programs are being exercised is crucial to understanding
problems in the test suite itself, or its occasional misuses. It is a good idea to also subscribe
foreign programs you depend upon, to avoid incompatible diagnostics.
Several invocations within a test group accumulate new keywords. In other words,
don’t fear registering the same keyword several times in a test group.
AT_CAPTURE_FILE (file ) [Macro]
If the current test group fails, log the contents of file. Several identical calls within
one test group have no additional effect.
AT_XFAIL_IF (shell-condition ) [Macro]
Determine whether the test is expected to fail because it is a known bug (for unsup-
ported features, you should skip the test). shell-condition is a shell expression such as
a test command; you can instantiate this macro many times from within the same
test group, and one of the conditions is enough to turn the test into an expected
failure.
AT_CLEANUP [Macro]
End the current test group.
‘--clean’
‘-c’ Remove all the files the test suite might have created and exit. Meant for clean
Make targets.
‘--list’
‘-l’ List all the tests (or only the selection), including their possible keywords.
By default all tests are performed (or described with ‘--list’) in the default environment
first silently, then verbosely, but the environment, set of tests, and verbosity level can be
tuned:
‘variable =value ’
Set the environment variable to value. Use this rather than ‘FOO=foo
./testsuite’ as debugging scripts would then run in a different environment.
The variable AUTOTEST_PATH specifies the testing path to prepend to PATH. Rel-
ative directory names (not starting with ‘/’) are considered to be relative to
the top level of the package being built. All directories are made absolute, first
starting from the top level build tree, then from the source tree. For instance
‘./testsuite AUTOTEST_PATH=tests:bin’ for a ‘/src/foo-1.0’ source pack-
age built in ‘/tmp/foo’ results in ‘/tmp/foo/tests:/tmp/foo/bin’ and then
‘/src/foo-1.0/tests:/src/foo-1.0/bin’ being prepended to PATH.
‘number ’
‘number-number ’
‘number-’
‘-number ’ Add the corresponding test groups, with obvious semantics, to the selection.
‘--keywords=keywords ’
‘-k keywords ’
Add to the selection the test groups with title or keywords (arguments to AT_
SETUP or AT_KEYWORDS) that match all keywords of the comma separated list
keywords, case-insensitively. Use ‘!’ immediately before the keyword to invert
the selection for this keyword. By default, the keywords match whole words;
enclose them in ‘.*’ to also match parts of words.
For example, running
./testsuite -k ’autoupdate,.*FUNC.*’
selects all tests tagged ‘autoupdate’ and with tags containing ‘FUNC’ (as in
‘AC_CHECK_FUNC’, ‘AC_FUNC_ALLOCA’, etc.), while
./testsuite -k ’!autoupdate’ -k ’.*FUNC.*’
selects all tests not tagged ‘autoupdate’ or with tags containing ‘FUNC’.
‘--errexit’
‘-e’ If any test fails, immediately abort testing. It implies ‘--debug’: post test
group clean up, and top-level logging are inhibited. This option is meant for
the full test suite, it is not really useful for generated debugging scripts.
‘--verbose’
‘-v’ Force more verbosity in the detailed output of what is being done. This is the
default for debugging scripts.
Chapter 18: Generating Test Suites with Autotest 267
‘--debug’
‘-d’ Do not remove the files after a test group was performed —but they are still
removed before, therefore using this option is sane when running several test
groups. Create debugging scripts. Do not overwrite the top-level log (in order
to preserve supposedly existing full log file). This is the default for debugging
scripts, but it can also be useful to debug the testsuite itself.
‘--trace’
‘-x’ Trigger shell tracing of the test groups.
TESTSUITE = $(srcdir)/testsuite
clean-local:
test ! -f ’$(TESTSUITE)’ || \
$(SHELL) ’$(TESTSUITE)’ --clean
atconfig: $(top_builddir)/config.status
cd $(top_builddir) && \
$(SHELL) ./config.status $(subdir)/$@
Also, Imake often suffers from unexpected interactions between make and the
installer’s C preprocessor. The fundamental problem here is that the C pre-
processor was designed to preprocess C programs, not makefiles. This is much
less of a problem with Autoconf, which uses the general-purpose preproces-
sor M4, and where the package’s author (rather than the installer) does the
preprocessing in a standard way.
Finally, Mark Eichin notes:
Imake isn’t all that extensible, either. In order to add new features to Imake,
you need to provide your own project template, and duplicate most of the
features of the existing one. This means that for a sophisticated project, using
the vendor-provided Imake templates fails to provide any leverage—since they
don’t cover anything that your own project needs (unless it is an X11 program).
On the other side, though:
The one advantage that Imake has over configure: ‘Imakefile’ files tend to
be much shorter (likewise, less redundant) than ‘Makefile.in’ files. There is a
fix to this, however—at least for the Kerberos V5 tree, we’ve modified things
to call in common ‘post.in’ and ‘pre.in’ makefile fragments for the entire
tree. This means that a lot of common things don’t have to be duplicated, even
though they normally are in configure setups.
AC_DEFINE_UNQUOTED([DATADIR], [$datadir],
[Define to the read-only architecture-independent
data directory.])
I get
DISTCLEANFILES = myprog-paths.h
myprog-paths.h: Makefile
echo ’#define DATADIR "$(datadir)"’ >$@
− Use AC_DEFINE but have configure compute the literal value of datadir and others.
Many people have wrapped macros to automate this task. For instance, the macro
AC_DEFINE_DIR from the Autoconf Macro Archive.
This solution does not conform to the GNU Coding Standards.
− Note that all the previous solutions hard wire the absolute name of these directories
in the executables, which is not a good property. You may try to compute the names
relative to prefix, and try to find prefix at runtime, this way your package is relo-
catable.
preprocessor, to give maintainers time to adjust their ‘configure.ac’, but in the future,
only the compiler will be considered.
Consider the following example:
$ cat number.h
typedef int number;
$ cat pi.h
const number pi = 3;
$ cat configure.ac
AC_INIT([Example], [1.0], [[email protected]])
AC_CHECK_HEADERS([pi.h])
$ autoconf -Wall
$ ./configure
checking for gcc... gcc
checking for C compiler default output file name... a.out
checking whether the C compiler works... yes
checking whether we are cross compiling... no
checking for suffix of executables...
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking how to run the C preprocessor... gcc -E
checking for grep that handles long lines and -e... grep
checking for egrep... grep -E
checking for ANSI C header files... yes
checking for sys/types.h... yes
checking for sys/stat.h... yes
checking for stdlib.h... yes
checking for string.h... yes
checking for memory.h... yes
checking for strings.h... yes
checking for inttypes.h... yes
checking for stdint.h... yes
checking for unistd.h... yes
checking pi.h usability... no
checking pi.h presence... yes
configure: WARNING: pi.h: present but cannot be compiled
configure: WARNING: pi.h: check for missing prerequisite headers?
configure: WARNING: pi.h: see the Autoconf documentation
configure: WARNING: pi.h: section "Present But Cannot Be Compiled"
configure: WARNING: pi.h: proceeding with the preprocessor’s result
configure: WARNING: pi.h: in the future, the compiler will take precedence
configure: WARNING: ## -------------------------------------- ##
configure: WARNING: ## Report this to [email protected] ##
configure: WARNING: ## -------------------------------------- ##
checking for pi.h... yes
The proper way the handle this case is using the fourth argument (see Section 5.6.3 [Generic
Headers], page 63):
$ cat configure.ac
AC_INIT([Example], [1.0], [[email protected]])
AC_CHECK_HEADERS([number.h pi.h], [], [],
[[#ifdef HAVE_NUMBER_H
# include <number.h>
#endif
]])
274 Autoconf
$ autoconf -Wall
$ ./configure
checking for gcc... gcc
checking for C compiler default output... a.out
checking whether the C compiler works... yes
checking whether we are cross compiling... no
checking for suffix of executables...
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ANSI C... none needed
checking for number.h... yes
checking for pi.h... yes
See Section 5.6.2 [Particular Headers], page 58, for a list of headers with their prerequi-
site.
Chapter 20: History of Autoconf 275
20 History of Autoconf
You may be wondering, Why was Autoconf originally written? How did it get into its
present form? (Why does it look like gorilla spit?) If you’re not wondering, then this
chapter contains no information useful to you, and you might as well skip it. If you are
wondering, then let there be light. . .
20.1 Genesis
In June 1991 I was maintaining many of the GNU utilities for the Free Software Foundation.
As they were ported to more platforms and more programs were added, the number of ‘-D’
options that users had to select in the makefile (around 20) became burdensome. Especially
for me—I had to test each new release on a bunch of different systems. So I wrote a little
shell script to guess some of the correct settings for the fileutils package, and released it
as part of fileutils 2.0. That configure script worked well enough that the next month
I adapted it (by hand) to create similar configure scripts for several other GNU utilities
packages. Brian Berliner also adapted one of my scripts for his CVS revision control system.
Later that summer, I learned that Richard Stallman and Richard Pixley were developing
similar scripts to use in the GNU compiler tools; so I adapted my configure scripts to
support their evolving interface: using the file name ‘Makefile.in’ as the templates; adding
‘+srcdir’, the first option (of many); and creating ‘config.status’ files.
20.2 Exodus
As I got feedback from users, I incorporated many improvements, using Emacs to search
and replace, cut and paste, similar changes in each of the scripts. As I adapted more GNU
utilities packages to use configure scripts, updating them all by hand became impractical.
Rich Murphey, the maintainer of the GNU graphics utilities, sent me mail saying that the
configure scripts were great, and asking if I had a tool for generating them that I could
send him. No, I thought, but I should! So I started to work out how to generate them.
And the journey from the slavery of hand-written configure scripts to the abundance and
ease of Autoconf began.
Cygnus configure, which was being developed at around that time, is table driven;
it is meant to deal mainly with a discrete number of system types with a small number
of mainly unguessable features (such as details of the object file format). The automatic
configuration system that Brian Fox had developed for Bash takes a similar approach. For
general use, it seems to me a hopeless cause to try to maintain an up-to-date database of
which features each variant of each operating system has. It’s easier and more reliable to
check for most features on the fly—especially on hybrid systems that people have hacked
on locally or that have patches from vendors installed.
I considered using an architecture similar to that of Cygnus configure, where there
is a single configure script that reads pieces of ‘configure.in’ when run. But I didn’t
want to have to distribute all of the feature tests with every package, so I settled on having
a different configure made from each ‘configure.in’ by a preprocessor. That approach
also offered more control and flexibility.
I looked briefly into using the Metaconfig package, by Larry Wall, Harlan Stenn, and
Raphael Manfredi, but I decided not to for several reasons. The Configure scripts it
276 Autoconf
produces are interactive, which I find quite inconvenient; I didn’t like the ways it checked
for some features (such as library functions); I didn’t know that it was still being maintained,
and the Configure scripts I had seen didn’t work on many modern systems (such as System
V R4 and NeXT); it wasn’t flexible in what it could do in response to a feature’s presence
or absence; I found it confusing to learn; and it was too big and complex for my needs (I
didn’t realize then how much Autoconf would eventually have to grow).
I considered using Perl to generate my style of configure scripts, but decided that M4
was better suited to the job of simple textual substitutions: it gets in the way less, because
output is implicit. Plus, everyone already has it. (Initially I didn’t rely on the GNU
extensions to M4.) Also, some of my friends at the University of Maryland had recently
been putting M4 front ends on several programs, including tvtwm, and I was interested in
trying out a new language.
20.3 Leviticus
Since my configure scripts determine the system’s capabilities automatically, with no
interactive user intervention, I decided to call the program that generates them Autoconfig.
But with a version number tacked on, that name would be too long for old Unix file systems,
so I shortened it to Autoconf.
In the fall of 1991 I called together a group of fellow questers after the Holy Grail of
portability (er, that is, alpha testers) to give me feedback as I encapsulated pieces of my
handwritten scripts in M4 macros and continued to add features and improve the techniques
used in the checks. Prominent among the testers were François Pinard, who came up with
the idea of making an Autoconf shell script to run M4 and check for unresolved macro calls;
Richard Pixley, who suggested running the compiler instead of searching the file system to
find include files and symbols, for more accurate results; Karl Berry, who got Autoconf to
configure TEX and added the macro index to the documentation; and Ian Lance Taylor,
who added support for creating a C header file as an alternative to putting ‘-D’ options in
a makefile, so he could use Autoconf for his UUCP package. The alpha testers cheerfully
adjusted their files again and again as the names and calling conventions of the Autoconf
macros changed from release to release. They all contributed many specific checks, great
ideas, and bug fixes.
20.4 Numbers
In July 1992, after months of alpha testing, I released Autoconf 1.0, and converted many
GNU packages to use it. I was surprised by how positive the reaction to it was. More people
started using it than I could keep track of, including people working on software that
wasn’t part of the GNU Project (such as TCL, FSP, and Kerberos V5). Autoconf continued
to improve rapidly, as many people using the configure scripts reported problems they
encountered.
Autoconf turned out to be a good torture test for M4 implementations. Unix M4 started
to dump core because of the length of the macros that Autoconf defined, and several bugs
showed up in GNU M4 as well. Eventually, we realized that we needed to use some features
that only GNU M4 has. 4.3BSD M4, in particular, has an impoverished set of builtin macros;
the System V version is better, but still doesn’t provide everything we need.
Chapter 20: History of Autoconf 277
More development occurred as people put Autoconf under more stresses (and to uses I
hadn’t anticipated). Karl Berry added checks for X11. david zuhn contributed C++ support.
François Pinard made it diagnose invalid arguments. Jim Blandy bravely coerced it into
configuring GNU Emacs, laying the groundwork for several later improvements. Roland
McGrath got it to configure the GNU C Library, wrote the autoheader script to automate
the creation of C header file templates, and added a ‘--verbose’ option to configure. Noah
Friedman added the ‘--autoconf-dir’ option and AC_MACRODIR environment variable. (He
also coined the term autoconfiscate to mean “adapt a software package to use Autoconf”.)
Roland and Noah improved the quoting protection in AC_DEFINE and fixed many bugs,
especially when I got sick of dealing with portability problems from February through
June, 1993.
20.5 Deuteronomy
A long wish list for major features had accumulated, and the effect of several years of
patching by various people had left some residual cruft. In April 1994, while working for
Cygnus Support, I began a major revision of Autoconf. I added most of the features of
the Cygnus configure that Autoconf had lacked, largely by adapting the relevant parts of
Cygnus configure with the help of david zuhn and Ken Raeburn. These features include
support for using ‘config.sub’, ‘config.guess’, ‘--host’, and ‘--target’; making links
to files; and running configure scripts in subdirectories. Adding these features enabled
Ken to convert GNU as, and Rob Savoye to convert DejaGNU, to using Autoconf.
I added more features in response to other peoples’ requests. Many people had asked
for configure scripts to share the results of the checks between runs, because (particularly
when configuring a large source tree, like Cygnus does) they were frustratingly slow. Mike
Haertel suggested adding site-specific initialization scripts. People distributing software
that had to unpack on MS-DOS asked for a way to override the ‘.in’ extension on the file
names, which produced file names like ‘config.h.in’ containing two dots. Jim Avera did
an extensive examination of the problems with quoting in AC_DEFINE and AC_SUBST; his
insights led to significant improvements. Richard Stallman asked that compiler output be
sent to ‘config.log’ instead of ‘/dev/null’, to help people debug the Emacs configure
script.
I made some other changes because of my dissatisfaction with the quality of the program.
I made the messages showing results of the checks less ambiguous, always printing a result.
I regularized the names of the macros and cleaned up coding style inconsistencies. I added
some auxiliary utilities that I had developed to help convert source code packages to use
Autoconf. With the help of François Pinard, I made the macros not interrupt each others’
messages. (That feature revealed some performance bottlenecks in GNU M4, which he
hastily corrected!) I reorganized the documentation around problems people want to solve.
And I began a test suite, because experience had shown that Autoconf has a pronounced
tendency to regress when we change it.
Again, several alpha testers gave invaluable feedback, especially François Pinard, Jim
Meyering, Karl Berry, Rob Savoye, Ken Raeburn, and Mark Eichin.
Finally, version 2.0 was ready. And there was much rejoicing. (And I have free time
again. I think. Yeah, right.)
278 Autoconf
Appendix A: GNU Free Documentation License 279
under this License. If a section does not fit the above definition of Secondary then it is
not allowed to be designated as Invariant. The Document may contain zero Invariant
Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover
Texts or Back-Cover Texts, in the notice that says that the Document is released under
this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may
be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented
in a format whose specification is available to the general public, that is suitable for
revising the document straightforwardly with generic text editors or (for images com-
posed of pixels) generic paint programs or (for drawings) some widely available drawing
editor, and that is suitable for input to text formatters or for automatic translation to
a variety of formats suitable for input to text formatters. A copy made in an otherwise
Transparent file format whose markup, or absence of markup, has been arranged to
thwart or discourage subsequent modification by readers is not Transparent. An image
format is not Transparent if used for any substantial amount of text. A copy that is
not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ascii without
markup, Texinfo input format, LaTEX input format, SGML or XML using a publicly
available DTD, and standard-conforming simple HTML, PostScript or PDF designed
for human modification. Examples of transparent image formats include PNG, XCF
and JPG. Opaque formats include proprietary formats that can be read and edited
only by proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the machine-generated HTML,
PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following
pages as are needed to hold, legibly, the material this License requires to appear in the
title page. For works in formats which do not have any title page as such, “Title Page”
means the text near the most prominent appearance of the work’s title, preceding the
beginning of the body of the text.
A section “Entitled XYZ” means a named subunit of the Document whose title either
is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in
another language. (Here XYZ stands for a specific section name mentioned below, such
as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve
the Title” of such a section when you modify the Document means that it remains a
section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that
this License applies to the Document. These Warranty Disclaimers are considered to
be included by reference in this License, but only as regards disclaiming warranties:
any other implication that these Warranty Disclaimers may have is void and has no
effect on the meaning of this License.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or
noncommercially, provided that this License, the copyright notices, and the license
notice saying this License applies to the Document are reproduced in all copies, and
Appendix A: GNU Free Documentation License 281
that you add no other conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further copying of the copies
you make or distribute. However, you may accept compensation in exchange for copies.
If you distribute a large enough number of copies you must also follow the conditions
in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly
display copies.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of
the Document, numbering more than 100, and the Document’s license notice requires
Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all
these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify you as the publisher
of these copies. The front cover must present the full title with all words of the title
equally prominent and visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve the title of the
Document and satisfy these conditions, can be treated as verbatim copying in other
respects.
If the required texts for either cover are too voluminous to fit legibly, you should put
the first ones listed (as many as fit reasonably) on the actual cover, and continue the
rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100,
you must either include a machine-readable Transparent copy along with each Opaque
copy, or state in or with each Opaque copy a computer-network location from which
the general network-using public has access to download using public-standard network
protocols a complete Transparent copy of the Document, free of added material. If
you use the latter option, you must take reasonably prudent steps, when you begin
distribution of Opaque copies in quantity, to ensure that this Transparent copy will
remain thus accessible at the stated location until at least one year after the last time
you distribute an Opaque copy (directly or through your agents or retailers) of that
edition to the public.
It is requested, but not required, that you contact the authors of the Document well
before redistributing any large number of copies, to give them a chance to provide you
with an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions
of sections 2 and 3 above, provided that you release the Modified Version under precisely
this License, with the Modified Version filling the role of the Document, thus licensing
distribution and modification of the Modified Version to whoever possesses a copy of
it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct from that of the
Document, and from those of previous versions (which should, if there were any,
be listed in the History section of the Document). You may use the same title as
a previous version if the original publisher of that version gives permission.
282 Autoconf
B. List on the Title Page, as authors, one or more persons or entities responsible for
authorship of the modifications in the Modified Version, together with at least five
of the principal authors of the Document (all of its principal authors, if it has fewer
than five), unless they release you from this requirement.
C. State on the Title page the name of the publisher of the Modified Version, as the
publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications adjacent to the other
copyright notices.
F. Include, immediately after the copyright notices, a license notice giving the public
permission to use the Modified Version under the terms of this License, in the form
shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections and required Cover
Texts given in the Document’s license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled “History”, Preserve its Title, and add to it an item
stating at least the title, year, new authors, and publisher of the Modified Version
as given on the Title Page. If there is no section Entitled “History” in the Docu-
ment, create one stating the title, year, authors, and publisher of the Document
as given on its Title Page, then add an item describing the Modified Version as
stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for public access to
a Transparent copy of the Document, and likewise the network locations given in
the Document for previous versions it was based on. These may be placed in the
“History” section. You may omit a network location for a work that was published
at least four years before the Document itself, or if the original publisher of the
version it refers to gives permission.
K. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title
of the section, and preserve in the section all the substance and tone of each of the
contributor acknowledgements and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document, unaltered in their text and
in their titles. Section numbers or the equivalent are not considered part of the
section titles.
M. Delete any section Entitled “Endorsements”. Such a section may not be included
in the Modified Version.
N. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in
title with any Invariant Section.
O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify
as Secondary Sections and contain no material copied from the Document, you may at
your option designate some or all of these sections as invariant. To do this, add their
titles to the list of Invariant Sections in the Modified Version’s license notice. These
titles must be distinct from any other section titles.
Appendix A: GNU Free Documentation License 283
You may add a section Entitled “Endorsements”, provided it contains nothing but
endorsements of your Modified Version by various parties—for example, statements of
peer review or that the text has been approved by an organization as the authoritative
definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up
to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified
Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be
added by (or through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or by arrangement
made by the same entity you are acting on behalf of, you may not add another; but
you may replace the old one, on explicit permission from the previous publisher that
added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission
to use their names for publicity for or to assert or imply endorsement of any Modified
Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License,
under the terms defined in section 4 above for modified versions, provided that you
include in the combination all of the Invariant Sections of all of the original documents,
unmodified, and list them all as Invariant Sections of your combined work in its license
notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical
Invariant Sections may be replaced with a single copy. If there are multiple Invariant
Sections with the same name but different contents, make the title of each such section
unique by adding at the end of it, in parentheses, the name of the original author or
publisher of that section if known, or else a unique number. Make the same adjustment
to the section titles in the list of Invariant Sections in the license notice of the combined
work.
In the combination, you must combine any sections Entitled “History” in the vari-
ous original documents, forming one section Entitled “History”; likewise combine any
sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You
must delete all sections Entitled “Endorsements.”
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released
under this License, and replace the individual copies of this License in the various
documents with a single copy that is included in the collection, provided that you
follow the rules of this License for verbatim copying of each of the documents in all
other respects.
You may extract a single document from such a collection, and distribute it individu-
ally under this License, provided you insert a copy of this License into the extracted
document, and follow this License in all other respects regarding verbatim copying of
that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent
documents or works, in or on a volume of a storage or distribution medium, is called
284 Autoconf
an “aggregate” if the copyright resulting from the compilation is not used to limit the
legal rights of the compilation’s users beyond what the individual works permit. When
the Document is included in an aggregate, this License does not apply to the other
works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document,
then if the Document is less than one half of the entire aggregate, the Document’s Cover
Texts may be placed on covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form. Otherwise they
must appear on printed covers that bracket the whole aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may distribute translations
of the Document under the terms of section 4. Replacing Invariant Sections with
translations requires special permission from their copyright holders, but you may
include translations of some or all Invariant Sections in addition to the original versions
of these Invariant Sections. You may include a translation of this License, and all the
license notices in the Document, and any Warranty Disclaimers, provided that you
also include the original English version of this License and the original versions of
those notices and disclaimers. In case of a disagreement between the translation and
the original version of this License or a notice or disclaimer, the original version will
prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “His-
tory”, the requirement (section 4) to Preserve its Title (section 1) will typically require
changing the actual title.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly
provided for under this License. Any other attempt to copy, modify, sublicense or
distribute the Document is void, and will automatically terminate your rights under
this License. However, parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such parties remain in full
compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free
Documentation License from time to time. Such new versions will be similar in spirit
to the present version, but may differ in detail to address new problems or concerns.
See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document
specifies that a particular numbered version of this License “or any later version”
applies to it, you have the option of following the terms and conditions either of that
specified version or of any later version that has been published (not as a draft) by
the Free Software Foundation. If the Document does not specify a version number of
this License, you may choose any version ever published (not as a draft) by the Free
Software Foundation.
Appendix A: GNU Free Documentation License 285
Appendix B Indices
B LC_MESSAGES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
BIN_SH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 LC_MONETARY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
LC_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
LC_NUMERIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
C LC_PAPER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
LC_TELEPHONE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
CDPATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
LC_TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
CONFIG_COMMANDS . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
CONFIG_FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
CONFIG_HEADERS . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONFIG_LINKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
239
239
M
CONFIG_SHELL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 M4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
CONFIG_SITE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230 MAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
CONFIG_STATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 MAILPATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
CYGWIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
N
D NULLCMD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
DUALCASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
P
E PATH_SEPARATOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 PS1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
PS2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
PS4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
I PWD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
IFS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
S
L SIMPLE_BACKUP_SUFFIX. . . . . . . . . . . . . . . . . . . . . . 240
LANG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
LANGUAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
LC_ADDRESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
W
LC_ALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 WARNINGS . . . . . . . . . . . . . . . . . . . . . . . . 11, 14, 32, 119
LC_COLLATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
LC_CTYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
LC_IDENTIFICATION . . . . . . . . . . . . . . . . . . . . . . . . . 168 X
LC_MEASUREMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 XMKMF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
A abs_top_builddir . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
abs_top_srcdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
abs_builddir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 ALLOCA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
abs_srcdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 AWK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
288 Autoconf
B G
bindir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 GETGROUPS_LIBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 GETLOADAVG_LIBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
build_alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 GREP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
build_cpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
build_os . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
build_vendor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
H
builddir. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
host_alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
host_cpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
C host_os . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
CC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73, 77, 85 host_vendor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
CFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21, 73 htmldir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
configure_input . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
CPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 I
CPPFLAGS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
cross_compiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 includedir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
CXX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 infodir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
INSTALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
CXXCPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
INSTALL_DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
CXXFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 78
INSTALL_PROGRAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
INSTALL_SCRIPT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
D
datadir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 K
datarootdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 KMEM_GROUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
DEFS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
docdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
dvidir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 L
LDFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
LEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
E LEX_OUTPUT_ROOT . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
ECHO_C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 LEXLIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
ECHO_N . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 libdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
ECHO_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 libexecdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
EGREP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 LIBOBJDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
ERL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79, 90, 96 LIBOBJS . . . . . . . . . . . . . . . . . . . . . . . 50, 52, 55, 56, 66
ERLANG_INSTALL_LIB_DIR . . . . . . . . . . . . . . . . . 27, 87 LIBS . . . . . . . . . . . . . . . . . . . . . . . . . . 23, 246, 249, 253
ERLANG_INSTALL_LIB_DIR_library . . . . . . . . 27, 87 LN_S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
ERLANG_LIB_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 localedir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
ERLANG_LIB_DIR_library . . . . . . . . . . . . . . . . . . . . 86 localstatedir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
ERLANG_LIB_VER_library . . . . . . . . . . . . . . . . . . . . 86
ERLANG_ROOT_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ERLC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79, 90 M
ERLCFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22, 79, 90 mandir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
exec_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 MKDIR_P . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
EXEEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70, 244
N
F NEED_SETGID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
F77 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
FC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
FCFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23, 80
O
FCLIBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 OBJC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
FFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23, 79 OBJCFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23, 78
FGREP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 OBJCPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
FLIBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 OBJEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70, 247
oldincludedir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Appendix B: Indices 289
OPENMP_CFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 sharedstatedir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
OPENMP_CXXFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 srcdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
OPENMP_FCFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 subdirs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
OPENMP_FFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 sysconfdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
P T
PACKAGE_BUGREPORT . . . . . . . . . . . . . . . . . . . . . . . . . . 15 target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
PACKAGE_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 target_alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
PACKAGE_STRING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 target_cpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
PACKAGE_TARNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 target_os . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
PACKAGE_VERSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
target_vendor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
pdfdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
top_build_prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
POW_LIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
top_builddir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
top_srcdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
program_transform_name . . . . . . . . . . . . . . . . . . . 228
psdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
X
R X_CFLAGS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
RANLIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 X_EXTRA_LIBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
X_LIBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
X_PRE_LIBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
S
sbindir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
SED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Y
SET_MAKE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 YACC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
C
__CHAR_UNSIGNED__ . . . . . . . . . . . . . . . . . . . . . . . . . . 76 C_ALLOCA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
__EXTENSIONS__ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 C_GETLOADAVG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
__PROTOTYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 CLOSEDIR_VOID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
_ALL_SOURCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 241 const . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
_FILE_OFFSET_BITS . . . . . . . . . . . . . . . . . . . . . . . . . . 85 CXX_NO_MINUS_C_MINUS_O . . . . . . . . . . . . . . . . . . . . 78
_GNU_SOURCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 245
_LARGE_FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
_LARGEFILE_SOURCE . . . . . . . . . . . . . . . . . . . . . . . . . . 50
D
_MINIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 247 DGUX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
_OPENMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 DIRENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
_POSIX_1_SOURCE. . . . . . . . . . . . . . . . . . . . . . . . 85, 247
_POSIX_PTHREAD_SEMANTICS . . . . . . . . . . . . . . . . . . 85 F
_POSIX_SOURCE . . . . . . . . . . . . . . . . . . . . . . . . . . 85, 247
_POSIX_VERSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 F77_DUMMY_MAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
F77_FUNC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
_TANDEM_SOURCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
F77_FUNC_ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
F77_MAIN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
F77_NO_MINUS_C_MINUS_O . . . . . . . . . . . . . . . . . . . . 80
A FC_FUNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ALIGNOF_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 FC_FUNC_. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
FC_MAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
FC_NO_MINUS_C_MINUS_O . . . . . . . . . . . . . . . . . . . . . 80
290 Autoconf
FLEXIBLE_ARRAY_MEMBER . . . . . . . . . . . . . . . . . . . . . 77 HAVE_STRNLEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
HAVE_STRTOLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
HAVE_STRUCT_DIRENT_D_INO . . . . . . . . . . . . . . . . . . 66
G HAVE_STRUCT_DIRENT_D_TYPE . . . . . . . . . . . . . . . . . 66
GETGROUPS_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 HAVE_STRUCT_STAT_ST_BLKSIZE . . . . . . . . . . . . . . 250
GETLOADAVG_PRIVILEGED . . . . . . . . . . . . . . . . . . . . . 50 HAVE_STRUCT_STAT_ST_BLOCKS . . . . . . . . . . . . . . . . 66
GETPGRP_VOID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 HAVE_STRUCT_STAT_ST_RDEV . . . . . . . . . . . . . . . . . 250
gid_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 HAVE_STRUCT_TM_TM_ZONE . . . . . . . . . . . . . . . . . . . . 66
GWINSZ_IN_SYS_IOCTL . . . . . . . . . . . . . . . . . . . . . . . . 63 HAVE_SYS_DIR_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
HAVE_SYS_NDIR_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
HAVE_SYS_WAIT_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
H HAVE_TM_ZONE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
HAVE__BOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 HAVE_type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
HAVE_aggregate _member . . . . . . . . . . . . . . . . . . . . . 67 HAVE_TYPEOF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
HAVE_ALLOCA_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 HAVE_TZNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
HAVE_C_BACKSLASH_A . . . . . . . . . . . . . . . . . . . . . . . . . 75 HAVE_UINT16_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
HAVE_C_VARARRAYS . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 HAVE_UINT32_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
HAVE_CHOWN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 HAVE_UINT64_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
HAVE_CONFIG_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 HAVE_UINT8_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
HAVE_DECL_STRERROR_R . . . . . . . . . . . . . . . . . . . . . . . 53 HAVE_UINTMAX_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
HAVE_DECL_symbol . . . . . . . . . . . . . . . . . . . . . . . 64, 65 HAVE_UINTPTR_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
HAVE_DECL_TZNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 HAVE_UNSIGNED_LONG_LONG_INT . . . . . . . . . . . . . . . 69
HAVE_DIRENT_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 HAVE_UTIME_NULL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
HAVE_DOPRNT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 HAVE_VFORK_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
HAVE_FSEEKO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 HAVE_VPRINTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
HAVE_function . . . . . . . . . . . . . . . . . . . . . . . . . . 55, 56 HAVE_WAIT3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
HAVE_GETGROUPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 HAVE_WORKING_FORK . . . . . . . . . . . . . . . . . . . . . . . . . . 50
HAVE_GETMNTENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 HAVE_WORKING_VFORK . . . . . . . . . . . . . . . . . . . . . . . . . 50
HAVE_header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63, 64
HAVE_INT16_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
HAVE_INT32_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
I
HAVE_INT64_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 inline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
HAVE_INT8_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 INT_16_BITS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
HAVE_INTMAX_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 int16_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
HAVE_INTPTR_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 int32_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
HAVE_LONG_DOUBLE . . . . . . . . . . . . . . . . . . . . . . 68, 241 int64_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
HAVE_LONG_DOUBLE_WIDER . . . . . . . . . . . . . . . . . . . . 68 int8_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
HAVE_LONG_FILE_NAMES . . . . . . . . . . . . . . . . . . . . . . . 85 intmax_t. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
HAVE_LONG_LONG_INT . . . . . . . . . . . . . . . . . . . . . . . . . 68 intptr_t. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
HAVE_LSTAT_EMPTY_STRING_BUG . . . . . . . . . . . . . . . 53
HAVE_MALLOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
HAVE_MBRTOWC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
L
HAVE_MMAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 LONG_64_BITS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
HAVE_NDIR_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 LSTAT_FOLLOWS_SLASHED_SYMLINK . . . . . . . . . . . . . 51
HAVE_NLIST_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
HAVE_OBSTACK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
HAVE_REALLOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 M
HAVE_RESOLV_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 MAJOR_IN_MKDEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
HAVE_RESTARTABLE_SYSCALLS . . . . . . . . . . . . . . . . 250 MAJOR_IN_SYSMACROS . . . . . . . . . . . . . . . . . . . . . . . . . 59
HAVE_ST_BLKSIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . 250 malloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
HAVE_ST_BLOCKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 mbstate_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
HAVE_ST_RDEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250 mode_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
HAVE_STAT_EMPTY_STRING_BUG . . . . . . . . . . . . . . . . 53
HAVE_STDBOOL_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
HAVE_STRCOLL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 N
HAVE_STRERROR_R . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 NDEBUG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
HAVE_STRFTIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 NDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
HAVE_STRINGIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 NEED_MEMORY_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Appendix B: Indices 291
T
O TIME_WITH_SYS_TIME . . . . . . . . . . . . . . . . . . . . . . . . . 62
off_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 TM_IN_SYS_TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
typeof . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
P
PACKAGE_BUGREPORT . . . . . . . . . . . . . . . . . . . . . . . . . . 15 U
PACKAGE_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 uid_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
PACKAGE_STRING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 uint16_t. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
PACKAGE_TARNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 uint32_t. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
PACKAGE_VERSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 uint64_t. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
PARAMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 uint8_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
pid_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 uintmax_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
PROTOTYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 uintptr_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
UMAX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
R UMAX4_3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
USG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
realloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
restrict. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
RETSIGTYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 V
variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101, 102
S vfork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
volatile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
SELECT_TYPE_ARG1 . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
SELECT_TYPE_ARG234 . . . . . . . . . . . . . . . . . . . . . . . . . 53
SELECT_TYPE_ARG5 . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 W
SETPGRP_VOID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
SETVBUF_REVERSED . . . . . . . . . . . . . . . . . . . . . . . . . . 244 WORDS_BIGENDIAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
size_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
SIZEOF_type-or-expr . . . . . . . . . . . . . . . . . . . . . . . 71
ssize_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
X
STAT_MACROS_BROKEN . . . . . . . . . . . . . . . . . . . . . . . . . 60 X_DISPLAY_MISSING . . . . . . . . . . . . . . . . . . . . . . . . . . 84
STDC_HEADERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
STRERROR_R_CHAR_P . . . . . . . . . . . . . . . . . . . . . . . . . . 53
SVR4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Y
SYS_SIGLIST_DECLARED. . . . . . . . . . . . . . . . . . . . . . 243 YYTEXT_POINTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
A ARG_PROGRAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
ARG_VAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
AH_BOTTOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
ARG_WITH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
AH_HEADER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
AU_ALIAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
AH_TEMPLATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
AU_DEFUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
AH_TOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 AUTOCONF_VERSION . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
AH_VERBATIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
AIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
ALLOCA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 B
ARG_ARRAY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 BEFORE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
ARG_ENABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
292 Autoconf
C CONFIG_LIBOBJ_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . 56
C_BACKSLASH_A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 CONFIG_LINKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
C_BIGENDIAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 CONFIG_MACRO_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
C_CHAR_UNSIGNED . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 CONFIG_SRCDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
C_CONST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 CONFIG_SUBDIRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
C_CROSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 CONFIG_TESTDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
C_FLEXIBLE_ARRAY_MEMBER . . . . . . . . . . . . . . . . . . . 77 CONST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
C_INLINE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 COPYRIGHT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
C_LONG_DOUBLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 CROSS_CHECK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
C_PROTOTYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 CYGWIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
C_RESTRICT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
C_STRINGIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 D
C_TYPEOF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
C_VARARRAYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 DATAROOTDIR_CHECKED . . . . . . . . . . . . . . . . . . . . . . . . 28
C_VOLATILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 DECL_SYS_SIGLIST . . . . . . . . . . . . . . . . . . . . . . . . . . 243
CACHE_CHECK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 DECL_YYTEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
CACHE_LOAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 DEFINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
CACHE_SAVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 DEFINE_UNQUOTED . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
CACHE_VAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 DEFUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
CANONICAL_BUILD . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 DEFUN_ONCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
CANONICAL_HOST . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 DIAGNOSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
CANONICAL_SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . 242 DIR_HEADER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
CANONICAL_TARGET . . . . . . . . . . . . . . . . . . . . . . . . . . 220 DISABLE_OPTION_CHECKING . . . . . . . . . . . . . . . . . . 228
CHAR_UNSIGNED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 DYNIX_SEQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
CHECK_ALIGNOF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
CHECK_DECL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
CHECK_DECLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 E
CHECK_DECLS_ONCE . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 EGREP_CPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
CHECK_FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 EGREP_HEADER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
CHECK_FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 EMXOS2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
CHECK_FUNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 ENABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
CHECK_FUNCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 ERLANG_CHECK_LIB . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
CHECK_FUNCS_ONCE . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 ERLANG_NEED_ERL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
CHECK_HEADER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 ERLANG_NEED_ERLC . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
CHECK_HEADERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 ERLANG_PATH_ERL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
CHECK_HEADERS_ONCE . . . . . . . . . . . . . . . . . . . . . . . . . 64 ERLANG_PATH_ERLC . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
CHECK_LIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 ERLANG_SUBST_INSTALL_LIB_DIR. . . . . . . . . . . 27, 87
CHECK_MEMBER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 ERLANG_SUBST_INSTALL_LIB_SUBDIR . . . . . . . 27, 87
CHECK_MEMBERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 ERLANG_SUBST_LIB_DIR . . . . . . . . . . . . . . . . . . . . . . . 86
CHECK_PROG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 ERLANG_SUBST_ROOT_DIR . . . . . . . . . . . . . . . . . . . . . 86
CHECK_PROGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 ERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
CHECK_SIZEOF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 EXEEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
CHECK_TARGET_TOOL . . . . . . . . . . . . . . . . . . . . . . . . . . 42
CHECK_TARGET_TOOLS . . . . . . . . . . . . . . . . . . . . . . . . . 43
CHECK_TOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 F
CHECK_TOOLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 F77_DUMMY_MAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
CHECK_TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70, 242 F77_FUNC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CHECK_TYPES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 F77_LIBRARY_LDFLAGS . . . . . . . . . . . . . . . . . . . . . . . . 80
CHECKING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 F77_MAIN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
COMPILE_CHECK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 F77_WRAPPERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
COMPILE_IFELSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 FATAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
COMPUTE_INT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 FC_FREEFORM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
CONFIG_AUX_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 FC_FUNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CONFIG_COMMANDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 FC_LIBRARY_LDFLAGS . . . . . . . . . . . . . . . . . . . . . . . . . 80
CONFIG_COMMANDS_POST . . . . . . . . . . . . . . . . . . . . . . . 34 FC_MAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
CONFIG_COMMANDS_PRE . . . . . . . . . . . . . . . . . . . . . . . . 34 FC_SRCEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CONFIG_FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 FC_WRAPPERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
CONFIG_HEADERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 FIND_X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Appendix B: Indices 293
O PROGRAM_CHECK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
OBJEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 PROGRAM_EGREP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
OBSOLETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 PROGRAM_PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
OFF_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 PROGRAMS_CHECK . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
OPENMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 PROGRAMS_PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
OUTPUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18, 248
OUTPUT_COMMANDS . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
R
REMOTE_TAPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
P REPLACE_FNMATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
PACKAGE_BUGREPORT . . . . . . . . . . . . . . . . . . . . . . . . . . 15 REPLACE_FUNCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
PACKAGE_NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 REQUIRE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
PACKAGE_STRING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 REQUIRE_AUX_FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
PACKAGE_TARNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 REQUIRE_CPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
PACKAGE_VERSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 RESTARTABLE_SYSCALLS. . . . . . . . . . . . . . . . . . . . . . 249
PATH_PROG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 RETSIGTYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
PATH_PROGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 REVISION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
PATH_PROGS_FEATURE_CHECK . . . . . . . . . . . . . . . . . . 43 RSH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
PATH_TARGET_TOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 RUN_IFELSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
PATH_TOOL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
PATH_X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
PATH_XTRA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
S
PID_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 SCO_INTL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
PREFIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 SEARCH_LIBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
PREFIX_DEFAULT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 SET_MAKE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
PREFIX_PROGRAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 SETVBUF_REVERSED . . . . . . . . . . . . . . . . . . . . . . . . . . 249
PREPROC_IFELSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 SIZE_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
PREREQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 SIZEOF_TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
PRESERVE_HELP_ORDER . . . . . . . . . . . . . . . . . . . . . . . 223 ST_BLKSIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
PROG_AWK. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 ST_BLOCKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
PROG_CC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 ST_RDEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
PROG_CC_C_O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 STAT_MACROS_BROKEN . . . . . . . . . . . . . . . . . . . . . . . . 250
PROG_CC_C89 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 STDC_HEADERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
PROG_CC_C99 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 STRCOLL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
PROG_CC_STDC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 STRUCT_DIRENT_D_INO . . . . . . . . . . . . . . . . . . . . . . . . 66
PROG_CPP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 STRUCT_DIRENT_D_TYPE . . . . . . . . . . . . . . . . . . . . . . . 66
PROG_CPP_WERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 STRUCT_ST_BLKSIZE . . . . . . . . . . . . . . . . . . . . . . . . . 250
PROG_CXX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 STRUCT_ST_BLOCKS . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
PROG_CXX_C_O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 STRUCT_ST_RDEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
PROG_CXXCPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 STRUCT_TIMEZONE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
PROG_EGREP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 STRUCT_TM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
PROG_F77. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 SUBST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
PROG_F77_C_O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 SUBST_FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
PROG_FC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 SYS_INTERPRETER . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
PROG_FC_C_O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 SYS_LARGEFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
PROG_FGREP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 SYS_LONG_FILE_NAMES . . . . . . . . . . . . . . . . . . . . . . . . 85
PROG_GCC_TRADITIONAL . . . . . . . . . . . . . . . . . . . . . . . 77 SYS_POSIX_TERMIOS . . . . . . . . . . . . . . . . . . . . . . . . . . 85
PROG_GREP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 SYS_RESTARTABLE_SYSCALLS . . . . . . . . . . . . . . . . . 250
PROG_INSTALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 SYS_SIGLIST_DECLARED. . . . . . . . . . . . . . . . . . . . . . 250
PROG_LEX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
PROG_LN_S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
PROG_MAKE_SET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 T
PROG_MKDIR_P . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 TEST_CPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
PROG_OBJC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 TEST_PROGRAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
PROG_OBJCPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 TIME_WITH_SYS_TIME . . . . . . . . . . . . . . . . . . . . . . . . 251
PROG_RANLIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 TIMEZONE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
PROG_SED. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 TRY_COMPILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
PROG_YACC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 TRY_CPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Appendix B: Indices 295
TRY_LINK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 U
TRY_LINK_FUNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 UID_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
TRY_RUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 UNISTD_H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
TYPE_GETGROUPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 USE_SYSTEM_EXTENSIONS . . . . . . . . . . . . . . . . . . . . . 85
TYPE_INT16_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 USG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
TYPE_INT32_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 UTIME_NULL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
TYPE_INT64_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
TYPE_INT8_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
TYPE_INTMAX_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 V
TYPE_INTPTR_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 VALIDATE_CACHED_SYSTEM_TUPLE . . . . . . . . . . . . . 252
TYPE_LONG_DOUBLE . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 VERBOSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
TYPE_LONG_DOUBLE_WIDER . . . . . . . . . . . . . . . . . . . . 68 VFORK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
TYPE_LONG_LONG_INT . . . . . . . . . . . . . . . . . . . . . . . . . 68 VPRINTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
TYPE_MBSTATE_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
TYPE_MODE_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
TYPE_OFF_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 W
TYPE_PID_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 WAIT3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
TYPE_SIGNAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 WARN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
TYPE_SIZE_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 WARNING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
TYPE_SSIZE_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 WITH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
TYPE_UID_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 WORDS_BIGENDIAN . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
TYPE_UINT16_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
TYPE_UINT32_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
TYPE_UINT64_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 X
TYPE_UINT8_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 XENIX_DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
TYPE_UINTMAX_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
TYPE_UINTPTR_T . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
TYPE_UNSIGNED_LONG_LONG_INT . . . . . . . . . . . . . . . 69 Y
YYTEXT_POINTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
C
__file__ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 car . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
__line__ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
__oline__ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 CASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
cdr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
changecom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
A changequote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 cmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
append_uniq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 combine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
append_uniq_w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 cond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
apply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
assert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
D
B debugfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
bmatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 debugmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
BOURNE_COMPATIBLE . . . . . . . . . . . . . . . . . . . . . . . . . 140 decr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
bpatsubst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
bpatsubsts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 define . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
bregexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 defn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
builtin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 DIRNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
296 Autoconf
divert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 L
divert_once . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 len . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
divert_pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 list_cmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
divert_push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
divert_text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
divnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
dnl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 M
do . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 make_list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
dquote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 maketemp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
dquote_elt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
dumpdef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 MESSAGE_FD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
MESSAGE_LOG_FD . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
E MKDIR_P . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
echo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 mkstemp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
errprint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
errprintn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
esyscmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 N
eval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 newline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 normalize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
F O
fatal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 ORIGINAL_STDIN_FD . . . . . . . . . . . . . . . . . . . . . . . . . 141
flatten . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
for . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 P
foreach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
foreach_w . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 pattern_allow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 pattern_forbid . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
popdef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
pushdef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
H
HELP_STRING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 Q
quote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
I
if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 R
IF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
ifdef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 re_escape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
ifndef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ifset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ifval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
S
ifvaln . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 SET_CATFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
ignore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 SHELL_SANITIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
include . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
incr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 shift2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 shift3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
indir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 shiftn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
init . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
INIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 sinclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
split . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
strip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
J substr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
syscmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
sysval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Appendix B: Indices 297
T undivert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
text_box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 unquote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
text_wrap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
tolower . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
toupper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 V
TR_CPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
TR_SH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 version_compare . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
traceoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
traceon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
translit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 W
warn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
U wrap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
undefine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 wrap_lifo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
B K
BANNER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 KEYWORDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
C
CAPTURE_FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 S
CHECK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 SETUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
CLEANUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
COPYRIGHT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
T
D TESTED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
I X
INIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 XFAIL_IF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
B I
basename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 ‘inttypes.h’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57, 67
isinf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
isnan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
C
case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
cat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 J
cc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
cd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
chmod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
chown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 K
closedir. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 ‘ksh’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
cmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 ‘ksh88’. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
cp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 ‘ksh93’. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
‘ctype.h’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
L
D ‘linux/irda.h’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 ‘linux/random.h’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
diff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 ln . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
‘dirent.h’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 ls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
dirname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 lstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51, 53
E M
echo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 make . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
egrep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 malloc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46, 52
error_at_line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 mbrtowc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
eval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 memcmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 mkdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 mktemp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 mktime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
expr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184, 185 mmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
expr (‘|’) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 mv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
F N
false . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 ‘ndir.h’. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
fgrep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 ‘net/if.h’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 ‘netinet/if_ether.h’ . . . . . . . . . . . . . . . . . . . . . . . . 57
‘float.h’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 ‘nlist.h’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
fnmatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50, 54
‘fnmatch.h’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
for . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175 O
fork . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 od . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
free . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
fseeko . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
P
‘pdksh’. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
G printf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
getgroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 putenv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
getloadavg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 pwd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
getmntent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
getpgid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
getpgrp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 R
grep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Appendix B: Indices 299
$((expression)) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
$(commands) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 @
$<, explicit rules, and VPATH . . . . . . . . . . . . . . . . . 200 ‘@&t@’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
${#var} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 ‘@S|@’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
${var##word} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
300 Autoconf
Q T
QNX 4.25 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 termios Posix headers . . . . . . . . . . . . . . . . . . . . . . . . 85
quadrigraphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 test group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
quotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7, 111 testsuite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261, 265
timestamp resolution . . . . . . . . . . . . . . . 183, 193, 206
Transforming program names . . . . . . . . . . . . . . . . 228
R Tru64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Remaking automatically . . . . . . . . . . . . . . . . . . . . . . 29 Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Rule, Single Suffix Inference . . . . . . . . . . . . . . . . . 206
U
undefined macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
S Unix version 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Upgrading autoconf . . . . . . . . . . . . . . . . . . . . 253, 256
Separated Dependencies . . . . . . . . . . . . . . . . . . . . . 206
SHELL and make . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Shell assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 V
Shell builtins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
V7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Shell file descriptors. . . . . . . . . . . . . . . . . . . . . . . . . 156
Variable, Precious . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Shell Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Shell here-documents . . . . . . . . . . . . . . . . . . . . . . . 155
version, Autoconf . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Shell parentheses . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
volatile objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Shell pattern matching . . . . . . . . . . . . . . . . . . . . . . 160
VPATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Shell slashes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
VPATH and automatic rule rewriting . . . . . . . . . . 200
Shell substitutions . . . . . . . . . . . . . . . . . . . . . . . . . . 160
VPATH and double-colon rules . . . . . . . . . . . . . . . . 200
Shell variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
VPATH and prerequisite directories . . . . . . . . . . . . 203
Shellology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
VPATH, explicit rules, and $< . . . . . . . . . . . . . . . . . 200
signed integer overflow . . . . . . . . . . . . . . . . . . 210, 213 VPATH, resolving target pathnames . . . . . . . . . . . 203
Single Suffix Inference Rule . . . . . . . . . . . . . . . . . . 206
Site defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Site details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 W
Special shell variables . . . . . . . . . . . . . . . . . . . . . . . 166
wraparound arithmetic . . . . . . . . . . . . . . . . . 210, 213
standard input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Standard symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Structure, checking . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Subdirectory configure . . . . . . . . . . . . . . . . . . . . . . . 35
X
Substitutions in makefiles . . . . . . . . . . . . . . . . . . . . 21 X Window System . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Symbolic links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
System type . . . . . . . . . . . . . . . . . . . . . . . . . . . 219, 220
Systemology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Z
Zsh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155