Autoconf和Automake使用

Autoconf和Automake使用

一、生成Makefile流程图

二、具体实例

执行命令顺序：
autoscan; aclocal; autoconf; autoheader; automake --add-missing; ./configure; make; ./helloworld;

1、建目录

在你的工作目录下建一个helloworld目录，用来存放helloworld程序及相关文件，如在/home/my/build下：

$ mkdir helloword
$ cd helloworld

2、 helloworld.c

编辑文件，完成后保存退出。现在在helloworld目录下就应该有一个你自己写的helloworld.c了。

#include <stdio.h>

int main(int argc, char **argv)
{
    printf("Hello, Linux World! ");
    return 0;
}

3、生成configure

　　$ autoscan
　　$ ls
　　configure.scan helloworld.c 

执行后在hellowrold目录下会生成一个文件：configure.scan，可以拿它作为configure.ac的蓝本。

4、生成configure.ac

现在将configure.scan改名为configure.ac，并且编辑它，按下面的内容修改，去掉无关的语句：

#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.69])
#AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS])
AC_INIT(HelloWorld, 1.0, jiangtengfei007@163.com)
AM_INIT_AUTOMAKE(HelloWorld, 1.0)  #这句话很重要，否则下面aclocal出错
AC_CONFIG_SRCDIR([HelloWorld.c])
AC_CONFIG_HEADERS([config.h])

# Checks for programs.
AC_PROG_CC

# Checks for libraries.

# Checks for header files.

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_CONFIG_FILES([Makefile])
AC_OUTPUT

5、执行aclocal和autoconf

然后执行命令aclocal和autoconf，分别会产生aclocal.m4及configure两个文件：

$ aclocal
$ls
aclocal.m4 configure.ac helloworld.c
$ autoconf
$ ls
aclocal.m4 autom4te.cache configure configure.ac helloworld.c 

可以看到configure.ac内容是一些宏定义，这些宏经autoconf处理后会变成检查系统特性、环境变量、软件必须的参数的shell脚本。

autoconf 是用来生成自动配置软件源代码脚本（configure）的工具。configure脚本能独立于autoconf运行，且在运行的过程中，不需要用户的干预。

要生成configure文件，你必须告诉autoconf如何找到你所用的宏。方式是使用aclocal程序来生成你的aclocal.m4。

aclocal根据configure.ac文件的内容，自动生成aclocal.m4文件。aclocal是一个perl 脚本程序，它的定义是：“aclocal - create aclocal.m4 by scanning configure.ac”。

autoconf从configure.ac这个列举编译软件时所需要各种参数的模板文件中创建configure。

autoconf需要GNU m4宏处理器来处理aclocal.m4，生成configure脚本。

m4是一个宏处理器。将输入拷贝到输出，同时将宏展开。宏可以是内嵌的，也可以是用户定义的。除了可以展开宏，m4还有一些内建的函数，用来引用文件，执行命令，整数运算，文本操作，循环等。m4既可以作为编译器的前端，也可以单独作为一个宏处理器.

6、执行autoheader

在执行automake --add-missing之前执行autoheade, 生成config.h.in

7、新建Makefile.am

AUTOMAKE_OPTIONS=foreign

bin_PROGRAMS=helloworld

helloworld_SOURCES=helloworld.c 

automake会根据你写的Makefile.am来自动生成Makefile.in。Makefile.am中定义的宏和目标,会指导automake生成指定的代码。例如，宏bin_PROGRAMS将导致编译和连接的目标被生成。

8、运行automak

➜  AutoConf_ automake --add-missing
configure.ac:7: warning: AM_INIT_AUTOMAKE: two- and three-arguments forms are deprecated.  For more info, see:
configure.ac:7: http://www.gnu.org/software/automake/manual/automake.html#Modernize-AM_005fINIT_005fAUTOMAKE-invocation
configure.ac:12: installing './compile'
configure.ac:7: installing './install-sh'
configure.ac:7: installing './missing'
Makefile.am: installing './depcomp'

automake会根据Makefile.am文件产生一些文件，包含最重要的Makefile.in。

9、执行configure生成Makefile

➜  ./configure
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... ./install-sh -c -d
checking for gawk... no
checking for mawk... no
checking for nawk... no
checking for awk... awk
checking whether make sets $(MAKE)... yes
checking whether make supports nested variables... yes
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
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 whether gcc understands -c and -o together... yes
checking for style of include used by make... GNU
checking dependency style of gcc... gcc3
checking that generated files are newer than configure... done
configure: creating ./config.status
config.status: creating Makefile
config.status: creating config.h
config.status: executing depfiles commands
➜  ls -l Makefile
-rw-rw-r-- 1 yutao yutao 15035 Oct 15 10:40 Makefile 

你可以看到，此时Makefile已经产生出来了。

10、使用Makefile编译代码

➜  make
/Applications/Xcode.app/Contents/Developer/usr/bin/make  all-am
gcc -DHAVE_CONFIG_H -I.     -g -O2 -MT helloworld.o -MD -MP -MF .deps/helloworld.Tpo -c -o helloworld.o helloworld.c
mv -f .deps/helloworld.Tpo .deps/helloworld.Po
gcc  -g -O2   -o helloworld helloworld.o

11、运行helloworld

➜  ./helloworld
Hello World!!!!

这样helloworld就编译出来了，你如果按上面的步骤来做的话，应该也会很容易地编译出正确的helloworld文件。你还可以试着使用一些其他的make命令，如make clean，make install，make dist，看看它们会给你什么样的效果。感觉如何？自己也能写出这么专业的Makefile，老板一定会对你刮目相看。

三、命令详解

1、 autoscan

autoscan是用来扫描源代码目录生成configure.scan文件的。autoscan可以用目录名做为参数，但如果你不使用参数的话，那么autoscan将认为使用的是当前目录。autoscan将扫描你所指定目录中的源文件，并创建configure.scan文件。

2、 configure.scan

configure.scan包含了系统配置的基本选项，里面都是一些宏定义。我们需要将它改名为configure.ac[

](http://configure.in/)

3、 aclocal

aclocal是一个perl 脚本程序。aclocal根据configure.ac文件的内容，自动生成aclocal.m4文件。aclocal的定义是：“aclocal - create aclocal.m4 by scanning configure.ac”。

4、 autoconf

使用autoconf，根据configure.in和aclocal.m4来产生configure文件。configure是一个脚本，它能设置源程序来适应各种不同的操作系统平台，并且根据不同的系统来产生合适的Makefile，从而可以使你的源代码能在不同的操作系统平台上被编译出来。

configure.ac文件的内容是一些宏，这些宏经过autoconf 处理后会变成检查系统特性、环境变量、软件必须的参数的shell脚本。configure.ac文件中的宏的顺序并没有规定，但是你必须在所有宏的最前面和最后面分别加上AC_INIT宏和AC_OUTPUT宏。

在configure.ini中：

　　#号表示注释，这个宏后面的内容将被忽略。

　　AC_INIT(FILE)　//这个宏用来检查源代码所在的路径。
　　AM_INIT_AUTOMAKE(PACKAGE, VERSION)　//这个宏是必须的，它描述了我们将要生成的软件包的名字及其版本号：PACKAGE是软件包的名字，VERSION是版本号。当你使用make dist命令时，它会给你生成一个类似helloworld-1.0.tar.gz的软件发行包，其中就有对应的软件包的名字和版本号。
　　AC_PROG_CC　　//这个宏将检查系统所用的C编译器。
　　AC_OUTPUT(FILE)　　//这个宏是我们要输出的Makefile的名字。

我们在使用automake时，实际上还需要用到其他的一些宏，但我们可以用aclocal 来帮我们自动产生。执行aclocal后我们会得到aclocal.m4文件。 　　产生了configure.ac和aclocal.m4 两个宏文件后，我们就可以使用autoconf来产生configure文件了。

5、 Makefile.am

Makefile.am是用来生成Makefile.in的，需要你手工书写。Makefile.am中定义了一些内容：

　　AUTOMAKE_OPTIONS　　//在执行automake时，它会检查目录下是否存在标准GNU软件包中应具备的各种文件，例如AUTHORS、ChangeLog、NEWS等文件。我们将其设置成foreign时，automake会改用一般软件包的标准来检查。
　　bin_PROGRAMS　　//这个是指定我们所要产生的可执行文件的文件名。如果你要产生多个可执行文件，那么在各个名字间用空格隔开。
　　helloworld_SOURCES　　//这个是指定产生“helloworld”时所需要的源代码。如果它用到了多个源文件，那么请使用空格符号将它们隔开。比如需要helloworld.h，helloworld.c那么请写成helloworld_SOURCES= helloworld.h helloworld.c。

如果你在bin_PROGRAMS定义了多个可执行文件，则对应每个可执行文件都要定义相对的filename_SOURCES。

6、 automake

使用automake，根据configure.in和Makefile.am来产生Makefile.in。

　　--add-missing  //定义是“add missing standard files to package”，它会让automake加入一个标准的软件包所必须的一些文件。

用automake产生出来的Makefile.in文件是符合GNU Makefile惯例的，接下来我们只要执行configure这个shell 脚本就可以产生合适的 Makefile 文件了。

7、 Makefile

在符合GNU Makefiel惯例的Makefile中，包含了一些基本的预先定义的操作：

make　　      		//根据Makefile编译源代码，连接，生成目标文件，可执行文件。
make clean　　		//清除上次的make命令所产生的object文件（后缀为“.o”的文件）及可执行文件。
make install 		 //将编译成功的可执行文件安装到系统目录中，一般为/usr/local/bin目录。
make list　　 		//产生发布软件包文件（即distribution package）。这个命令会将可执行文件及相关文件打包成一个tar.gz压缩的文件用来作为发布软件的软件包。它会在当前目录下生成一个名字类似“PACKAGE-VERSION.tar.gz”的文件。PACKAGE和VERSION，是我们在configure.ac中定义的AM_INIT_AUTOMAKE(PACKAGE, VERSION)。
make distcheck　　	//生成发布软件包并对其进行测试检查，以确定发布包的正确性。这个操作将自动把压缩包文件解开，然后执行configure命令，并且执行make，来确认编译不出现错误，最后提示你软件包已经准备好，可以发布了。
make distclean　　	//类似make clean，但同时也将configure生成的文件全部删除掉，包括Makefile。

通过automake生成的makefile里面的内容跟自己手写的makefile有什么区别？

确实，通过 automake 生成的 Makefile 通常比手写的 Makefile 要复杂得多。这种复杂性主要来自于 automake 旨在提供一种通用、可移植、灵活且功能丰富的方法来自动化 Makefile 的创建。以下是两者之间的一些主要区别：

通过 Automake 生成的 Makefile

1. 自动化和通用性：

   • automake 生成的 Makefile 包含了许多标准的编译和安装规则，这些规则在各种不同的系统和环境中都能可靠地工作。

2. 可移植性：

   • 这些 Makefile 通常考虑了跨平台兼容性，包括对不同操作系统和不同版本的 make 工具的支持。

3. 复杂性：

   • 生成的 Makefile 包含了大量的预定义规则、宏定义和条件语句，以处理各种可能的编译和安装情况。

4. 依赖管理：

   • automake 通常与 autoconf 结合使用，为复杂的项目生成详细的依赖关系和配置检查。

手写的 Makefile

1. 简洁性：

   • 手写的 Makefile 通常更简洁，只包含项目特定的规则和定义。

2. 易于理解和维护：

   • 对于小型或中等复杂度的项目，手写的 Makefile 通常更容易理解和维护。

3. 定制性：

   • 它们提供了更高的定制性，可以根据特定项目的需要编写规则。

4. 有限的可移植性：

   • 除非开发者特意考虑，否则手写的 Makefile 可能不会像 automake 生成的那样具有广泛的可移植性。

总结

• automake 生成的 Makefile 在处理大型项目、需要跨平台兼容性和自动化依赖管理方面更加出色。
• 手写的 Makefile 在小到中型项目中更为常见，它们易于编写和理解，但可能缺乏 automake 提供的复杂功能和广泛的可移植性。

选择使用哪一种方法取决于项目的具体需求、规模以及开发团队对自动化工具的熟悉程度。对于复杂的、跨多个平台的大型项目，使用 automake 和 autoconf 可能是更合适的选择。对于更小、更特定的项目，手写 Makefile 可能更为简单和直接。

如果一个开源项目里面只有makefile.am文件，没有makefile文件怎么办？

如果您在编译openlldp项目时发现只有Makefile.am文件而没有Makefile文件，这通常意味着该项目使用了GNU Autotools作为其构建系统。在这种情况下，您需要通过以下步骤生成Makefile：

1. 安装Autoconf和Automake：

   • 确保您已经安装了Autoconf和Automake。这些是GNU Autotools的一部分，用于生成配置脚本和Makefile。您可以通过包管理器（如apt、yum等）来安装它们。

2. 运行autoreconf：

   • 在项目根目录中，运行autoreconf -i。这个命令会调用autoconf和automake，为您的系统生成配置脚本（configure脚本）和Makefile.in。

3. 运行configure脚本：

   • 接下来，运行生成的configure脚本来配置项目。这将检查您的系统环境并生成适合您系统的Makefile。您可能需要指定某些选项或环境变量来满足项目依赖。

4. 编译项目：

   • 一旦Makefile生成，您就可以使用make命令来编译项目了。

5. 安装软件：

   • 使用make install命令来安装编译好的软件。这通常需要管理员权限，因此您可能需要在命令前加上sudo，例如：sudo make install。

在您的情况下，看起来您遇到了一个与libconfig包相关的问题。如果您的系统中没有安装libconfig，或者其版本低于所需的1.3.2版本，您需要先安装或升级这个库。您可以通过包管理器来安装它，例如：

sudo apt-get install libconfig-dev  # 对于Debian/Ubuntu系统
sudo yum install libconfig-devel    # 对于RedHat/CentOS系统

安装libconfig后，重新运行configure脚本。如果libconfig安装在一个非标准的位置，您可能需要设置PKG_CONFIG_PATH环境变量，或者在运行configure脚本时指定LIBCONFIG_CFLAGS和LIBCONFIG_LIBS环境变量。这样做可以帮助configure脚本找到正确的库文件和头文件。