autoconf / automake工具使用介紹


本文轉自:http://blog.csdn.net/gulansheng/article/details/42683809

一、簡介

作為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生成方法。

 

二、實驗

1、建目錄

  在你的工作目錄下建一個helloworld目錄,我們用它來存放helloworld程序及相關文件:

      $ mkdir helloword

      $ cd helloworld

      $ touch hello.c

 

2、編寫hello.c

int main(int argc, char** argv)

{

        printf("Hello, Linux World! ");

        return 0;

完成后保存退出。現在在helloworld目錄下就應該有一個你自己寫的hello.c了。

3.使用autoscan工具生成configure.scan文件

該文件的簡要說明如下:

1、  AC_PREREQQ宏聲明本文件要求的autoconf版本,這里是2.68

2、  AC_INIT定義軟件的名稱和信息。(DULL-PACKAGE-NAME為軟件名,VERSION為軟件的版本號,BUG-REPORT-ADDRESS為bug的報告地址,一般為軟件作者的郵箱)

3、  AC_CONFIG_SRCDIR用來偵測指定的源碼文件是否存在,確定源碼目錄的有效性。此處為當前目錄下hello.c

4、  AC_CONFIG_HEADER用於生成config.h文件,以便autoheader使用

5、  AC_PROG_CC用來指定編譯器,以便不指定的時候默認為gcc

6、  AC_OUTPUT用來設定config要產生的文件。如果是Makefile,config會把它檢查出來的結果帶入Makefile.in文件產生合適的Makefile.

 

4.獲得並且修改configure.ac(或configure.in)

$cp configure.scan configure.ac

並做一下修改

這里注意重要的一點:AM_INIT_AUTOMAKE宏需要自己進行添加,它是automake所必備的宏。

 

5.使用aclocal工具生成aclocal.m4

6.使用autoconf工具生成configure文件

7.使用autoheader工具生成config.h.in文件

8.創建Makefile.am文件

Automake工具會根據config.in中的參量把Makefile.am轉換成Makefile.in文件。在使用Automake之前,要先手動建立Makefile.am文件。

幾點需要說明:

1、AUTOMAKE_OPTIONS為設置的Automake選項。它有三種等級提供給用戶選擇:foreign,gnu,gnits,默認等級為gnu.在此使用foreign,它只檢測必須的文件。

2、bin_PROGRAMS定義要產生的執行文件名。如果要產生多個可執行文件,則每個文件名用空格隔開。

3、hello_SOURCES定義為hello這個程序所需要的原始文件。如果其石油多個文件組成的,則必須用空格進行隔開。

 

9.使用Automake生成Makefile.in文件

要使用選項“--add-missing”可以讓Automake自動添加一些必要的腳本文件。如下

 
 

10.配置

運行自動配置設置文件configure,把Makefile.in編程最終的Makefile

 

測試

運行Make命令進行編譯。然后運行hello程序

 

三、深入

四、深入淺出

  針對上面提到的各個命令,我們再做些詳細的介紹。

 

  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。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM