Document $(( )) pitfalls.
[autoconf.git] / README
blob9641812ff5b0b3f8a6378a2de0386e42f0b83195
1 -*- text -*-
3 Autoconf
5 Autoconf is an extensible package of M4 macros that produce shell
6 scripts to automatically configure software source code packages.
7 These scripts can adapt the packages to many kinds of UNIX-like
8 systems without manual user intervention.  Autoconf creates a
9 configuration script for a package from a template file that lists the
10 operating system features that the package can use, in the form of M4
11 macro calls.
13 Producing configuration scripts using Autoconf requires GNU M4 and
14 Perl.  You should install GNU M4 (version 1.4.5 or later is required;
15 1.4.11 or later is recommended) and Perl (5.005_03 or later) before
16 configuring Autoconf, so that Autoconf's configure script can find
17 them.  The configuration scripts produced by Autoconf are
18 self-contained, so their users do not need to have Autoconf (or GNU
19 M4, Perl, etc.).
21 You can get GNU M4 here:
23 ftp://ftp.gnu.org/gnu/m4/
25 The file INSTALL should be distributed with packages that use
26 Autoconf-generated configure scripts and Makefiles that conform to the
27 GNU coding standards.  The package's README can just give an overview
28 of the package, where to report bugs, and a pointer to INSTALL for
29 instructions on compilation and installation.  This removes the need
30 to maintain many similar sets of installation instructions.
32 Be sure to read BUGS (especially if this version is not an official
33 release) and INSTALL.
35 Mail suggestions to autoconf@gnu.org, report bugs to
36 bug-autoconf@gnu.org, and submit patches to autoconf-patches@gnu.org.
37 All changes can be tracked at the read-only autoconf-commit@gnu.org.
38 Always include the Autoconf version number, which you can get by
39 running `autoconf --version'.  Archives of bug-autoconf@gnu.org can be
40 found in <http://lists.gnu.org/archive/html/bug-autoconf/>, and
41 similarly for the other mailing lists.
43 Licensing
45 Autoconf is released under the General Public License (GPL).
46 Additionally, Autoconf includes a licensing exception in some of its
47 source files; see the respective copyright notices for how your
48 project is impacted by including scripts generated by Autoconf.
50 This version of Autoconf uses GPLv2+ plus the above-mentioned
51 exceptions for its installed executables, as described in COPYING.
52 Meanwhile, several source files within the Autoconf project are under
53 GPLv3+, as described in COPYINGv3; these files are used for building
54 and installing Autoconf, but are not present in the installed
55 programs.  The entire Autoconf project will move to GPLv3+ when the
56 exception statements have been reformulated in terms of the Additional
57 Permissions as described in section 7 of GPLv3.
59 For more licensing information, see
60 <http://www.gnu.org/licenses/gpl-faq.html>.
62 -----
64 Copyright (C) 1992, 1993, 1994, 1998, 2000, 2001, 2002, 2003, 2004,
65 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
67 This program is free software: you can redistribute it and/or modify
68 it under the terms of the GNU General Public License as published by
69 the Free Software Foundation, either version 3 of the License, or
70 (at your option) any later version.
72 This program is distributed in the hope that it will be useful,
73 but WITHOUT ANY WARRANTY; without even the implied warranty of
74 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
75 GNU General Public License for more details.
77 You should have received a copy of the GNU General Public License
78 along with this program.  If not, see <http://www.gnu.org/licenses/>.