by the Foundation.
@end titlepage
+@c Define a macro index that @@defmacro doesn't write to.
+@defcodeindex ma
+
@node Top, Introduction, , (dir)
@comment node-name, next, previous, up
programs:
@defmac AC_DECLARE_YYTEXT
-@findex DECLARE_YYTEXT
+@maindex DECLARE_YYTEXT
@vindex DECLARE_YYTEXT
Define @code{DECLARE_YYTEXT} to declare @code{yytext} appropriately,
depending on whether @code{lex} or @code{flex} is being used. This
@end defmac
@defmac AC_LN_S
-@findex LN_S
+@maindex LN_S
If @samp{ln -s} works on the current filesystem (the O.S. and filesystem
support symbolic links), set shell and @code{make} variable @code{LN_S}
to @samp{ln -s}, otherwise set it to @samp{ln}.
@end defmac
@defmac AC_MINUS_C_MINUS_O
-@findex MINUS_C_MINUS_O
+@maindex MINUS_C_MINUS_O
@vindex NO_MINUS_C_MINUS_O
If the C compiler does not accept the @samp{-c} and @samp{-o} options
simultaneously, define @code{NO_MINUS_C_MINUS_O}.
@end defmac
@defmac AC_PROG_YACC
-@findex PROG_YACC
+@maindex PROG_YACC
If @code{bison} is found, set @code{make} variable @code{YACC} to
@samp{bison -y}. Otherwise, if @code{byacc} is found, set @code{YACC}
to @samp{byacc}. Otherwise set @code{YACC} to @samp{yacc}.
@end defmac
@defmac AC_PROG_CPP
-@findex PROG_CPP
+@maindex PROG_CPP
Set shell and @code{make} variable @code{CPP} to a command that runs the
C preprocessor. If @samp{$CC -E} doesn't work, it uses @file{/lib/cpp}.
@end defmac
@defmac AC_PROG_LEX
-@findex PROG_LEX
+@maindex PROG_LEX
If @code{flex} is found, set @code{make} variable @code{LEX} to
@samp{flex} and @code{LEXLIB} to @samp{-lfl}, if that library is in a
standard place. Otherwise set @code{LEX} to @samp{lex} and
@end defmac
@defmac AC_PROG_AWK
-@findex PROG_AWK
+@maindex PROG_AWK
Check for @code{mawk}, @code{gawk}, @code{nawk}, and @code{awk}, in that
order, and set @code{make} variable @code{AWK} to the first one that it
finds.
@end defmac
@defmac AC_PROG_CC
-@findex PROG_CC
+@maindex PROG_CC
If @code{gcc} is found, set @code{make} variable @code{CC} to @samp{gcc},
and set shell variable @code{GCC} to 1 for use by macros such as
@code{AC_GCC_TRADITIONAL}.
@end defmac
@defmac AC_GCC_TRADITIONAL
-@findex GCC_TRADITIONAL
+@maindex GCC_TRADITIONAL
Add @samp{-traditional} to @code{make} variable @code{CC} if using the
GNU C compiler and @code{ioctl} does not work properly without
@samp{-traditional}. This macro calls @code{AC_PROG_CC} and
@end defmac
@defmac AC_PROG_INSTALL
-@findex PROG_INSTALL
+@maindex PROG_INSTALL
Set @code{make} variable @code{INSTALL} to @samp{install -c} if
@code{install} is found, otherwise set it to @samp{cp}. Screens out the
false matches @file{/etc/install}, @file{/usr/sbin/install}, and other
@end defmac
@defmac AC_PROG_RANLIB
-@findex PROG_RANLIB
+@maindex PROG_RANLIB
Set @code{make} variable @code{RANLIB} to @samp{ranlib} if @code{ranlib}
is found, otherwise to @samp{:} (do nothing).
@end defmac
@defmac AC_RSH
-@findex RSH
+@maindex RSH
@vindex NO_REMOTE
@vindex HAVE_NETDB_H
If a remote shell is available, put @samp{rtapelib.o} in @code{make}
The following macros check for the presence of certain C header files:
@defmac AC_DIR_HEADER
-@findex DIR_HEADER
+@maindex DIR_HEADER
@vindex DIRENT
@vindex SYSDIR
@vindex SYSNDIR
@end defmac
@defmac AC_MAJOR_HEADER
-@findex MAJOR_HEADER
+@maindex MAJOR_HEADER
@vindex MAJOR_IN_MKDEV
@vindex MAJOR_IN_SYSMACROS
If @file{sys/types.h} does not define @code{major}, @code{minor}, and
@end defmac
@defmac AC_MEMORY_H
-@findex MEMORY_H
+@maindex MEMORY_H
@vindex NEED_MEMORY_H
Define @code{NEED_MEMORY_H} if @code{memcpy}, @code{memcmp}, etc. are
not declared in @file{string.h} and @file{memory.h} exists. This macro
@end defmac
@defmac AC_STDC_HEADERS
-@findex STDC_HEADERS
+@maindex STDC_HEADERS
@vindex STDC_HEADERS
Define @code{STDC_HEADERS} if the system has ANSI C header files.
Specifically, this macro checks for @file{stdlib.h}, @file{stdarg.h},
@end defmac
@defmac AC_UNISTD_H
-@findex UNISTD_H
+@maindex UNISTD_H
@vindex HAVE_UNISTD_H
Define @code{HAVE_UNISTD_H} if the system has @file{unistd.h}. The way
to check if the system supports POSIX.1 is:
@end defmac
@defmac AC_USG
-@findex USG
+@maindex USG
@vindex USG
Define @code{USG} if the system does not have @file{strings.h},
@code{rindex}, @code{bzero}, etc. This implies that it has
The following macros check for predefined C types:
@defmac AC_GETGROUPS_T
-@findex GETGROUPS_T
+@maindex GETGROUPS_T
@vindex GETGROUPS_T
Define @code{GETGROUPS_T} to be whichever of @code{gid_t} or @code{int}
is the base type of the array argument to @code{getgroups}.
@end defmac
@defmac AC_MODE_T
-@findex MODE_T
+@maindex MODE_T
@vindex mode_t
If @code{mode_t} is not defined in @file{sys/types.h}, define
@code{mode_t} to be @code{int}.
@end defmac
@defmac AC_OFF_T
-@findex OFF_T
+@maindex OFF_T
@vindex off_t
If @code{off_t} is not defined in @file{sys/types.h}, define
@code{off_t} to be @code{long}.
@end defmac
@defmac AC_PID_T
-@findex PID_T
+@maindex PID_T
@vindex pid_t
If @code{pid_t} is not defined in @file{sys/types.h}, define
@code{pid_t} to be @code{int}.
@end defmac
@defmac AC_RETSIGTYPE
-@findex RETSIGTYPE
+@maindex RETSIGTYPE
@vindex RETSIGTYPE
If @file{signal.h} declares @code{signal} as returning a pointer to a
function returning @code{void}, define @code{RETSIGTYPE} to be
@end defmac
@defmac AC_SIZE_T
-@findex SIZE_T
+@maindex SIZE_T
@vindex size_t
If @code{size_t} is not defined in @file{sys/types.h}, define
@code{size_t} to be @code{unsigned}.
@end defmac
@defmac AC_UID_T
-@findex UID_T
+@maindex UID_T
@vindex uid_t
@vindex gid_t
If @code{uid_t} is not defined in @file{sys/types.h}, define
The following macros check for particular C library functions:
@defmac AC_ALLOCA
-@findex ALLOCA
+@maindex ALLOCA
@vindex HAVE_ALLOCA_H
Check how to get @code{alloca}. Tries to get a builtin version by
checking for @file{alloca.h} or the predefined C preprocessor macros
@end defmac
@defmac AC_GETLOADAVG
-@findex GETLOADAVG
+@maindex GETLOADAVG
+@vindex SVR4
+@vindex DGUX
+@vindex UMAX
+@vindex UMAX4_3
@vindex NLIST_STRUCT
@vindex NLIST_NAME_UNION
@vindex GETLODAVG_PRIVILEGED
@end defmac
@defmac AC_SETVBUF_REVERSED
-@findex SETVBUF_REVERSED
+@maindex SETVBUF_REVERSED
@vindex SETVBUF_REVERSED
If @code{setvbuf} takes the buffering type as its second argument and
the buffer pointer as the third, instead of the other way around, define
@end defmac
@defmac AC_STRCOLL
-@findex STRCOLL
+@maindex STRCOLL
@vindex HAVE_STRCOLL
Check for a proper declaration of the @code{strcoll} function. This
does a bit more than @samp{AC_HAVE_FUNCS(strcoll)}, because some systems
@end defmac
@defmac AC_UTIME_NULL
-@findex UTIME_NULL
+@maindex UTIME_NULL
@vindex HAVE_UTIME_NULL
If @samp{utime(@var{file}, NULL)} sets @var{file}'s timestamp to
the present, define @code{HAVE_UTIME_NULL}.
@end defmac
@defmac AC_VFORK
-@findex VFORK
+@maindex VFORK
@vindex HAVE_VFORK_H
@vindex vfork
If @file{vfork.h} is found, define @code{HAVE_VFORK_H}. If a working
@end defmac
@defmac AC_VPRINTF
-@findex VPRINTF
+@maindex VPRINTF
@vindex HAVE_VPRINTF
@vindex HAVE_DOPRNT
If @code{vprintf} is found, define @code{HAVE_VPRINTF}. Otherwise, if
@end defmac
@defmac AC_WAIT3
-@findex WAIT3
+@maindex WAIT3
@vindex HAVE_WAIT3
If @code{wait3} is found and fills in the contents of its third argument
(a @samp{struct rusage *}), which HP-UX does not do, define
The following macros check for certain structures or structure members:
@defmac AC_STAT_MACROS_BROKEN
-@findex STAT_MACROS_BROKEN
-@findex STAT_MACROS_BROKEN
+@maindex STAT_MACROS_BROKEN
+@maindex STAT_MACROS_BROKEN
If the macros @code{S_ISDIR}, @code{S_ISREG} et al. defined
@file{sys/stat.h} do not work properly (returning false positives),
define @code{STAT_MACROS_BROKEN}. This is the case on Tektronix UTekV,
@end defmac
@defmac AC_ST_BLKSIZE
-@findex ST_BLKSIZE
+@maindex ST_BLKSIZE
@vindex HAVE_ST_BLKSIZE
If @code{struct stat} contains an @code{st_blksize} member, define
@code{HAVE_ST_BLKSIZE}.
@end defmac
@defmac AC_ST_BLOCKS
-@findex ST_BLOCKS
+@maindex ST_BLOCKS
@vindex HAVE_ST_BLOCKS
If @code{struct stat} contains an @code{st_blocks} member, define
@code{HAVE_ST_BLOCKS}. Otherwise, add @samp{fileblocks.o} to the
@end defmac
@defmac AC_ST_RDEV
-@findex ST_RDEV
+@maindex ST_RDEV
@vindex HAVE_ST_RDEV
If @code{struct stat} contains an @code{st_rdev} member, define
@code{HAVE_ST_RDEV}.
@end defmac
@defmac AC_TIME_WITH_SYS_TIME
-@findex TIME_WITH_SYS_TIME
+@maindex TIME_WITH_SYS_TIME
@vindex TIME_WITH_SYS_TIME
If a program may include both @file{time.h} and @file{sys/time.h},
define @code{TIME_WITH_SYS_TIME}. On some older systems,
@end defmac
@defmac AC_STRUCT_TM
-@findex STRUCT_TM
+@maindex STRUCT_TM
@vindex TM_IN_SYS_TIME
If @file{time.h} does not define @code{struct tm}, define
@code{TM_IN_SYS_TIME}, which means that including @file{sys/time.h}
@end defmac
@defmac AC_TIMEZONE
-@findex TIMEZONE
+@maindex TIMEZONE
@vindex HAVE_TM_ZONE
@vindex HAVE_TZNAME
Figure out how to get the current timezone. If @code{struct tm} has a
features:
@defmac AC_ARG_ARRAY
-@findex ARG_ARRAY
+@maindex ARG_ARRAY
@vindex NO_ARG_ARRAY
If the address of an argument to a C function can not be used like
the start of an array, define @code{NO_ARG_ARRAY}. This ability allows
@end defmac
@defmac AC_CROSS_CHECK
-@findex CROSS_CHECK
+@maindex CROSS_CHECK
If the C compiler being used does not produce executables that can run
on the system where @code{configure} is being run, set the shell
variable @code{cross_compiling} to 1. This information can be used by
@end defmac
@defmac AC_CHAR_UNSIGNED
-@findex CHAR_UNSIGNED
+@maindex CHAR_UNSIGNED
@vindex __CHAR_UNSIGNED__
If the C type @code{char} is unsigned, define @code{__CHAR_UNSIGNED__},
unless the C compiler predefines it.
@end defmac
@defmac AC_CONST
-@findex CONST
+@maindex CONST
@vindex const
If the C compiler does not fully support the keyword @code{const},
define @code{const} to be empty. Some C compilers that do not define
@end defmac
@defmac AC_INLINE
-@findex INLINE
+@maindex INLINE
@vindex inline
If the C compiler is a version of GCC that supports the keyword
@code{__inline} but not @code{inline} (such as some NeXT versions),
@end defmac
@defmac AC_INT_16_BITS
-@findex INT_16_BITS
+@maindex INT_16_BITS
@vindex INT_16_BITS
-If the C type @code{int} is smaller than the type @code{long}, define
-@code{INT_16_BITS}.
+If the C type @code{int} is 16 bits wide, define @code{INT_16_BITS}.
@end defmac
@defmac AC_LONG_DOUBLE
-@findex HAVE_LONG_DOUBLE
+@maindex HAVE_LONG_DOUBLE
@vindex HAVE_LONG_DOUBLE
If the C compiler supports the @code{long double} type, define
@code{HAVE_LONG_DOUBLE}. Some C compilers that do not define
@end defmac
@defmac AC_WORDS_BIGENDIAN
-@findex WORDS_BIGENDIAN
+@maindex WORDS_BIGENDIAN
@vindex WORDS_BIGENDIAN
If words are stored with the most significant byte first (like Motorola
and SPARC, but not Intel and VAX, CPUs), define @code{WORDS_BIGENDIAN}.
The following macros check for operating system services:
@defmac AC_FIND_X
-@findex FIND_X
+@maindex FIND_X
Try to locate the X Window System include files and libraries by running
@code{xmkmf} on a trivial @file{Imakefile} and examining the
@file{Makefile} that it produces. If successful, set the shell
@end defmac
@defmac AC_HAVE_POUNDBANG (@var{action-if-supported} @r{[}, @var{action-if-unsupported}@r{]})
-@findex HAVE_POUNDBANG
+@maindex HAVE_POUNDBANG
Print @samp{checking if `#!' works in shell scripts} to the standard
output. Then check whether the system supports starting shell scripts
with a line of the form @samp{#!/bin/csh} to select the shell to run
@end defmac
@defmac AC_LONG_FILE_NAMES
-@findex LONG_FILE_NAMES
+@maindex LONG_FILE_NAMES
@vindex HAVE_LONG_FILE_NAMES
If the system supports file names longer than 14 characters, define
@code{HAVE_LONG_FILE_NAMES}.
@end defmac
@defmac AC_REMOTE_TAPE
-@findex REMOTE_TAPE
+@maindex REMOTE_TAPE
@vindex HAVE_SYS_MTIO_H
If BSD tape drive ioctls are available, define @code{HAVE_SYS_MTIO_H},
and if sockets are available add @code{rmt} to @code{make} variable
@end defmac
@defmac AC_RESTARTABLE_SYSCALLS
-@findex RESTARTABLE_SYSCALLS
+@maindex RESTARTABLE_SYSCALLS
@vindex HAVE_RESTARTABLE_SYSCALLS
If the system automatically restarts a system call that is interrupted
by a signal, define @code{HAVE_RESTARTABLE_SYSCALLS}.
their header files or libraries:
@defmac AC_AIX
-@findex AIX
+@maindex AIX
@vindex _ALL_SOURCE
If on AIX, define @code{_ALL_SOURCE}. Allows the use of some BSD
functions. Should be called before any macros that run the C compiler.
@end defmac
@defmac AC_DYNIX_SEQ
-@findex DYNIX_SEQ
+@maindex DYNIX_SEQ
If on DYNIX/ptx (Sequent UNIX), add @samp{-lseq} to @code{make}
variable @code{LIBS}. Allows use of some BSD system calls and
@code{getmntent}.
@end defmac
@defmac AC_IRIX_SUN
-@findex IRIX_SUN
+@maindex IRIX_SUN
If on IRIX (Silicon Graphics UNIX), add @samp{-lsun} to @code{make}
variable @code{LIBS}. Needed to get @code{getmntent}. At sites using
Yellow Pages/NIS, it is also needed to get properly working
@end defmac
@defmac AC_ISC_POSIX
-@findex ISC_POSIX
+@maindex ISC_POSIX
@vindex _POSIX_SOURCE
If on a POSIXized ISC UNIX, define @code{_POSIX_SOURCE} and add
@samp{-posix} (for the GNU C compiler) or @samp{-Xp} (for other C
@end defmac
@defmac AC_MINIX
-@findex MINIX
+@maindex MINIX
@vindex _MINIX
@vindex _POSIX_SOURCE
@vindex _POSIX_1_SOURCE
@end defmac
@defmac AC_SCO_INTL
-@findex SCO_INTL
+@maindex SCO_INTL
If on SCO UNIX, add @samp{-lintl} to @code{make} variable @code{LIBS}.
Used to get @code{strftime}. It must be called before checking for
@code{strftime}.
@end defmac
@defmac AC_XENIX_DIR
-@findex XENIX_DIR
+@maindex XENIX_DIR
@vindex VOID_CLOSEDIR
If on Xenix, define @code{VOID_CLOSEDIR} and add @samp{-lx} to
@code{make} variable @code{LIBS}. Also, if @file{sys/ndir.h} is not
The following macros control the kind of output that Autoconf produces.
@defmac AC_CONFIG_HEADER (@var{header-to-create})
-@findex CONFIG_HEADER
+@maindex CONFIG_HEADER
@vindex HAVE_CONFIG_H
Make @code{AC_OUTPUT} create a file @var{header-to-create} containing C
preprocessor @code{#define} statements and replace @samp{@@DEFS@@} in
@end defmac
@defmac AC_INIT (@var{unique-file-in-source-dir})
-@findex INIT
+@maindex INIT
Process the command-line arguments and find the source code directory.
@var{unique-file-in-source-dir} is some file that is in the package's
source directory; @code{configure} checks for this file's existence to
@end defmac
@defmac AC_PREPARE (@var{unique-file-in-source-dir})
-@findex PREPARE
+@maindex PREPARE
Find the source code directory and set up shell variables necessary for
other Autoconf macros to work. @var{unique-file-in-source-dir} is some
file that is in the package's source directory; @code{configure} checks
@end defmac
@defmac AC_OUTPUT (@r{[}@var{file}@dots{}@r{]})
-@findex OUTPUT
+@maindex OUTPUT
Create output files (typically one or more @file{Makefile}s) and
@file{config.status}. If @code{AC_CONFIG_HEADER} has been called, also
create the header file that was named as its argument. The argument is
@end defmac
@defmac AC_REVISION (@var{revision-info})
-@findex REVISION
+@maindex REVISION
Copy revision stamp @var{revision-info} into the @file{configure}
script, with any dollar signs or double-quotes removed. This macro lets
you put a revision stamp from @file{configure.in} into @file{configure}
macros.
@defmac AC_COMPILE_CHECK (@var{echo-text}, @var{includes}, @var{function-body}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex COMPILE_CHECK
+@maindex COMPILE_CHECK
Print @samp{checking for @var{echo-text}} to the standard output. Then
create a test C program to see whether a function whose body consists of
@var{function-body} can be compiled and linked; @var{includes} is any
@end defmac
@defmac AC_FUNC_CHECK (@var{function}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex FUNC_CHECK
+@maindex FUNC_CHECK
If @var{function} is available, run shell commands
@var{action-if-found}, otherwise @var{action-if-not-found}. If the
functions might be in libraries other than the default C library, first
@end defmac
@defmac AC_HAVE_FUNCS (@var{function}@dots{})
-@findex HAVE_FUNCS
+@maindex HAVE_FUNCS
@vindex HAVE_@var{function}
For each given @var{function} in the whitespace-separated argument list
that is available, define @code{HAVE_@var{function}} (in all caps).
@end defmac
@defmac AC_HAVE_HEADERS (@var{header-file}@dots{})
-@findex HAVE_HEADERS
+@maindex HAVE_HEADERS
@vindex HAVE_@var{header}
For each given @var{header-file} in the whitespace-separated argument
list that exists, define @code{HAVE_@var{header-file}} (in all caps).
@end defmac
@defmac AC_HAVE_LIBRARY (@var{library} @r{[}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]]})
-@findex HAVE_LIBRARY
+@maindex HAVE_LIBRARY
Print @samp{checking for @var{library}} to the standard output. Then
create a test C program to see whether that program can be linked with
the specified library. @var{action-if-found} is a list of shell
@end defmac
@defmac AC_HEADER_CHECK (@var{header-file}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex HEADER_CHECK
+@maindex HEADER_CHECK
If @var{header-file} exists, execute shell commands
@var{action-if-found}, otherwise execute @var{action-if-not-found}. If
you just want to define a symbol if the header file is available,
@end defmac
@defmac AC_HEADER_EGREP (@var{pattern}, @var{header-file}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex HEADER_EGREP
+@maindex HEADER_EGREP
If the output of running the C preprocessor on @var{header-file}
contains the @code{egrep} regular expression @var{pattern}, execute
shell commands @var{action-if-found}, otherwise execute
@end defmac
@defmac AC_PREFIX (@var{program})
-@findex PREFIX
+@maindex PREFIX
If the user did not specify an installation prefix on the command line,
guess a value for it by looking for @var{program} in @code{PATH}, the
way the shell does. If @var{program} is found, set the prefix to the
@end defmac
@defmac AC_PROGRAM_CHECK (@var{variable}, @var{prog-to-check-for}, @var{value-if-found}, @var{value-if-not-found})
-@findex PROGRAM_CHECK
+@maindex PROGRAM_CHECK
Check whether program @var{prog-to-check-for} exists in @code{PATH}. If
it is found, set @var{variable} to @var{value-if-found}, otherwise to
@var{value-if-not-found}. Calls @code{AC_SUBST} for @var{variable}.
@end defmac
@defmac AC_PROGRAM_EGREP (@var{pattern}, @var{program}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex PROGRAM_EGREP
+@maindex PROGRAM_EGREP
@var{program} is the text of a C program, on which shell variable and
backquote substitutions are performed. If the output of running the C
preprocessor on @var{program} contains the @code{egrep} regular
expression @var{pattern}, execute shell commands @var{action-if-found},
otherwise execute @var{action-if-not-found}. (It is an unfortunate
-oversight that we use the word ``PROGRAM'' in Autoconf macro names to
+oversight that we use the word @code{PROGRAM} in Autoconf macro names to
sometimes mean C source code and sometimes mean a UNIX command.)
@end defmac
@defmac AC_PROGRAMS_CHECK (@var{variable}, @var{progs-to-check-for} @r{[}, @var{value-if-not-found}@r{]})
-@findex PROGRAMS_CHECK
+@maindex PROGRAMS_CHECK
Check for each program in the whitespace-separated list
@var{progs-to-check-for} exists in @code{PATH}. If it is found, set
@var{variable} to the name of that program. Otherwise, continue
@end defmac
@defmac AC_REPLACE_FUNCS (@var{function-name}@dots{})
-@findex REPLACE_FUNCS
+@maindex REPLACE_FUNCS
For each given @var{function-name} in the whitespace-separated argument
list that is not in the C library, add @samp{@var{function-name}.o} to
the value of the @code{make} variable @code{LIBOBJS}. If the functions
@end defmac
@defmac AC_TEST_PROGRAM (@var{program}, @var{action-if-true} @r{[}, @var{action-if-false} @r{[}, @var{action-if-cross-compiling}@r{]]})
-@findex TEST_PROGRAM
+@maindex TEST_PROGRAM
@var{program} is the text of a C program, on which shell variable and
backquote substitutions are performed. If it compiles and links
successfully and returns an exit status of 0 when executed, run shell
@end defmac
@defmac AC_TEST_CPP (@var{includes}, @var{action-if-true} @r{[}, @var{action-if-false}@r{]})
-@findex TEST_CPP
+@maindex TEST_CPP
@var{includes} is C @code{#include} statements and declarations, on
which shell variable and backquote substitutions are performed.
(Actually, it can be any C program, but other statements are probably
@end defmac
@defmac AC_WITH (@var{feature}, @var{action-if-true} @r{[}, @var{action-if-false}@r{]})
-@findex WITH
+@maindex WITH
If the user gave @code{configure} the option
@samp{--with-@var{feature}}, run shell commands @var{action-if-true}.
Otherwise run shell commands @var{action-if-false}. The name
variables.
@defmac AC_DEFINE (@var{variable} @r{[}, @var{value}@r{]})
-@findex DEFINE
+@maindex DEFINE
Define C preprocessor variable @var{variable}. If @var{value} is given,
set @var{variable} to that value, otherwise set it to 1. To use a shell
variable as the value, use @code{AC_DEFINE_UNQUOTED} instead. Precede
@end defmac
@defmac AC_DEFINE_UNQUOTED (@var{variable} @r{[}, @var{value}@r{]})
-@findex DEFINE_UNQUOTED
+@maindex DEFINE_UNQUOTED
Like @code{AC_DEFINE}, but it does nothing to quote @var{value} from
various shell and @code{sed} expansions it will undergo. @var{value}
will be used in many different contexts requiring different quoting, and
@end defmac
@defmac AC_SUBST (@var{variable})
-@findex SUBST
+@maindex SUBST
Substitute the variable @var{variable} when creating the output files
(typically one or more @file{Makefile}s). This means replace instances
of @samp{@@@var{variable}@@}, e.g. in @file{Makefile.in}, with the
called in the correct order.
@defmac AC_BEFORE (@var{this-macro-name}, @var{called-macro-name})
-@findex BEFORE
+@maindex BEFORE
Make @code{m4} print a warning message on the standard error output if
@var{called-macro-name} has already been called. @var{this-macro-name}
should be the name of the macro that is calling @code{AC_BEFORE}. The
@end defmac
@defmac AC_PROVIDE (@var{macro-name})
-@findex PROVIDE
+@maindex PROVIDE
Set a flag recording that @var{macro-name} has been called. The
argument should be the name of the macro that is calling
@code{AC_PROVIDE}. An easy way to get it is from the @code{m4} builtin
@end defmac
@defmac AC_REQUIRE (@var{macro-name})
-@findex REQUIRE
+@maindex REQUIRE
If the @code{m4} macro @var{macro-name} has not already been called,
call it (without any arguments). Make sure to quote @var{macro-name}
with square brackets. The body of @var{macro-name} must contain a call
Macros that are called by other macros are evaluated by @code{m4}
several times; each evaluation might require another layer of quotes to
prevent unwanted expansions of macros or @code{m4} builtins, such as
-@samp{include} and @samp{$1}. Quotes are also required around macro
+@samp{define} and @samp{$1}. Quotes are also required around macro
arguments that contain commas, since commas separate the arguments from
each other.
The @code{make} variables that you might want to override with
environment variables when running @code{configure} are:
-(For these variables, any value given in the environment overrides the
-value that @code{configure} would choose:)
+For these variables, any value given in the environment overrides the
+value that @code{configure} would choose:
@defvar CC
C compiler program. The default is @code{cc}, or @code{gcc} if
have it, @code{cp} otherwise.
@end defvar
-(For these variables, any value given in the environment is added to
-the value that @code{configure} chooses:)
+For these variables, any value given in the environment is added to
+the value that @code{configure} chooses:
@defvar DEFS
Configuration options, in the form @samp{-Dfoo -Dbar@dots{}}. Do not
This is an alphabetical list of the Autoconf macros. To make the list
easier to use, the macros are listed without their preceding @samp{AC_}.
-@printindex fn
+@printindex ma
@contents
@bye
by the Foundation.
@end titlepage
+@c Define a macro index that @@defmacro doesn't write to.
+@defcodeindex ma
+
@node Top, Introduction, , (dir)
@comment node-name, next, previous, up
programs:
@defmac AC_DECLARE_YYTEXT
-@findex DECLARE_YYTEXT
+@maindex DECLARE_YYTEXT
@vindex DECLARE_YYTEXT
Define @code{DECLARE_YYTEXT} to declare @code{yytext} appropriately,
depending on whether @code{lex} or @code{flex} is being used. This
@end defmac
@defmac AC_LN_S
-@findex LN_S
+@maindex LN_S
If @samp{ln -s} works on the current filesystem (the O.S. and filesystem
support symbolic links), set shell and @code{make} variable @code{LN_S}
to @samp{ln -s}, otherwise set it to @samp{ln}.
@end defmac
@defmac AC_MINUS_C_MINUS_O
-@findex MINUS_C_MINUS_O
+@maindex MINUS_C_MINUS_O
@vindex NO_MINUS_C_MINUS_O
If the C compiler does not accept the @samp{-c} and @samp{-o} options
simultaneously, define @code{NO_MINUS_C_MINUS_O}.
@end defmac
@defmac AC_PROG_YACC
-@findex PROG_YACC
+@maindex PROG_YACC
If @code{bison} is found, set @code{make} variable @code{YACC} to
@samp{bison -y}. Otherwise, if @code{byacc} is found, set @code{YACC}
to @samp{byacc}. Otherwise set @code{YACC} to @samp{yacc}.
@end defmac
@defmac AC_PROG_CPP
-@findex PROG_CPP
+@maindex PROG_CPP
Set shell and @code{make} variable @code{CPP} to a command that runs the
C preprocessor. If @samp{$CC -E} doesn't work, it uses @file{/lib/cpp}.
@end defmac
@defmac AC_PROG_LEX
-@findex PROG_LEX
+@maindex PROG_LEX
If @code{flex} is found, set @code{make} variable @code{LEX} to
@samp{flex} and @code{LEXLIB} to @samp{-lfl}, if that library is in a
standard place. Otherwise set @code{LEX} to @samp{lex} and
@end defmac
@defmac AC_PROG_AWK
-@findex PROG_AWK
+@maindex PROG_AWK
Check for @code{mawk}, @code{gawk}, @code{nawk}, and @code{awk}, in that
order, and set @code{make} variable @code{AWK} to the first one that it
finds.
@end defmac
@defmac AC_PROG_CC
-@findex PROG_CC
+@maindex PROG_CC
If @code{gcc} is found, set @code{make} variable @code{CC} to @samp{gcc},
and set shell variable @code{GCC} to 1 for use by macros such as
@code{AC_GCC_TRADITIONAL}.
@end defmac
@defmac AC_GCC_TRADITIONAL
-@findex GCC_TRADITIONAL
+@maindex GCC_TRADITIONAL
Add @samp{-traditional} to @code{make} variable @code{CC} if using the
GNU C compiler and @code{ioctl} does not work properly without
@samp{-traditional}. This macro calls @code{AC_PROG_CC} and
@end defmac
@defmac AC_PROG_INSTALL
-@findex PROG_INSTALL
+@maindex PROG_INSTALL
Set @code{make} variable @code{INSTALL} to @samp{install -c} if
@code{install} is found, otherwise set it to @samp{cp}. Screens out the
false matches @file{/etc/install}, @file{/usr/sbin/install}, and other
@end defmac
@defmac AC_PROG_RANLIB
-@findex PROG_RANLIB
+@maindex PROG_RANLIB
Set @code{make} variable @code{RANLIB} to @samp{ranlib} if @code{ranlib}
is found, otherwise to @samp{:} (do nothing).
@end defmac
@defmac AC_RSH
-@findex RSH
+@maindex RSH
@vindex NO_REMOTE
@vindex HAVE_NETDB_H
If a remote shell is available, put @samp{rtapelib.o} in @code{make}
The following macros check for the presence of certain C header files:
@defmac AC_DIR_HEADER
-@findex DIR_HEADER
+@maindex DIR_HEADER
@vindex DIRENT
@vindex SYSDIR
@vindex SYSNDIR
@end defmac
@defmac AC_MAJOR_HEADER
-@findex MAJOR_HEADER
+@maindex MAJOR_HEADER
@vindex MAJOR_IN_MKDEV
@vindex MAJOR_IN_SYSMACROS
If @file{sys/types.h} does not define @code{major}, @code{minor}, and
@end defmac
@defmac AC_MEMORY_H
-@findex MEMORY_H
+@maindex MEMORY_H
@vindex NEED_MEMORY_H
Define @code{NEED_MEMORY_H} if @code{memcpy}, @code{memcmp}, etc. are
not declared in @file{string.h} and @file{memory.h} exists. This macro
@end defmac
@defmac AC_STDC_HEADERS
-@findex STDC_HEADERS
+@maindex STDC_HEADERS
@vindex STDC_HEADERS
Define @code{STDC_HEADERS} if the system has ANSI C header files.
Specifically, this macro checks for @file{stdlib.h}, @file{stdarg.h},
@end defmac
@defmac AC_UNISTD_H
-@findex UNISTD_H
+@maindex UNISTD_H
@vindex HAVE_UNISTD_H
Define @code{HAVE_UNISTD_H} if the system has @file{unistd.h}. The way
to check if the system supports POSIX.1 is:
@end defmac
@defmac AC_USG
-@findex USG
+@maindex USG
@vindex USG
Define @code{USG} if the system does not have @file{strings.h},
@code{rindex}, @code{bzero}, etc. This implies that it has
The following macros check for predefined C types:
@defmac AC_GETGROUPS_T
-@findex GETGROUPS_T
+@maindex GETGROUPS_T
@vindex GETGROUPS_T
Define @code{GETGROUPS_T} to be whichever of @code{gid_t} or @code{int}
is the base type of the array argument to @code{getgroups}.
@end defmac
@defmac AC_MODE_T
-@findex MODE_T
+@maindex MODE_T
@vindex mode_t
If @code{mode_t} is not defined in @file{sys/types.h}, define
@code{mode_t} to be @code{int}.
@end defmac
@defmac AC_OFF_T
-@findex OFF_T
+@maindex OFF_T
@vindex off_t
If @code{off_t} is not defined in @file{sys/types.h}, define
@code{off_t} to be @code{long}.
@end defmac
@defmac AC_PID_T
-@findex PID_T
+@maindex PID_T
@vindex pid_t
If @code{pid_t} is not defined in @file{sys/types.h}, define
@code{pid_t} to be @code{int}.
@end defmac
@defmac AC_RETSIGTYPE
-@findex RETSIGTYPE
+@maindex RETSIGTYPE
@vindex RETSIGTYPE
If @file{signal.h} declares @code{signal} as returning a pointer to a
function returning @code{void}, define @code{RETSIGTYPE} to be
@end defmac
@defmac AC_SIZE_T
-@findex SIZE_T
+@maindex SIZE_T
@vindex size_t
If @code{size_t} is not defined in @file{sys/types.h}, define
@code{size_t} to be @code{unsigned}.
@end defmac
@defmac AC_UID_T
-@findex UID_T
+@maindex UID_T
@vindex uid_t
@vindex gid_t
If @code{uid_t} is not defined in @file{sys/types.h}, define
The following macros check for particular C library functions:
@defmac AC_ALLOCA
-@findex ALLOCA
+@maindex ALLOCA
@vindex HAVE_ALLOCA_H
Check how to get @code{alloca}. Tries to get a builtin version by
checking for @file{alloca.h} or the predefined C preprocessor macros
@end defmac
@defmac AC_GETLOADAVG
-@findex GETLOADAVG
+@maindex GETLOADAVG
+@vindex SVR4
+@vindex DGUX
+@vindex UMAX
+@vindex UMAX4_3
@vindex NLIST_STRUCT
@vindex NLIST_NAME_UNION
@vindex GETLODAVG_PRIVILEGED
@end defmac
@defmac AC_SETVBUF_REVERSED
-@findex SETVBUF_REVERSED
+@maindex SETVBUF_REVERSED
@vindex SETVBUF_REVERSED
If @code{setvbuf} takes the buffering type as its second argument and
the buffer pointer as the third, instead of the other way around, define
@end defmac
@defmac AC_STRCOLL
-@findex STRCOLL
+@maindex STRCOLL
@vindex HAVE_STRCOLL
Check for a proper declaration of the @code{strcoll} function. This
does a bit more than @samp{AC_HAVE_FUNCS(strcoll)}, because some systems
@end defmac
@defmac AC_UTIME_NULL
-@findex UTIME_NULL
+@maindex UTIME_NULL
@vindex HAVE_UTIME_NULL
If @samp{utime(@var{file}, NULL)} sets @var{file}'s timestamp to
the present, define @code{HAVE_UTIME_NULL}.
@end defmac
@defmac AC_VFORK
-@findex VFORK
+@maindex VFORK
@vindex HAVE_VFORK_H
@vindex vfork
If @file{vfork.h} is found, define @code{HAVE_VFORK_H}. If a working
@end defmac
@defmac AC_VPRINTF
-@findex VPRINTF
+@maindex VPRINTF
@vindex HAVE_VPRINTF
@vindex HAVE_DOPRNT
If @code{vprintf} is found, define @code{HAVE_VPRINTF}. Otherwise, if
@end defmac
@defmac AC_WAIT3
-@findex WAIT3
+@maindex WAIT3
@vindex HAVE_WAIT3
If @code{wait3} is found and fills in the contents of its third argument
(a @samp{struct rusage *}), which HP-UX does not do, define
The following macros check for certain structures or structure members:
@defmac AC_STAT_MACROS_BROKEN
-@findex STAT_MACROS_BROKEN
-@findex STAT_MACROS_BROKEN
+@maindex STAT_MACROS_BROKEN
+@maindex STAT_MACROS_BROKEN
If the macros @code{S_ISDIR}, @code{S_ISREG} et al. defined
@file{sys/stat.h} do not work properly (returning false positives),
define @code{STAT_MACROS_BROKEN}. This is the case on Tektronix UTekV,
@end defmac
@defmac AC_ST_BLKSIZE
-@findex ST_BLKSIZE
+@maindex ST_BLKSIZE
@vindex HAVE_ST_BLKSIZE
If @code{struct stat} contains an @code{st_blksize} member, define
@code{HAVE_ST_BLKSIZE}.
@end defmac
@defmac AC_ST_BLOCKS
-@findex ST_BLOCKS
+@maindex ST_BLOCKS
@vindex HAVE_ST_BLOCKS
If @code{struct stat} contains an @code{st_blocks} member, define
@code{HAVE_ST_BLOCKS}. Otherwise, add @samp{fileblocks.o} to the
@end defmac
@defmac AC_ST_RDEV
-@findex ST_RDEV
+@maindex ST_RDEV
@vindex HAVE_ST_RDEV
If @code{struct stat} contains an @code{st_rdev} member, define
@code{HAVE_ST_RDEV}.
@end defmac
@defmac AC_TIME_WITH_SYS_TIME
-@findex TIME_WITH_SYS_TIME
+@maindex TIME_WITH_SYS_TIME
@vindex TIME_WITH_SYS_TIME
If a program may include both @file{time.h} and @file{sys/time.h},
define @code{TIME_WITH_SYS_TIME}. On some older systems,
@end defmac
@defmac AC_STRUCT_TM
-@findex STRUCT_TM
+@maindex STRUCT_TM
@vindex TM_IN_SYS_TIME
If @file{time.h} does not define @code{struct tm}, define
@code{TM_IN_SYS_TIME}, which means that including @file{sys/time.h}
@end defmac
@defmac AC_TIMEZONE
-@findex TIMEZONE
+@maindex TIMEZONE
@vindex HAVE_TM_ZONE
@vindex HAVE_TZNAME
Figure out how to get the current timezone. If @code{struct tm} has a
features:
@defmac AC_ARG_ARRAY
-@findex ARG_ARRAY
+@maindex ARG_ARRAY
@vindex NO_ARG_ARRAY
If the address of an argument to a C function can not be used like
the start of an array, define @code{NO_ARG_ARRAY}. This ability allows
@end defmac
@defmac AC_CROSS_CHECK
-@findex CROSS_CHECK
+@maindex CROSS_CHECK
If the C compiler being used does not produce executables that can run
on the system where @code{configure} is being run, set the shell
variable @code{cross_compiling} to 1. This information can be used by
@end defmac
@defmac AC_CHAR_UNSIGNED
-@findex CHAR_UNSIGNED
+@maindex CHAR_UNSIGNED
@vindex __CHAR_UNSIGNED__
If the C type @code{char} is unsigned, define @code{__CHAR_UNSIGNED__},
unless the C compiler predefines it.
@end defmac
@defmac AC_CONST
-@findex CONST
+@maindex CONST
@vindex const
If the C compiler does not fully support the keyword @code{const},
define @code{const} to be empty. Some C compilers that do not define
@end defmac
@defmac AC_INLINE
-@findex INLINE
+@maindex INLINE
@vindex inline
If the C compiler is a version of GCC that supports the keyword
@code{__inline} but not @code{inline} (such as some NeXT versions),
@end defmac
@defmac AC_INT_16_BITS
-@findex INT_16_BITS
+@maindex INT_16_BITS
@vindex INT_16_BITS
-If the C type @code{int} is smaller than the type @code{long}, define
-@code{INT_16_BITS}.
+If the C type @code{int} is 16 bits wide, define @code{INT_16_BITS}.
@end defmac
@defmac AC_LONG_DOUBLE
-@findex HAVE_LONG_DOUBLE
+@maindex HAVE_LONG_DOUBLE
@vindex HAVE_LONG_DOUBLE
If the C compiler supports the @code{long double} type, define
@code{HAVE_LONG_DOUBLE}. Some C compilers that do not define
@end defmac
@defmac AC_WORDS_BIGENDIAN
-@findex WORDS_BIGENDIAN
+@maindex WORDS_BIGENDIAN
@vindex WORDS_BIGENDIAN
If words are stored with the most significant byte first (like Motorola
and SPARC, but not Intel and VAX, CPUs), define @code{WORDS_BIGENDIAN}.
The following macros check for operating system services:
@defmac AC_FIND_X
-@findex FIND_X
+@maindex FIND_X
Try to locate the X Window System include files and libraries by running
@code{xmkmf} on a trivial @file{Imakefile} and examining the
@file{Makefile} that it produces. If successful, set the shell
@end defmac
@defmac AC_HAVE_POUNDBANG (@var{action-if-supported} @r{[}, @var{action-if-unsupported}@r{]})
-@findex HAVE_POUNDBANG
+@maindex HAVE_POUNDBANG
Print @samp{checking if `#!' works in shell scripts} to the standard
output. Then check whether the system supports starting shell scripts
with a line of the form @samp{#!/bin/csh} to select the shell to run
@end defmac
@defmac AC_LONG_FILE_NAMES
-@findex LONG_FILE_NAMES
+@maindex LONG_FILE_NAMES
@vindex HAVE_LONG_FILE_NAMES
If the system supports file names longer than 14 characters, define
@code{HAVE_LONG_FILE_NAMES}.
@end defmac
@defmac AC_REMOTE_TAPE
-@findex REMOTE_TAPE
+@maindex REMOTE_TAPE
@vindex HAVE_SYS_MTIO_H
If BSD tape drive ioctls are available, define @code{HAVE_SYS_MTIO_H},
and if sockets are available add @code{rmt} to @code{make} variable
@end defmac
@defmac AC_RESTARTABLE_SYSCALLS
-@findex RESTARTABLE_SYSCALLS
+@maindex RESTARTABLE_SYSCALLS
@vindex HAVE_RESTARTABLE_SYSCALLS
If the system automatically restarts a system call that is interrupted
by a signal, define @code{HAVE_RESTARTABLE_SYSCALLS}.
their header files or libraries:
@defmac AC_AIX
-@findex AIX
+@maindex AIX
@vindex _ALL_SOURCE
If on AIX, define @code{_ALL_SOURCE}. Allows the use of some BSD
functions. Should be called before any macros that run the C compiler.
@end defmac
@defmac AC_DYNIX_SEQ
-@findex DYNIX_SEQ
+@maindex DYNIX_SEQ
If on DYNIX/ptx (Sequent UNIX), add @samp{-lseq} to @code{make}
variable @code{LIBS}. Allows use of some BSD system calls and
@code{getmntent}.
@end defmac
@defmac AC_IRIX_SUN
-@findex IRIX_SUN
+@maindex IRIX_SUN
If on IRIX (Silicon Graphics UNIX), add @samp{-lsun} to @code{make}
variable @code{LIBS}. Needed to get @code{getmntent}. At sites using
Yellow Pages/NIS, it is also needed to get properly working
@end defmac
@defmac AC_ISC_POSIX
-@findex ISC_POSIX
+@maindex ISC_POSIX
@vindex _POSIX_SOURCE
If on a POSIXized ISC UNIX, define @code{_POSIX_SOURCE} and add
@samp{-posix} (for the GNU C compiler) or @samp{-Xp} (for other C
@end defmac
@defmac AC_MINIX
-@findex MINIX
+@maindex MINIX
@vindex _MINIX
@vindex _POSIX_SOURCE
@vindex _POSIX_1_SOURCE
@end defmac
@defmac AC_SCO_INTL
-@findex SCO_INTL
+@maindex SCO_INTL
If on SCO UNIX, add @samp{-lintl} to @code{make} variable @code{LIBS}.
Used to get @code{strftime}. It must be called before checking for
@code{strftime}.
@end defmac
@defmac AC_XENIX_DIR
-@findex XENIX_DIR
+@maindex XENIX_DIR
@vindex VOID_CLOSEDIR
If on Xenix, define @code{VOID_CLOSEDIR} and add @samp{-lx} to
@code{make} variable @code{LIBS}. Also, if @file{sys/ndir.h} is not
The following macros control the kind of output that Autoconf produces.
@defmac AC_CONFIG_HEADER (@var{header-to-create})
-@findex CONFIG_HEADER
+@maindex CONFIG_HEADER
@vindex HAVE_CONFIG_H
Make @code{AC_OUTPUT} create a file @var{header-to-create} containing C
preprocessor @code{#define} statements and replace @samp{@@DEFS@@} in
@end defmac
@defmac AC_INIT (@var{unique-file-in-source-dir})
-@findex INIT
+@maindex INIT
Process the command-line arguments and find the source code directory.
@var{unique-file-in-source-dir} is some file that is in the package's
source directory; @code{configure} checks for this file's existence to
@end defmac
@defmac AC_PREPARE (@var{unique-file-in-source-dir})
-@findex PREPARE
+@maindex PREPARE
Find the source code directory and set up shell variables necessary for
other Autoconf macros to work. @var{unique-file-in-source-dir} is some
file that is in the package's source directory; @code{configure} checks
@end defmac
@defmac AC_OUTPUT (@r{[}@var{file}@dots{}@r{]})
-@findex OUTPUT
+@maindex OUTPUT
Create output files (typically one or more @file{Makefile}s) and
@file{config.status}. If @code{AC_CONFIG_HEADER} has been called, also
create the header file that was named as its argument. The argument is
@end defmac
@defmac AC_REVISION (@var{revision-info})
-@findex REVISION
+@maindex REVISION
Copy revision stamp @var{revision-info} into the @file{configure}
script, with any dollar signs or double-quotes removed. This macro lets
you put a revision stamp from @file{configure.in} into @file{configure}
macros.
@defmac AC_COMPILE_CHECK (@var{echo-text}, @var{includes}, @var{function-body}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex COMPILE_CHECK
+@maindex COMPILE_CHECK
Print @samp{checking for @var{echo-text}} to the standard output. Then
create a test C program to see whether a function whose body consists of
@var{function-body} can be compiled and linked; @var{includes} is any
@end defmac
@defmac AC_FUNC_CHECK (@var{function}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex FUNC_CHECK
+@maindex FUNC_CHECK
If @var{function} is available, run shell commands
@var{action-if-found}, otherwise @var{action-if-not-found}. If the
functions might be in libraries other than the default C library, first
@end defmac
@defmac AC_HAVE_FUNCS (@var{function}@dots{})
-@findex HAVE_FUNCS
+@maindex HAVE_FUNCS
@vindex HAVE_@var{function}
For each given @var{function} in the whitespace-separated argument list
that is available, define @code{HAVE_@var{function}} (in all caps).
@end defmac
@defmac AC_HAVE_HEADERS (@var{header-file}@dots{})
-@findex HAVE_HEADERS
+@maindex HAVE_HEADERS
@vindex HAVE_@var{header}
For each given @var{header-file} in the whitespace-separated argument
list that exists, define @code{HAVE_@var{header-file}} (in all caps).
@end defmac
@defmac AC_HAVE_LIBRARY (@var{library} @r{[}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]]})
-@findex HAVE_LIBRARY
+@maindex HAVE_LIBRARY
Print @samp{checking for @var{library}} to the standard output. Then
create a test C program to see whether that program can be linked with
the specified library. @var{action-if-found} is a list of shell
@end defmac
@defmac AC_HEADER_CHECK (@var{header-file}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex HEADER_CHECK
+@maindex HEADER_CHECK
If @var{header-file} exists, execute shell commands
@var{action-if-found}, otherwise execute @var{action-if-not-found}. If
you just want to define a symbol if the header file is available,
@end defmac
@defmac AC_HEADER_EGREP (@var{pattern}, @var{header-file}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex HEADER_EGREP
+@maindex HEADER_EGREP
If the output of running the C preprocessor on @var{header-file}
contains the @code{egrep} regular expression @var{pattern}, execute
shell commands @var{action-if-found}, otherwise execute
@end defmac
@defmac AC_PREFIX (@var{program})
-@findex PREFIX
+@maindex PREFIX
If the user did not specify an installation prefix on the command line,
guess a value for it by looking for @var{program} in @code{PATH}, the
way the shell does. If @var{program} is found, set the prefix to the
@end defmac
@defmac AC_PROGRAM_CHECK (@var{variable}, @var{prog-to-check-for}, @var{value-if-found}, @var{value-if-not-found})
-@findex PROGRAM_CHECK
+@maindex PROGRAM_CHECK
Check whether program @var{prog-to-check-for} exists in @code{PATH}. If
it is found, set @var{variable} to @var{value-if-found}, otherwise to
@var{value-if-not-found}. Calls @code{AC_SUBST} for @var{variable}.
@end defmac
@defmac AC_PROGRAM_EGREP (@var{pattern}, @var{program}, @var{action-if-found} @r{[}, @var{action-if-not-found}@r{]})
-@findex PROGRAM_EGREP
+@maindex PROGRAM_EGREP
@var{program} is the text of a C program, on which shell variable and
backquote substitutions are performed. If the output of running the C
preprocessor on @var{program} contains the @code{egrep} regular
expression @var{pattern}, execute shell commands @var{action-if-found},
otherwise execute @var{action-if-not-found}. (It is an unfortunate
-oversight that we use the word ``PROGRAM'' in Autoconf macro names to
+oversight that we use the word @code{PROGRAM} in Autoconf macro names to
sometimes mean C source code and sometimes mean a UNIX command.)
@end defmac
@defmac AC_PROGRAMS_CHECK (@var{variable}, @var{progs-to-check-for} @r{[}, @var{value-if-not-found}@r{]})
-@findex PROGRAMS_CHECK
+@maindex PROGRAMS_CHECK
Check for each program in the whitespace-separated list
@var{progs-to-check-for} exists in @code{PATH}. If it is found, set
@var{variable} to the name of that program. Otherwise, continue
@end defmac
@defmac AC_REPLACE_FUNCS (@var{function-name}@dots{})
-@findex REPLACE_FUNCS
+@maindex REPLACE_FUNCS
For each given @var{function-name} in the whitespace-separated argument
list that is not in the C library, add @samp{@var{function-name}.o} to
the value of the @code{make} variable @code{LIBOBJS}. If the functions
@end defmac
@defmac AC_TEST_PROGRAM (@var{program}, @var{action-if-true} @r{[}, @var{action-if-false} @r{[}, @var{action-if-cross-compiling}@r{]]})
-@findex TEST_PROGRAM
+@maindex TEST_PROGRAM
@var{program} is the text of a C program, on which shell variable and
backquote substitutions are performed. If it compiles and links
successfully and returns an exit status of 0 when executed, run shell
@end defmac
@defmac AC_TEST_CPP (@var{includes}, @var{action-if-true} @r{[}, @var{action-if-false}@r{]})
-@findex TEST_CPP
+@maindex TEST_CPP
@var{includes} is C @code{#include} statements and declarations, on
which shell variable and backquote substitutions are performed.
(Actually, it can be any C program, but other statements are probably
@end defmac
@defmac AC_WITH (@var{feature}, @var{action-if-true} @r{[}, @var{action-if-false}@r{]})
-@findex WITH
+@maindex WITH
If the user gave @code{configure} the option
@samp{--with-@var{feature}}, run shell commands @var{action-if-true}.
Otherwise run shell commands @var{action-if-false}. The name
variables.
@defmac AC_DEFINE (@var{variable} @r{[}, @var{value}@r{]})
-@findex DEFINE
+@maindex DEFINE
Define C preprocessor variable @var{variable}. If @var{value} is given,
set @var{variable} to that value, otherwise set it to 1. To use a shell
variable as the value, use @code{AC_DEFINE_UNQUOTED} instead. Precede
@end defmac
@defmac AC_DEFINE_UNQUOTED (@var{variable} @r{[}, @var{value}@r{]})
-@findex DEFINE_UNQUOTED
+@maindex DEFINE_UNQUOTED
Like @code{AC_DEFINE}, but it does nothing to quote @var{value} from
various shell and @code{sed} expansions it will undergo. @var{value}
will be used in many different contexts requiring different quoting, and
@end defmac
@defmac AC_SUBST (@var{variable})
-@findex SUBST
+@maindex SUBST
Substitute the variable @var{variable} when creating the output files
(typically one or more @file{Makefile}s). This means replace instances
of @samp{@@@var{variable}@@}, e.g. in @file{Makefile.in}, with the
called in the correct order.
@defmac AC_BEFORE (@var{this-macro-name}, @var{called-macro-name})
-@findex BEFORE
+@maindex BEFORE
Make @code{m4} print a warning message on the standard error output if
@var{called-macro-name} has already been called. @var{this-macro-name}
should be the name of the macro that is calling @code{AC_BEFORE}. The
@end defmac
@defmac AC_PROVIDE (@var{macro-name})
-@findex PROVIDE
+@maindex PROVIDE
Set a flag recording that @var{macro-name} has been called. The
argument should be the name of the macro that is calling
@code{AC_PROVIDE}. An easy way to get it is from the @code{m4} builtin
@end defmac
@defmac AC_REQUIRE (@var{macro-name})
-@findex REQUIRE
+@maindex REQUIRE
If the @code{m4} macro @var{macro-name} has not already been called,
call it (without any arguments). Make sure to quote @var{macro-name}
with square brackets. The body of @var{macro-name} must contain a call
Macros that are called by other macros are evaluated by @code{m4}
several times; each evaluation might require another layer of quotes to
prevent unwanted expansions of macros or @code{m4} builtins, such as
-@samp{include} and @samp{$1}. Quotes are also required around macro
+@samp{define} and @samp{$1}. Quotes are also required around macro
arguments that contain commas, since commas separate the arguments from
each other.
The @code{make} variables that you might want to override with
environment variables when running @code{configure} are:
-(For these variables, any value given in the environment overrides the
-value that @code{configure} would choose:)
+For these variables, any value given in the environment overrides the
+value that @code{configure} would choose:
@defvar CC
C compiler program. The default is @code{cc}, or @code{gcc} if
have it, @code{cp} otherwise.
@end defvar
-(For these variables, any value given in the environment is added to
-the value that @code{configure} chooses:)
+For these variables, any value given in the environment is added to
+the value that @code{configure} chooses:
@defvar DEFS
Configuration options, in the form @samp{-Dfoo -Dbar@dots{}}. Do not
This is an alphabetical list of the Autoconf macros. To make the list
easier to use, the macros are listed without their preceding @samp{AC_}.
-@printindex fn
+@printindex ma
@contents
@bye
projects / thirdparty / autoconf.git / commitdiff
