【轉載】【工具使用】Linux下Makefile的automake生成全攻略

做爲Linux下的程序開發人員，你們必定都遇到過Makefile，用make命令來編譯本身寫的程序確實是很方便。通常狀況下，你們都是手工寫一個簡單Makefile，若是要想寫出一個符合自由軟件慣例的Makefile就不那麼容易了。

　　在本文中，將給你們介紹如何使用autoconf和automake兩個工具來幫助咱們自動地生成符合自由軟件慣例的Makefile，這樣就能夠象常見的GNU程序同樣，只要使用「./configure」，「make」，「make instal」就能夠把程序安裝到Linux系統中去了。這將特別適合想作開放源代碼軟件的程序開發人員，又或若是你只是本身寫些小的Toy程序，那麼這個文章對你也會有很大的幫助。

1、Makefile介紹

　　Makefile是用於自動編譯和連接的，一個工程有不少文件組成，每個文件的改變都會致使工程的從新連接，可是不是全部的文件都須要從新編譯，Makefile中紀錄有文件的信息，在make時會決定在連接的時候須要從新編譯哪些文件。

　　Makefile的宗旨就是：讓編譯器知道要編譯一個文件須要依賴其餘的哪些文件。當那些依賴文件有了改變，編譯器會自動的發現最終的生成文件已通過時，而從新編譯相應的模塊。

　　Makefile的基本結構不是很複雜，但當一個程序開發人員開始寫Makefile時，常常會懷疑本身寫的是否符合慣例，並且本身寫的Makefile常常和本身的開發環境相關聯，當系統環境變量或路徑發生了變化後，Makefile可能還要跟着修改。這樣就形成了手工書寫Makefile的諸多問題，automake剛好能很好地幫助咱們解決這些問題。

　　使用automake，程序開發人員只須要寫一些簡單的含有預約義宏的文件，由autoconf根據一個宏文件生成configure，由automake根據另外一個宏文件生成Makefile.in，再使用configure依據Makefile.in來生成一個符合慣例的Makefile。下面咱們將詳細介紹Makefile的automake生成方法。

2、使用的環境

　　本文所提到的程序是基於Linux發行版本：Fedora Core release 1，它包含了咱們要用到的autoconf，automake。

3、從helloworld入手

　　咱們從你們最常使用的例子程序helloworld開始。

　　下面的過程若是簡單地說來就是：

　　新建三個文件：

　　　helloworld.c
　　　configure.in
　　　Makefile.am

　　而後執行：

aclocal; autoconf; automake --add-missing; ./configure; make; ./helloworld

就能夠看到Makefile被產生出來，並且能夠將helloworld.c編譯經過。

很簡單吧，幾條命令就能夠作出一個符合慣例的Makefile，感受如何呀。

如今開始介紹詳細的過程：

一、建目錄

　　在你的工做目錄下建一個helloworld目錄，咱們用它來存放helloworld程序及相關文件，如在/home/my/build下：

mkdir helloword cd helloworld

二、 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了。

三、生成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兩個文件：

aclocalls 
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既能夠做爲編譯器的前端，也能夠單獨做爲一個宏處理器。

四、新建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將致使編譯和鏈接的目標被生成。

五、運行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。

六、執行configure生成Makefile

./configurecheckingforaBSD−compatibleinstall.../usr/bin/install−ccheckingwhetherbuildenvironmentissane...yescheckingforgawk...gawkcheckingwhethermakesets(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已經產生出來了。

七、使用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，老闆必定會對你另眼相看。

4、深刻淺出

針對上面提到的各個命令，咱們再作些詳細的介紹。

一、 autoscan

autoscan是用來掃描源代碼目錄生成configure.scan文件的。autoscan能夠用目錄名作爲參數，但若是你不使用參數的話，那麼autoscan將認爲使用的是當前目錄。autoscan將掃描你所指定目錄中的源文件，並建立configure.scan文件。

二、 configure.scan

configure.scan包含了系統配置的基本選項，裏面都是一些宏定義。咱們須要將它更名爲configure.in

三、 aclocal

aclocal是一個perl 腳本程序。aclocal根據configure.in文件的內容，自動生成aclocal.m4文件。aclocal的定義是：「aclocal - create aclocal.m4 by scanning configure.ac」。

四、 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文件了。

五、 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。

六、 automake

咱們使用automake --add-missing來產生Makefile.in。

選項--add-missing的定義是「add missing standard files to package」，它會讓automake加入一個標準的軟件包所必須的一些文件。

咱們用automake產生出來的Makefile.in文件是符合GNU Makefile慣例的，接下來咱們只要執行configure這個shell 腳本就能夠產生合適的 Makefile 文件了。

七、 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。

5、結束語

　　經過上面的介紹，你應該能夠很容易地生成一個你本身的符合GNU慣例的Makefile文件及對應的項目文件。

　　若是你想寫出更復雜的且符合慣例的Makefile，你能夠參考一些開放代碼的項目中的configure.in和Makefile.am文件，好比：嵌入式數據庫sqlite，單元測試cppunit。