autoconf / automake 例子（静态库、动态库 ）

http://blog.csdn.net/exbob/article/details/6998430

http://blog.csdn.net/yah99_wolf/article/details/6172614

 

http://blog.csdn.net/sayigood/article/details/4954772
http://hwood.blog.163.com/blog/static/87581175201142293830160/
http://www.cnblogs.com/phinecos/archive/2008/11/27/1342381.html

 

http://www.gnu.org/software/autoconf/manual/autoconf.html
http://www.sourceware.org/autobook/autobook/autobook_toc.html
http://www.gnu.org/software/libtool/manual/libtool.html

autotool过程图示：

 

automake 所产生的 Makefile 除了可以做到程序的自动编译和链接外，还可以用来生成各种文档（如manual page、info文件），可以将源代码文件包装起来以供发布。所以程序源代码所存放的目录结构最好符合GNU的标准惯例。下面以hello.c程序生成Makefile文件作为例子。

1,在当前目录下创建一个名为hello的子目录。hello这个目录用于存放 hello.c这个程序及相关文件。新建一个源程序文件hello.c

 

#include <stdio.h>

int main(int argc, char** argv)
{
          printf("Welcome to use autoconf and automake\n");
          return 0;
}

 

2,执行autoscan命令生成一个名为configure.scan文件：

autoscan

3,将configure.scan改名为configure.in：

mv configure.scan configure.in

4,打开configure.in，将该文件修改为以下内容：

 

# Process this file with Autoconf to produce a configure script. 
AC_INIT(hello.c) 
AM_INIT_AUTOMAKE(hello, 1.0) 
# 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_OUTPUT(Makefile)

 

5,然后执行以下两个命令，分别生成aclocal.m4和configure文件：

aclocal
autoconf

6,新建四个空白文件，分别命名为NEWS,README,AUTHORS,ChangeLog。

touch NEWS
touch README
touch AUTHORS
touch ChangeLog

7,创建一个名为Makefile.am的文件，并输入以下内容：

AUTOMAKE_OPTIONS= foreign 
bin_PROGRAMS= hello 
hello_SOURCES= hello.c

8,执行命令“automake --add-missing”，automake 会根据Makefile.am 文件产生一些文件，其中包含最重要的Makefile.in

automake --add-missing

9,最后执行“./configure”命令生成Makefile文件

./configure

10,生成Makefile文件后，就可以执行“make”命令来编译hello.c程序，从而生成可执行程序hello。生成可执行程序hello后，执行。

make
./hello
Welcome to use autoconf and automake

归纳一下这个例子的流程。

（1）在存放源代码的目录下执行autoscan命令生成configure.scan文件。

（2）将configure.scan文件改名为configure.in，并对其默认配置进行修改。

（3）执行aclocal、autoconf两个命令，分别生成aclocal.m4、configure文件。

（4）创建一个名为Makefile.am的文件，并输入相应的内容。

（5）执行automake --add-missing，它根据Makefile.am文件，生成Makefile.in。

（6）执行./configure脚本文件，它根据Makefile.in文件，生成最终的Makefile文件。

通过以上步骤，在源代码所在目录下自动生成了Makefile文件。

 configure.in文件

autoconf是用来产生“configure”文件的工具。“configure”是一个Shell脚本，它可以自动设定一些编译参数使程序能够在不同平台上进行编译。autoconf读取configure.in 文件然后产生''configure''这个Shell脚本。

configure.in 文件的内容是一系列GNU m4 的宏，这些宏经autoconf处理后会变成检查系统特性的Shell脚本。configure.in文件中宏的顺序并没有特别的规定，但是每一个configure.in 文件必须以宏AC_INIT开头，以宏AC_OUTPUT结束。一般可先用autoscan这个工具扫描原始文件以产生一个configure.scan 文件，再对configure.scan 作些修改，从而生成 configure.in 文件

configure.in 文件中一些宏的含义如下。

l    #或dnl：#或dnl后面的内容作为注释不会被处理，它们是注释的起始标志。

l    AC_INIT(FILE)：该宏用来说明源代码所在路径，如上例中的AC_INIT(hello.c)，表明源代码在当前目录下，名为hello.c。

l    AM_INIT_AUTOMAKE(PACKAGE,VERSION)：这个是后面运行automake命令所必需的宏，PACKAGE指明要产生软件的名称，VERSION 是其版本号。

l    AC_PROG_CC：检查系统可用的C编译器，若源代码是用C语言编写的就需要这个宏。

l         AC_OUTPUT(FILE)：设置configure命令所要产生的文件。我们最终期望产生Makefile

这个文件，因此一般将其设置为AC_OUTPUT(Makefile)。

在运行automake命令时，还需要一些其他的宏，这些额外的宏由aclocal产生。执行aclocal会产生aclocal.m4文件，如果没有特别的要求，无需修改它。用 aclocal产生的宏将会提示automake如何动作。

另一个重要的文件是Makefile.am。automake根据configure.in中的宏并在perl的帮助下把Makefile.am转成Makefile.in文件。Makefile.am 文件定义所要产生的目标。

 Makefile.am文件

Makefile.am文件中几个预定的选项的含义如下所示。

l    AUTOMAKE_OPTIONS：它用于设置automake的选项。automake 主要是帮助开发 GNU 软件的人员来维护软件，所以在执行automake 时，会检查目录下是否存在标准GNU软件中应具备的文件，例如“NEWS”、“AUTHOR”、“ChangeLog”等文件。设置为foreign 时，automake 会改用一般软件的标准来进行检查。

l    bin_PROGRAMS：定义要产生的可执行程序的文件名。如果要产生多个可执行文件，每个文件名用空白符隔开。

l    hello_SOURCES：定义“hello”这个可执行程序所需要的原始文件。如果“hello”这个程序是由多个原始文件产生的，必须把它所用到的所有原始文件都列出来，并以空白符隔开。假设“hello”还需要“hello.c”、“main.c”、“hello.h”3个文件，则定义hello_SOURCES= hello.c main.c hello.h。如果定义多个可执行文件，则对每个可执行程序都要定义相应的filename_SOURCES，其中filename为要生成的可执行程序的文件名。

编辑好Makefile.am文件后，就可以使用命令automake --add-missing生成Makefile.in。加上--add-missing这个选项是用来提示automake加入包装一个软件所必需的文件，如果不使用该选项，automake可能会报告缺少了某些文件。automake产生出来的 Makefile.in文件是完全符合GNU Makefile规定的，只要执行 configure这个Shell脚本便可以产生合适的Makefile文件了。

 如何使用产生的Makefile文件

执行configure脚本文件所产生的Makefile文件有几个预定的选项可供使用。

l    make all：产生设定的目标，即生成所有的可执行文件。使用make也可以达到此目的。

l    make clean：删除之前编译时生成的可执行文件及目标文件（形如*.o的中间文件）。

l    make distclean：除了删除可执行文件和目标文件以外，把configure所产生的 Makefile文件也清除掉。通常在发布软件前执行该命令。

l    make install：将使用make all或make命令产生的可执行文件以软件的形式安装到系统中。若使用bin_PROGRAMS宏，程序将会被安装到 /usr/local/bin下，否则安装到预定义的目录下。

l    make dist：将程序和相关的文档包装为一个压缩文档以供发布。执行完该命令，在当前目录下会产生一个名为PACKAGE-VERSION.tar.gz的文件。PACKAGE 和 VERSION 这两个参数是来自configure.in文件中的AM_INIT_AUTOMAKE(PACKAGE,
VERSION)。如在上个例子中执行make dist命令，会产生名为“hello-1.0.tar.gz”的文件。

l    make distcheck：与make dist类似，但是加入了检查包装以后的压缩文件是否正常。

作者：洞庭散人

出处：http://phinecos.cnblogs.com/　　　　

 

 

 

使用Automake 创建和使用静态库

1. 目录结构如下：

[c-sharp] view plaincopy

1. example  
2. |——src 目录（存放源代码文件）  
3.         |——hello.c  
4. |——lib 目录（存放用来生成库的文件）  
5.         |——test.c 用来生成静态库libhello.a  
6. |——include 目录（存放程序中使用的头文件）  
7.         |——hello.h  

2. 编写的各个目录下的源文件

[c-sharp] view plaincopy

1. hello.h 文件  
2. extern void print(char *);  
3. test.c 文件  
4. #include<stdio.h>  
5. void print(char *msg)  
6. {  
7. print(“%s/n”, msg);  
8. }  
9. hello.c 文件  
10. #include “hello.h”  
11. int main()  
12. {  
13. print(“Hello static library!”);//这里用到的是静态库中的函数  
14. return 0;  
15. }  

 
3. 编写lib/Makefile.am 文件

[c-sharp] view plaincopy

1. noinst_LIBRARIES=libhello.a  
2. libhello_a_SOURCES=test.c  
3. AUTOMAKE_OPTIONS=foreign  

 
第一行noinst 表示生成的是静态库，不需要make install ，直接制定它的位置和名字就
可以使用。
第二行表示用来生成静态库的源文件。如果要把静态库生成到其他地方，可以在=后面
加上路径（建议用绝对路径，并将所要用到的静态库生成在同一个文件夹下，如lib）。
第三行AUTOMAKE_OPTIONS 是Automake 的选项。Automake 主要是帮助开发 GNU 软
件的人员来维护软件，所以在执行Automake 时，会检查目录下是否存在标准 GNU 软件中
应具备的文件，例如 'NEWS'、'AUTHOR'、 'ChangeLog' 等文件。设置为foreign 时，Automake
会改用一般软件的标准来检查。如果不加这句的话，需要在autoconf之前，先执行touch NEWS
README AUTHORS ChangeLog 来生成'NEWS'、'AUTHOR'、 'ChangeLog' 等文件
4. 编写src/Makefile.am 文件

[c-sharp] view plaincopy

1. AUTOMAKE_OPTIONS=foreign  
2. INCLUDES= -I../include  
3. bin_PROGRAMS=hello  
4. hello_SOURCES=hello.c  
5. hello_LDADD=../lib/libhello.a  

 
第二行指定头文件的位置，-I 是idirafter 的缩写。../include 指定头文件的位置，..是上
一级目录，也就是这里的example 目录。
第三行指定生成可执行文件名hello，在这里可执行文件生成在src 下，建议将可执行文
件生成到一个特定的文件夹下，让它和源代码分开，如/root/test 目录下。写法为：

[c-sharp] view plaincopy

1. bin_PROGRAMS=/root/test/hello，后面的第四、五行也相对应地变为：  
2. _root_test_hello_SOURCES=hello.c  
3. _root_test_hello_LDADD=../lib/libhello.a  

 
第四行指定生成可执行文件hello 的源代码文件，如果hello.c 在其他目录下，需要加上
完整的路径。
第五行指定需要使用静态库的位置。
5. 生成静态库文件lib/libhello.a。
执行autoscan 生成configure.scan 文件，将它重命名为configure.in 并修改其内容。

[c-sharp] view plaincopy

1. #configure.in  
2. # Process this file with autoconf to produce a configure script.  
3. AC_PREREQ(2.59)  
4. AC_INIT(libhello.a,1.1,[])  
5. AM_INIT_AUTOMAKE  
6. # Checks for programs.  
7. AC_PROG_CC  
8. # Checks for libraries.  
9. AC_PROG_RANLIB//需要加入的内容，因为使用了静态库  
10. # Checks for header files.  
11. # Checks for typedefs, structures, and compiler characteristics.  
12. # Checks for library functions.  
13. AC_OUTPUT([Makefile])  
14. AC_INIT(FILE)  

 
该宏用来检查源代码所在路径，autoscan 会自动产生，一般无须修改它。
AM_INIT_AUTOMAKE(PACKAGE,VERSION)
这个是使用 Automake 所必备的宏，PACKAGE 是所要产生软件的名称，VERSION 是版
本编号。也可以把包和版本号等信息放在AC_INIT(FILE) 宏里。
AC_PROG_CC
检查系统可用的C 编译器，若源代码是用C 写的就需要这个宏。
AC_OUTPUT(FILE)
设置 configure 所要产生的文件，若是Makefile ，configure 便会把它检查出来的结果
填充到Makefile.in 文件后产生合适的 Makefile。 后面的FILE 是一个Makefile 的输出列表，
你可以选着将要输出的Makefile 的位置和个数。建议只在src 中输出Makefile。
在lib 目录下依次执行 aclocal 、autoconf、automake --add-missing、./configure、make，
此时在该目录下就可以看到生成的静态库文件libhello.a
6. 在src 目录下，执行autoscan 生成configure.scan 文件，将它重命名为configure.in 并修
改其内容。

[c-sharp] view plaincopy

1. #configure.in  
2. # Process this file with autoconf to produce a configure script.  
3. AC_PREREQ(2.59)  
4. AC_INIT(hello,1.1,[])  
5. AM_INIT_AUTOMAKE  
6. AC_CONFIG_SRCDIR([hello.c])  
7. # Checks for programs.  
8. AC_PROG_CC  
9. # Checks for libraries.  
10. # Checks for header files.  
11. # Checks for typedefs, structures, and compiler characteristics.  
12. # Checks for library functions.  
13. AC_OUTPUT([Makefile])  

 
7. 在src 目录下依次执行 aclocal 、autoconf、automake --add-missing、./configure、make，
生成可执行文件hello
8. 执行make install 进行安装，最后输入hello 来运行程序，查看效果：
Hello static library!
执行成功！
使用gcc 创建和使用静态库
1. 编写mylib.h 文件

[c-sharp] view plaincopy

1. #ifndef _mylib_h_  
2. #define _mylib_h_  
3. void welcome();  
4. void outstring(const char * str);  
5. #endif  

 
2. 编写mylib.c 文件，用来生成静态库。

[c-sharp] view plaincopy

1. #include <stdio.h>  
2. void welcome()  
3. {  
4. printf(“welcome to libmylib/n”);  
5. }  
6. void outstring(const char * str)  
7. {  
8. if(str!=NULL)  
9. printf(“%s”,str);  
10. }  

 
3. 编译源文件，产生目标代码
gcc –o mylib.o –c mylib.c
4. 将上面产生的目标文件加入到静态库中，并把静态库拷贝到系统默认的路径

[c-sharp] view plaincopy

1. ar rcs libmylib.a mylib.o  
2. cp libmylib.a /usr/lib/  

 
5. 编写测试程序来使用刚才创建的静态库 libmylib.a

[c-sharp] view plaincopy

1. #include “mylib.h”  
2. #include <stdio.h>  
3. Int main()  
4. {  
5. printf(“create and use library:/n”);  
6. welcome();  
7. outstring(“It’s a successful/n”);  
8. }  

 
6. 编译使用库函数的程序

[c-sharp] view plaincopy

1. gcc –o test test.c -lmylib  

运行./test 查看结果。

 

 

 

使用Automake 创建和使用动态库

动态库与静态库的差别在于：动态库是在程序执行的时候加载到内存，供调用函数使用。
1. 目录结构如下：

[c-sharp] view plaincopy

1. example  
2. |——src 目录（存放源代码文件）  
3. |——hello.c  
4. |——lib 目录（存放用来生成库的文件）  
5. |——test.c 用来生成动态库libhello.la  
6. |——include 目录（存放程序中使用的头文件）  
7. |——hello.h  

 
2. 编写各个目录下的源文件如下：

[c-sharp] view plaincopy

1. hello.h 文件  
2. extern void print(char *);  
3. test.c 文件  
4. #include<stdio.h>  
5. void print(char *msg)  
6. {  
7. print(“%s/n”, msg);  
8. }  
9. hello.c 文件  
10. #include “hello.h”  
11. int main()  
12. {  
13. print(“Hello static library!”);//这里用到的是动态库中的函数  
14. return 0;  
15. }  

 
3. 在lib 目录下编译需要生成动态库的文件，生成动态库，并安装到系统的标准库中，供
程序调用。具体步骤如下：
(1) 编写Makefile.am 文件

[c-sharp] view plaincopy

1. AUTOMAKE_OPTIONS=foreign  
2. lib_LTLIBRARIES=libhello.la  
3. libhello_la_SOURCES=test.c  

 
这里lib_LTLIBRARIES 的意思是生成的动态库，然后指定动态库依赖的源文件
test.c ，若有多个源文件用空格隔开。
(2) 在lib 目录下，用命令autoscan 产生configure.scan 文件,并改名为configure.in。这
里需加上宏AC_PROG_LIBTOOL，表示利用libtool 来自动生成动态库

[c-sharp] view plaincopy

1. #configure.in  
2. # Process this file with autoconf to produce a configure script.  
3. AC_PREREQ(2.59)  
4. AC_INIT(hello,1.0, [[e-mail]])  
5. AM_INIT_AUTOMAKE  
6. AC_CONFIG_SRCDIR([test.c])  
7. #AC_CONFIG_HEADER([config.h])  
8. # Checks for programs.  
9. AC_PROG_CC  
10. # Checks for header files.  
11. # Checks for typedefs, structures, and compiler characteristics.  
12. # Checks for library functions.  
13. AC_PROG_LIBTOOL  
14. AC_CONFIG_FILES([Makefile])  
15. AC_OUTPUT  

 
(3) 执行命令aclocal、libtoolize -f -c 、autoconf、automake --add-missing、./configure、
make、make install 将动态库安装到系统的标准库中，以供调用（一般为/usr/local/lib）。
注：libtoolize 提供了一种标准的方式来将libtool 支持加入一个软件包，而GNU libtool 是
一个通用库支持脚本，将使用动态库的复杂性隐藏在统一、可移植的接口中。
4. 生成src 目录下的hello 可执行文件
(1) 编写src/Makefile.am 文件

[c-sharp] view plaincopy

1. AUTOMAKE_OPTIONS=foreign  
2. INCLUDES= -I../include  
3. bin_PROGRAMS=hello  
4. hello_SOURCES=hello.c  
5. hello_LDADD=-lhello  

 
-ldir 指定编译时搜索库的路径。与静态库不同的是，创建动态库时不用指定库路
径，编译器自动在标准库中查找libhello.so 文件。
(2) 执行autoscan 生成configure.scan 文件，将它重命名为configure.in 并修改其内容。

[c-sharp] view plaincopy

1. # configure.in  
2. # Process this file with autoconf to produce a configure script.  
3. AC_PREREQ(2.59)  
4. AC_INIT(hello,1.0, [[e-mail]])  
5. AM_INIT_AUTOMAKE  
6. AC_CONFIG_SRCDIR([hello.c])  
7. #AC_CONFIG_HEADER([config.h])  
8. # Checks for programs.  
9. AC_PROG_CC  
10. # Checks for header files.  
11. # Checks for typedefs, structures, and compiler characteristics.  
12. # Checks for library functions.  
13. AC_CONFIG_FILES([Makefile])  
14. AC_OUTPUT  

 
(3) 在src 目录下编译并生成目标文件，执行命令aclocal、libtoolize -f -c 、autoconf、
automake --add-missing、./configure、make，此时你一定会觉得，成功近在咫尺了。再
执行目标文件./hello，结果却在你的意料之外：
./hello: error while loading shared libraries: libhello.so.0 : cannot open shared object file:
No such file or directory
在执行目标文件的时候，Shell 找不到共享库的位置，需要我们手工载入库路径。
5. shell 搜索动态库路径位置的两种方法
(1) 使用命令导入动态库的路径，命令如下：
export LD_LIBRARY_PATH=dir (如/usr/local/lib)
(2) 修改/etc/ld.so.conf 文件，加入搜索路径，修改后用ldconfig 命令载入修改。
将自己可能存放库文件的路径都加入到/etc/ld.so.conf 中是明智的选择 ^_^。添加
方法也极其简单，将库文件的绝对路径直接写进去就OK 了，一行一个。例如：
/usr/local/lib
/usr/lib
/lib
需要注意的是：这种搜索路径的设置方式对于程序连接时的库（包括共享库和静态
库）的定位已经足够了，但是对于使用了共享库的程序的执行还是不够的。这是 因为
为了加快程序执行时对共享库的定位速度，避免使用搜索路径查找共享库的低效率，所
以是直接读取库列表文件 /etc/ld.so.cache 从中进行搜索的。/etc/ld.so.cache 是一个非
文本的数据文件，不能直接编辑，它是根据 /etc/ld.so.conf 中设置的搜索路径由
/sbin/ldconfig 命令将这些搜索路径下的共享库文件集中在一起而生成的（ldconfig 命令
要以 root 权限执行）。因此，为了保证程序执行时对库的定位，在 /etc/ld.so.conf 中
进行了库搜索路径的设置之后，还必须要运行 /sbin/ldconfig 命令更新 /etc/ld.so.cache
文件之后才可以。ldconfig ,简单的说，它的作用就是将/etc/ld.so.conf 列出的路径下的库
文件 缓存到/etc/ld.so.cache 以供使用。因此当安装完一些库文件，(例如刚安装好glib)，
或者修改ld.so.conf 增加新的库路径后，需要运行一下/sbin/ldconfig 使所有的库文件都
被缓存到ld.so.cache 中，如果没做，即使库文件明明就在/usr/lib 下的，也是不会被使
用的，结果编译过程中报错，缺少xxx 库，去查看发现明明就在那放着，搞的想大骂
computer 蠢猪一个^_^。极力推荐使用这种方法！
利用gcc 创建和使用动态库
1. 用下面的命令将mylib.c 程序创建成一个动态库：
gcc –fPIC –o mylib.o –c mylib.c
gcc –shared –o libtt.so mylib.o
-fPIC 作用于编译阶段，告诉编译器产生与位置无关代码(Position-Independent Code)，
则产生的代码中，没有绝对地址，全部使用相对地址，故而代码可以被加载器加载到内存的
任意位置，都可以正确的执行。这正是共享库所要求的，共享库被加载时，在内存的位置不
是固定的。
-shared 作用于链接阶段，实际传递给链接器ld，让其添加作为共享库所需要的额外描
述信息，去除共享库所不需的信息。
也可以直接使用下面一条命令：
gcc –fPIC –shared –o libtt.so mylib.c
2. 将动态库拷贝到linux 的标准库中，usr/local/lib 或者/usr/lib 或者/lib:
cp libttt.so /usr/local/lib
3. 编译src 目录下的源程序时，指定动态库文件的目录，调用动态库中的函数
gcc –o test test.c /usr/lib/libttt.so
4. 设置shell 动态库搜索路径，运行生成的可执行文件

 

 

 

 

这是一个 autoconf / automake 的 "Hello World"

[e-mail]

主要步骤是
- 准备工程目录结构和程序
- autoscan 生成 configure.scan
- 编辑修改 configure.scan，重命名为 configure.ac 或 configure.in
- aclocal; libtoolize; autoheader; autoconf 生成 'configure' 可执行文件
- 写 Makefile.am
- automake 生成 Makefile
- 完成。后面就可以 ./configure; make; make install; make dist; ...

试验工程结构如下

hello
|
|---- src
|     |---- main
|     |     |---- main.c
|     |
|     |---- foo
|     |     |---- foo.c
|     |
|     |---- bar
|           |---- bar.c
|
|---- include
       |---- foo.h
       |---- bar.h


说明一下
"hello"     工程的$(top_srcdir)
"src/main"   生成可执行文件 hello 主目录
"src/foo"   生成静态库的目录 libfoo.a；hello 主程序 link 时用
"src/bar"   生成动态库的目录 libbar.so；hello 主程序运行时加载
"include"   头文件目录

$mkdir hello && cd hello

准备示例程序，如下

### 文件内容 ###

/* ### src/main/main.c ### */
#include <stdio.h>
#include "foo.h"
#include "bar.h"
int main(int argc, char *argv[])
{
     printf("main +\n");
     func_foo();
     func_bar();
     printf("main -\n");
    return 0;
}

/* ### include/foo.h ### */
#include <stdio.h>
void func_foo(void);

/* ### src/foo/foo.c ### */
#include "foo.h"
void func_foo(void)
{
     printf("foo +-\n");
}

/* ### include/bar.h ### */
#include <stdio.h>
void func_bar(void);

/* ### src/bar/bar.c ### */
#include "bar.h"
void func_bar(void)
{
     printf("bar +-\n");
}

下面进入顶层目录 $(top_srcdir)

$cd hello
$autoscan

自动生成 configure.scan 文件，我们要作稍许修改，重命名为 configure.ac 或 configure.in
(configure.in 是老版本 autoconf 支持的)

$mv configure.scan configure.ac

修改 configure.ac 如下

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

AC_PREREQ(2.61)
AC_INIT(hello, 1.0.0, [e-mail])                ### Modified
AM_INIT_AUTOMAKE(hello,1.0.0, [e-mail])      ### Added
AC_CONFIG_SRCDIR([src/main/main.c])
AC_CONFIG_HEADER([config.h])

# Checks for programs.
AC_PROG_CC
# AC_PROG_RANLIB                                         ### Added if static libary used
AC_PROG_LIBTOOL                                         ### Added if dynamic libary used

# Checks for libraries.

# Checks for header files.

# Checks for typedefs, structures, and compiler characteristics.
AC_C_CONST

# Checks for library functions.
AC_OUTPUT(Makefile                                       ### Added
           include/Makefile
           src/main/Makefile
           src/foo/Makefile
           src/bar/Makefile
          )

说明一下：
如果不使用静态库或动态库 'AC_PROG_RANLIB' 和'AC_PROG_LIBTOOL' 则都不需要
如果仅使用静态库，增加 'AC_PROG_RANLIB' 即可
如果需要使用动态库，需加上 'AC_PROG_LIBTOOL'
'AC_CONFIG_HEADER(...)'，我在 RedHat9 上试的时候，这行要改面'AM_CONFIG_HEADER(...)'，原因未知。
用 RedHat 9 时，最后 'AC_OUTPUT(...)' 里文件也不太一样， RedHat9 需要多一行 'src/Makefile'，详见下面说明。
(我默认是用 debian 5)

接着执行下面的命令

$aclocal
$libtoolize
$autoheader
$autoconf

注：只有用到动态库时，才需要 '$libtoolize'
否则，只需要运行

$aclocal
$autoheader
$autoconf

即可。

此时应该可以生成 'configure' 可执行文件

然后我们写 Makefile.am

/* ### Makefile.am ### */
SUBDIRS = include src/bar src/foo src/main

/* ### include/Makefile.am ### */
helloincludedir=$(includedir)
helloinclude_HEADERS=foo.h bar.h

/* ### src/main/Makefile.am ### */
bin_PROGRAMS=hello
hello_SOURCES=main.c
hello_LDADD=$(top_srcdir)/src/foo/libfoo.a
LIBS=-lbar
INCLUDES=-I$(top_srcdir)/include
hello_LDFLAGS=-L$(top_srcdir)/src/bar

/* ### src/foo/Makefile.am ### */
noinst_LIBRARIES=libfoo.a
libfoo_a_SOURCES=foo.c
INCLUDES=-I$(top_srcdir)/include  

/* ### src/bar/Makefile.am ### */
lib_LTLIBRARIES=libbar.la
libbar_la_SOURCES=bar.c
INCLUDES=-I$(top_srcdir)/include  

说明一下，
第一个 'Makefile.am' 文件，即'$(top_srcdir)/Makefile.am' 只说了子目录说明，按编译顺序排的。
RedHat 9 会报错，说不能含 '/' 符号；解决办法是，我们新增加一个  '$(top_srcdir)/src/Makefile.am'
这样：
/* ### Makefile.am ### */
SUBDIRS = include src
/* ### src/Makefile.am ### */
SUBDIRS = bar foo main
此时，如前面所讲 'configure.ac' 最后的'AC_OUTPUT' 就需多一行'src/Makefile' 了

'$(top_srcdir)/src/main/Makefile.am' 相对复杂一点，
特别指出的是 'hello_LDFLAGS' 后，应是'...=-L$(top_srcdir)/...'，而不是'...=-L $(top_srcdir)/...'
多一个空格，后面就有错误。

接着 automake 的话，无法通过的，还需要下面几个文件，我们暂时 touch 一下即可

$touch README NEWS AUTHORS ChangeLog

注意是在 $(top_srcdir) 目录下面

然后
$automake --add-missing
$./configure

至此，所有 Makefile 文件应该全部生成
我们可以执行
$make
$make clean
$make install
$make uninstall
$make dist
$make ...
###

 

 

 

 

作为Linux下的程序开发人员，大家一定都遇到过Makefile，用make命令来编译自己写的程序确实是很方便。一般情况下，大家都是手工写一个简单Makefile，如果要想写出一个符合自由软件惯例的Makefile就不那么容易了。 

　　在本文中，将给大家介绍如何使用autoconf和automake两个工具来帮助我们自动地生成符合自由软件惯例的Makefile，这样就可以象常见的GNU程序一样，只要使用“./configure”，“make”，“make instal”就可以把程序安装到Linux系统中去了。这将特别适合想做开放源代码软件的程序开发人员，又或如果你只是自己写些小的Toy程序，那么这个文章对你也会有很大的帮助。

　　一、Makefile介绍

　　Makefile是用于自动编译和链接的，一个工程有很多文件组成，每一个文件的改变都会导致工程的重新链接，但是不是所有的文件都需要重新编译，Makefile中纪录有文件的信息，在make时会决定在链接的时候需要重新编译哪些文件。

　　Makefile的宗旨就是：让编译器知道要编译一个文件需要依赖其他的哪些文件。当那些依赖文件有了改变，编译器会自动的发现最终的生成文件已经过时，而重新编译相应的模块。

　　Makefile的基本结构不是很复杂，但当一个程序开发人员开始写Makefile时，经常会怀疑自己写的是否符合惯例，而且自己写的 Makefile经常和自己的开发环境相关联，当系统环境变量或路径发生了变化后，Makefile可能还要跟着修改。这样就造成了手工书写 Makefile的诸多问题，automake恰好能很好地帮助我们解决这些问题。

　　使用automake，程序开发人员只需要写一些简单的含有预定义宏的文件，由autoconf根据一个宏文件生成configure，由 automake根据另一个宏文件生成Makefile.in，再使用configure依据Makefile.in来生成一个符合惯例的 Makefile。下面我们将详细介绍Makefile的automake生成方法。

　　二、使用的环境

　　本文所提到的程序是基于Linux发行版本：Fedora Core release 1，它包含了我们要用到的autoconf，automake。

　　三、从helloworld入手

　　我们从大家最常使用的例子程序helloworld开始。

　　下面的过程如果简单地说来就是：

　　新建三个文件：

　　　helloworld.c
　　　configure.in
　　　Makefile.am

　　然后执行：

aclocal; autoconf; automake --add-missing; ./configure; make; ./helloworld
　　就可以看到Makefile被产生出来，而且可以将helloworld.c编译通过。

　　很简单吧，几条命令就可以做出一个符合惯例的Makefile，感觉如何呀。

　　现在开始介绍详细的过程：

　　1、建目录

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

$ mkdir helloword
$ cd helloworld
　　2、 helloworld.c

　　然后用你自己最喜欢的编辑器写一个hellowrold.c文件，如命令：vi helloworld.c。使用下面的代码作为helloworld.c的内容。

int main(int argc, char** argv)
{
printf("Hello, Linux World!\n");
return 0;
}
　　完成后保存退出。

　　现在在helloworld目录下就应该有一个你自己写的helloworld.c了。

　　3、生成configure

　　我们使用autoscan命令来帮助我们根据目录下的源代码生成一个configure.in的模板文件。

　　命令：

$ autoscan
$ ls
configure.scan helloworld.c
　　执行后在hellowrold目录下会生成一个文件：configure.scan，我们可以拿它作为configure.in的蓝本。

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

============================configure.in内容开始=========================================
# -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_INIT(helloworld.c)
AM_INIT_AUTOMAKE(helloworld, 1.0)

# 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_OUTPUT(Makefile)
============================configure.in内容结束=========================================
　　然后执行命令aclocal和autoconf，分别会产生aclocal.m4及configure两个文件：

$ aclocal 
$ls 
aclocal.m4 configure.in helloworld.c 
$ autoconf 
$ ls 
aclocal.m4 autom4te.cache configure configure.in helloworld.c
　　大家可以看到configure.in内容是一些宏定义，这些宏经autoconf处理后会变成检查系统特性、环境变量、软件必须的参数的shell脚本。

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

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

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

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

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

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

　　4、新建Makefile.am

　　新建Makefile.am文件，命令：

$ vi Makefile.am
　　内容如下:

AUTOMAKE_OPTIONS=foreign
bin_PROGRAMS=helloworld
helloworld_SOURCES=helloworld.c
　　automake会根据你写的Makefile.am来自动生成Makefile.in。

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

　　5、运行automake

　　命令：

$ automake --add-missing
configure.in: installing `./install-sh'
configure.in: installing `./mkinstalldirs'
configure.in: installing `./missing'
Makefile.am: installing `./depcomp'
　　automake会根据Makefile.am文件产生一些文件，包含最重要的Makefile.in。

　　6、执行configure生成Makefile

$ ./configure 
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
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 style of include used by make... GNU
checking dependency style of gcc... gcc3
configure: creating ./config.status
config.status: creating Makefile
config.status: executing depfiles commands
$ ls -l Makefile
-rw-rw-r-- 1 yutao yutao 15035 Oct 15 10:40 Makefile
　　你可以看到，此时Makefile已经产生出来了。

　　7、使用Makefile编译代码

$ make
if gcc -DPACKAGE_NAME=\"\" -DPACKAGE_TARNAME=\"\" -DPACKAGE_VERSION=\"\" -

DPACKAGE_STRING=\"\" -DPACKAGE_BUGREPORT=\"\" -DPACKAGE=\"helloworld\" -DVERSION=\"1.0\" 

-I. -I. -g -O2 -MT helloworld.o -MD -MP -MF ".deps/helloworld.Tpo" \
-c -o helloworld.o `test -f 'helloworld.c' || echo './'`helloworld.c; \
then mv -f ".deps/helloworld.Tpo" ".deps/helloworld.Po"; \
else rm -f ".deps/helloworld.Tpo"; exit 1; \
fi
gcc -g -O2 -o helloworld helloworld.o
　　运行helloworld

$ ./helloworld 
Hello, Linux 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.in

　　3、 aclocal

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

　　4、 autoconf

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

　　configure.in文件的内容是一些宏，这些宏经过autoconf 处理后会变成检查系统特性、环境变量、软件必须的参数的shell脚本。configure.in文件中的宏的顺序并没有规定，但是你必须在所有宏的最前面和最后面分别加上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.in和aclocal.m4 两个宏文件后，我们就可以使用autoconf来产生configure文件了。

　　5、 Makefile.am

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

AUTOMAKE_OPTIONS 

　　这个是automake的选项。在执行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 --add-missing来产生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 dist

　　产生发布软件包文件（即distribution package）。这个命令将会将可执行文件及相关文件打包成一个tar.gz压缩的文件用来作为发布软件的软件包。

　　它会在当前目录下生成一个名字类似“PACKAGE-VERSION.tar.gz”的文件。PACKAGE和VERSION，是我们在configure.in中定义的AM_INIT_AUTOMAKE(PACKAGE, VERSION)。

make distcheck

　　生成发布软件包并对其进行测试检查，以确定发布包的正确性。这个操作将自动把压缩包文件解开，然后执行configure命令，并且执行make，来确认编译不出现错误，最后提示你软件包已经准备好，可以发布了。

===============================================
helloworld-1.0.tar.gz is ready for distribution
===============================================
make distclean
　　类似make clean，但同时也将configure生成的文件全部删除掉，包括Makefile。

　　五、结束语

　　通过上面的介绍，你应该可以很容易地生成一个你自己的符合GNU惯例的Makefile文件及对应的项目文件。

　　如果你想写出更复杂的且符合惯例的Makefile，你可以参考一些开放代码的项目中的configure.in和Makefile.am文件，比如：嵌入式数据库sqlite，单元测试cppunit。