GNU automake/autoconf 入门

By | 06月24日
Advertisement

http://papmp.blog.163.com/blog/static/13171622320103219214188/

作为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 。

Similar Posts:

  • 大型项目使用Automake/Autoconf完成编译配置

    http://www.cnblogs.com/xf-linux-arm-java-android/p/3590770.html http://blog.csdn.net/zengraoli/article/details/19968251 http://blog.sina.com.cn/s/blog_564db6f40100be5w.html http://www.laruence.com/2009/11/18/1154.html http://www.cnblogs.com/hnrainll/

  • GUN automake,autoconf写Makefile(一)

    摘要 网上这方面的文章不少,也有很多错误的,如何去伪存真也不容易,英文好的同学最好还是看官方的介绍,毕竟是原版专业的,最近刚好用到这个工具,写下我自己的认识,抛砖引玉希望能给大家一点参考. 首先还是从helloword一步一步来. 内容 automake,autoconf安装 Helloword程序 automake生成Makefile 一.automake,autoconf 安装 http://www.gnu.org/software/automake/ hello word之旅前需要准备上面

  • Linux下使用automake autoconf autoscan aclocal简单介绍

    最近又开始玩起了Linux,Linux下的软件也越来越多了,桌面应用能力不必Windows差了,很多很好的软件都在Linux有相应的版本,比如浏览器Chrome,飞信openfeition,播放器VLC,输入法Sunpinyin等等,言归正传,对于Linux下做开发,最棘手的莫过于Makefile文件,一方面Makefile文件对于我们编译文件确实非常方便,但是里面的规则我们看的也非常头大,所以GNU开发了一些非常好的工具,就是automake等等工具了,关于命令可以网上搜到很多,这里只简单粘贴

  • GNU Autotools (autoconf, automake, libtool, etc.) 自动化编译 (1) 简单示例

    0. 操作平台: Linux 1. 软件包安装(Debian) yes | sudo apt-get install gcc make autoconf automake libtool 2. 从一个例子谈起. 2.0 完整拷贝如下代码直接在终端执行或者保存为auto-example.sh,添加执行权限执行.或者参考2.1~2.5逐步执行. echo "create directory ..." echo_exit() { echo "ERROR: [email protected]" exit

  • automake/autoconf打包简单实例

    本文将简单介绍为一个简单项目制作自动生成makefile文件的方法. 项目描述: 项目目录如下所示: 该项目中一个源文件用来生成库文件,两外两个源文件用来生成使用库文件的应用程序. 为这个项目运用自动工具,首先要为该项目创建5个文件,主要是: 1.autogen.h 运行自动工具以产生构建环境的shell脚本,位于Test_Proj/目录下 2.configure.ac aotuconf工具的输入文件,通过该工具生成configure脚本 位于Test_Proj/目录下 3.Makefile.a

  • automake,autoconf,make

    例解 autoconf 和 automake 生成 Makefile 文件 杨 小华 ([email protected]), Linux 内核研究员 苏 春艳, 在读研究生 简介: 本文介绍了在 linux 系统中,通过 Gnu autoconf 和 automake 生成 Makefile 的方法.主要探讨了生成 Makefile 的来龙去脉及其机理,接着详细介绍了配置 Configure.in 的方法及其规则. 标记本文! 发布日期: 2006 年 9 月 21 日 级别: 初级

  • 图解autoscan,aclocal,autoheader,automake,autoconf...

    1.autoscan (autoconf): 扫描源代码以搜寻普通的可移植性问题,比如检查编译器,库,头文件等,生成文件configure.scan,它是configure.ac的一个雏形. your source files --> [autoscan*] --> [configure.scan] --> configure.ac 2.aclocal (automake):根据已经安装的宏,用户定义宏和acinclude.m4文件中的宏将configure.ac文件所需要的宏集中定义到

  • GNU ARM汇编入门

    第一部分 Linux下ARM汇编语法尽管在Linux下使用C或C++编写程序很方便,但汇编源程序用于系统最基本的初始化,如初始化堆栈指针.设置页表.操作 ARM的协处理器等.初始化完成后就可以跳转到C代码执行.需要注意的是,GNU的汇编器遵循AT&T的汇编语法,可以从GNU的站点(www.gnu.org)上下载有关规范. 一. Linux汇编行结构 任何汇编行都是如下结构: [:] [} @ comment [:] [} @ 注释 Linux ARM 汇编中,任何以冒号结尾的标识符都被认为是一个

  • 使用 autoconf 和 automake自动生成Makefile

    automake/autoconf 入门 看了比较好,转载的 作为 Linux 下的程序开发人员,大家一定都遇到过 Makefile,用 make 命令来编译自己写的 程序确实是很方便.一般情况下,大家都是手工写一个简单 Makefile,如果要想写出一个 符合自由软件惯例的 Makefile 就不那么容易了. 在本文中,将给大家介绍如何使用 autoconf 和 automake 两个工具来帮助我们自动地生成符 合自由软件惯例的 Makefile,这样就可以象常 见的 GNU 程序一样,只要使

  • 自动生成Makefile的全过程详解

    automake/autoconf入门 作为Linux下的程序开发人员,大家一定都遇到过Makefile,用make命令来编译自己写的程序确实是很方便.一般情况下,大家都是手工写一个简单Makefile,如果要想写出一个符合自由软件惯例的Makefile就不那么容易了. 在本文中,将给大家介绍如何使用autoconf和automake两个工具来帮助我们自动地生成符合自由软件惯例的Makefile,这样就可以象常 见的GNU程序一样,只要使用"./configure","mak

Tags: