C程序开发，免不了用Makefile来编译，Makefile的规则定义学习容易，一段时间不用，难免会忘。现在有Automake工具，自动化生成Makefile，用好了那是事半功倍，相当的有效率。
下面将介绍 如何利用 GNU Autoconf 及 Automake 来协助『自动』产生
Makefile 文件，并且让开发出来的程序or软件，只要会 ``./configure'',
``make'', ``make install''
就可以安装到系统中。刚开始学，了解不多，介绍个例子，先掌握其流程：
1. 简介
Makefile 基本上就是『目标』(target), 『关连』(dependencies)
和『动作』三者所组成的一连串规则。而 make 就会根据 Makefile
的规则来决定如何编译 (compile) 和连结 (link) 。
Makefile
基本构造虽然简单，但是妥善运用这些规则就也可以变出许多不同的花招。却也因此，许多刚开始学习写
Makefile 时会感到没有规范可循，每个人写出来的 Makefile
长得都不太一样，不知道从何下手，而且只要环境变数不同或路径改一下，可能Makefile
就得跟着修改。虽然有 GNU Makefile Conventions (GNU Makefile 惯例)
订出一些使用 GNU 程序设计时撰写 Makefile
的一些标准和规范，但是内容很长而且很复杂,
并且经常做些调整，为了减轻软件开发者维护 Makefile
的负担，因此有了Automake。
软件编写人员只需写一些预先定义好的巨集 (macro)，交给 Automake
处理后会产生一个可供Autoconf 使用的 Makefile.in 文件。再配合利用Autoconf
产生的自动设定文件 configure 即可产生一份符合 GNU Makefile惯例的 Makeifle
了。
2. 开始之前
在开始试着用 Automake 之前，请先确认你的系统已经安装以下的软件：
1. GNU Automake
2. GNU Autoconf
3. GNU m4
4. perl
5. GNU Libtool (生成shared library时需要)
3. 一个简单的例子
Automake 所产生的 Makefile
除了可以做到程序的编译和连结，也已经把如何产生程序文件(如 manual page,
info 文件及 dvi 文件)
的动作，还有把原始程序包装起来以供散的动作都考虑进去了，所以原始程序所存放的目录架构最好符合
GNU 的标准惯例，接下来我拿hello.c 来做为例子。
在工作目录下建立一个新的子目录 ``devel''，再在 devel
下建立一个``hello'' 的子目录，这个目录将作为我们存放 hello
这个程序及其相关文件的地方：
% mkdir devel
% cd devel
% mkdir hello
% cd hello
用编辑器写个 hello.c 文件，
#include stdio.h
int main(int argc, char** argv)
{
printf(``Hello, Slitaz! \n'');
return 0;
}
接下来就要用 Autoconf 及 Automake 来帮我们产生 Makefile 了，
1. 用 autoscan 产生一个 configure.in 的雏型，执行 autoscan
后会产生一个configure.scan 的文件，我们可以用它做为configure.in文件的蓝本。
% autoscan
% ls
configure.scan hello.c
2. 编辑 configure.scan 文件，如下所示，并且把它的文件名改成configure.in
#Process this file with autoconf to produce a con figure 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 ch aracteristics.
# Checks for library functions.
AC_OUTPUT(Makefile)
3. 执行 aclocal 和 autoconf ，分别会产生 aclocal.m4 及 configure
两个文件
% aclocal
% autoconf
% ls
aclocal.m4 configure configure.in hello.c
4. 编辑 Makefile.am 文件，内容如下
AUTOMAKE_OPTIONS= foreign
bin_PROGRAMS= hello
hello_SOURCES= hello.c
5. 执行 automake --add-missing ，Automake 会根据 Makefile.am
文件产生一些文件，包含最重要的 Makefile.in
% automake --add-missing
automake: configure.in: installing `./install-sh'
automake: configure.in: installing `./mkinstalldirs'
automake: configure.in: installing `./missing'
6. 最后执行 ./configure ，
% ./configure
creating cache ./config.cache
checking for a BSD compatible install... /usr/bin/in stall -c
checking whether build environment is sane... yes
checking whether make sets ${MAKE}... yes
checking for working aclocal... found
checking for working autoconf... found
checking for working automake... found
checking for working autoheader... found
checking for working makeinfo... found
checking for gcc... gcc
checking whether the C compiler (gcc ) works... yes
checking whether the C compiler (gcc ) is a cross-co mpiler... no
checking whether we are using GNU C... yes
checking whether gcc accepts -g... yes
updating cache ./config.cache
creating ./config.status
creating Makefile
现在你的目录下已经产生了一个 Makefile 文件，下个 ``make''
指令就可以开始编译 hello.c 成执行文件，执行 ./hello 和 GNU 打声招呼吧！
% make
gcc -DPACKAGE="hello" -DVERSION="1.0" -I. -I. -g -O2 -c he llo.c
gcc -g -O2 -o hello hello.o
% ./hello
Hello，Slitaz!
你还可以试试 ``make clean''，''make install''，''make dist''
看看会有什么结果。
4. 一探究竟
上述产生 Makefile
的过程和以往自行编写的方式非常不一样，舍弃传统自行定义 make 的规则，使用
Automake 只需用到一些已经定义好的巨集即可。我们把巨集及目标 (target)写在
Makefile.am 文件内，Automake读入 Makefile.am
文件后会把这一串已经定义好的巨集展开并且产生对应的Makefile.in 文件，
然后再由 configure 这个 shell script 根据Makefile.in 产生适合的 Makefile。
在上面例子中可借由 Autoconf 及 Automake 工具所产生的文件有
configure.scan、aclocal.m4、configure、Makefile.in，需要我们加入设定者为
configure.in 及 Makefile.am。
4.1 编辑 configure.in 文件
Autoconf 是用来产生 'configure' 文件的工具。'configure' 是一个shell
script，它可以自动设定原始程序以符合各种不同平台上 Unix
系统的特性，并且根据系统叁数及环境产生合适的 Makefile 文件或是C 的标头文件
(header
file)，让原始程序可以很方便地在这些不同的平台上被编译出来。Autoconf 会读取
configure.in 文件然后产生 'configure' 这个shell script。
configure.in 文件的内容是一连串 GNU m4 的巨集，这些巨集经过autoconf
处理后会变成检查系统特徵的 shell script。configure.in
内巨集的顺序并没有特别的规定，但是每一个 configure.in
文件必须在所有巨集前加入 AC_INIT 巨集，然后在所有巨集的最后面加上
AC_OUTPUT 巨集。我们可先用 autoscan 扫描原始文件以产生一个 configure.scan
文件，再对 configure.scan 做些修改成 configure.in
文件。在范例中所用到的巨集如下：
#
这个巨集后面的字不会被处理，可视为注解。
AC_INIT(FILE)
这个巨集用来检查原始码所在的路径，autoscan 会自动产生，我们不必修改它。
AM_INIT_AUTOMAKE(PACKAGE,VERSION)
这是使用 Automake 所必备的巨集，PACKAGE
是我们所要产生软件套件的名称，VERSION 是版本编号。
AC_PROG_CC
检查系统可用的 C 编译器，如果原始程序是用 C 写的就需要这个巨集。
AC_OUTPUT(FILE)
设定 configure 所要产生的文件，如果是 Makefile 的话，configure
便会把它检查出来的结果带入 Makefile.in 文件然后产生合适的 Makefile。
实际上，我们使用 Automake
时，还须要一些其它的巨集，这些额外的巨集我们用 aclocal来帮我们产生。执行
aclocal 会产生 aclocal.m4文件，如果没有特别的用途，我们可以不必修改它，用
aclocal 所产生的巨集会告诉 Automake 怎么做。
有了 configure.in 及 aclocal.m4 两个文件后，便可以执行 autoconf来产生
configure文件了。
4.2 编辑 Makefile.am 文件
接下来我们要编辑 Makefile.am 文件，Automake 会根据 configure.in
中的巨集把Makefile.am 转成 Makefile.in 文件。Makefile.am
文件定义我们所要产的目标：
AUTOMAKE_OPTIONS
设定 automake 的选项。Automake 主要是帮助开发 GNU
软件的人员维护软件套件，所以在执行 automake 时，会检查目录下是否存在标准
GNU 软件套件中应具备的文件文件，例如 'NEWS'、'AUTHOR'、'ChangeLog'
等文件文件。设成 foreign 时，automake 会改用一般软件套件的标准来检查。
bin_PROGRAMS
定义我们所要产生的执行文件文件名。如果要产生多个执行文件，每个文件名用空白字元隔开。
hello_SOURCES
定义 'hello' 这个执行文件所需要的原始文件。如果 'hello'
这个程序是由多个原始文件所产生，必须把它所用到的原始文件都列出来，以空白字元隔开。假设
'hello' 这个程序需要 'hello.c'、'main.c'、
'hello.h'
三个文件的话，则定义
hello_SOURCES= hello.c main.c hello.h
如果我们定义多个执行文件，则对每个执行文件都要定义相对的filename_SOURCES。
编辑好 Makefile.am 文件，就可以用 automake --add-missing
来产生Makefile.in。加上 --add-missing 选项是告诉 automake
顺便帮我们加入包装一个软件套件所必备的文件。Automake 产生出来的
Makefile.in文件是完全符合 GNU Makefile 的惯例，我们只要执行 configure
这个shell script 便可以产生合适的 Makefile 文件了。
4.3 使用 Makefile
利用 configure 所产生的 Makefile
文件有几个预设的目标可供使用，我们只拿其中几个简述如下：
make all
产生我们设定的目标，即此范例中的执行文件。只打 make
也可以，此时会开始编译原始码，然后连结，并且产生执行文件。
make clean
清除之前所编译的执行文件及目的文件 (object file, *.o)。
make distclean
除了清除执行文件和目的文件外，也把 configure 所产生的
Makefile也清除掉。
make install
将程序安装至系统中。如果原始码编译无误，且执行结果正确，便可以把程序安装至系统预设的执行文件存放路径。如果我们用bin_PROGRAMS
巨集的话，程序会被安装至 /usr/local/bin 这个目录。
make dist
将程序和相关的文件包装成一个压缩文件以供散播 (distribution)
。执行完在目录下会产生一个以 PACKAGE-VERSION.tar.gz 为名称的文件。PACKAGE
和 VERSION 这两个变数是根据 configure.in 文件中AM_INIT_AUTOMAKE(PACKAGE,
VERSION) 的定义。在此范例中会产生 'hello-1.0.tar.gz' 的文件。
make distcheck
和 make dist
类似，但是加入检查包装后的压缩文件是否正常。这个目标除了把程序和相关文件包装成
tar.gz 文件外，还会自动把这个压缩文件解开，执行 configure，并且进行 make
all 的动作，确认编译无误后，会显示这个 tar.gz
文件已经准备好可供散播了。这个检查非常有用，检查过关的套件，基本上可以给任何一个具备
GNU 发展境的人去重新编译。就 hello-1.tar.gz 这个范例而言，除了在 Red Hat
linux 上，在 FreeBSD 2.2.x 版也可以正确地重新编译。
要注意的是，利用 Autoconf 及 Automake
所产生出来的软件套件是可以在没有安装 Autoconf 及 Automake
的环境上使用的，因为 configure 是一个 shell script，它己被设计可以在一般
Unix 的 sh 这个 shell 下执行。但是如果要修改 configure.in 及 Makefile.am
文件再产生新的configure 及 Makefile.in 文件时就一定要有 Autoconf 及
Automake 了。
5. 说明
Autoconf 和 Automake 功能十分强大，你可以从它们所附的 info
文件找到详细的用法。你也可以从许多现存的 GNU 软件或 Open Source
软件中找到相关的 configure.in 或 Makefile.am 文件，它们是学习 Autoconf
及Automake 更多技巧的最佳范例。
本文只用到了 Autoconf 及 Automake
的皮毛罢了，希望这篇文件能帮助你对产生
Makefile有个简单的依据。其它有关开发 GNU程序或 C 程序设计及 Makefile
的详细运用及技巧，请参阅http://www.gnu.org上的说明文档。
有了Autoconf 及 Automake 的辅助，产生一个 Makefile
似乎不再像以前那么困难了，而使用 Autoconf 也使得我们在不同平台上或各家
Unix之间散播及编译程序变得简单，这对于在 Unix
/linux系统上开发程序的人员来说减轻了许多负担。妥善运用这些 GNU
的工具软件，可以帮助我们更容易去发展程序，而且更容易维护原始程序码。
博文
没有评论:
发表评论