automake与autoconf的简单使用

1.软件环境配置安装

使用automake需要安装automake、autoconf以及perl

1)、windows下可以使用msys2安装命令如下:

pacman -S automake

pacman -S autoconf

pacman -S perl

2)、linux可以使用rpm、yum、apt-get等命令安装

2.automake使用流程:

3.流程简要说明


1、源文件通过autoscan命令生成configure.scan文件,然后修改configure.scan文件并重命名为configure.in或configure.ac
2、aclocal命令生成aclocal.m4
3、autoconf命令生成configure
4、编辑一个Makefile.am文件并由automake命令生成Makefile.in文件
5、运行configure命令生成Makefile

4.详细操作步骤及其说明


1、autoscan

    autoscan是用来扫描源代码目录生成configure.scan文件的。autoscan可以用目录名做为参数,但如果你不使用参数的话,那么autoscan将认为使用的是当前目录。autoscan将扫描你所指定目录中的源文件,并创建configure.scan文件。

2、configure.scan

    configure.scan包含了系统配置的基本选项,里面都是一些宏定义。我们需要将它改名为configure.in或者configure.ac

3、aclocal

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

4、autoheader

    此步骤是生成config.h.in。过程:configure.ac、aclocal.m4(可选)–>autoheader–>config.h.in
    当我们的程序要使用一些与平台相关的库时,由于在不同的平台上同样功能的库名字、函数、头文件的不同等,为了使程序具有可移植性,我们经常会在程序中使用一大堆的#ifdef或#ifndef预编译指令,
    这样非常地不方便。而autoheader就是解决这个问题的,在它生成的模板文件config.h.in中,为这些库、函数、头文件等定义了#undef宏标志,configure脚本把它转换成config.h后,就会变成#define宏标志,
    用作这些库、函数、头文件的保护符。这样,你可以在程序里包含这个config.h,然后使用其中的某些定义好的常量。

5、 autoconf

  使用autoconf,根据configure.in和aclocal.m4来产生configure文件。configure是一个脚本,它能设置源程序来适应各种不同的操作系统平台,并且根据不同的系统来产生合适的Makefile,从而可以使你的源代码能在不同的操作系统平台上被编译出来。
  configure.in文件的内容是一些宏,这些宏经过autoconf 处理后会变成检查系统特性、环境变量、软件必须的参数的shell脚本。configure.in文件中的宏的顺序并没有规定,但是你必须在所有宏的最前面和最后面分别加上AC_INIT宏和AC_OUTPUT宏。
  在configure.in中:
  #号表示注释                                    这个宏后面的内容将被忽略。
    AC_INIT([包名],[版本号],[邮箱])            autoconf 和automake的初始化
    AM_INIT_AUTOMAKE(PACKAGE, VERSION)      这个宏是必须的,它描述了我们将要生成的软件包的名字及其版本号:PACKAGE是软件包的名字,VERSION是版本号。当你使用make dist命令时,它会给你生成一个类似helloworld-1.0.tar.gz的软件发行包,其中就有对应的软件包的名字和版本号。
  AC_PROG_CC                                这个宏将检查系统所用的C编译器。这行最终的作用是让configure脚本来在系统中搜索C编译器,并且把C编译器定义为变量CC。
    AC_CONFIG_SRCDIR([hello.c])                 用于指定源文件
    AC_CONGIF_HEADER([config.h])                用来创建config.h,它会把configure.ac中的被其它宏定义的宏以#define的形式集中到config.h中。
    AC_CONFIG_FILES([Makefile subdir/Makefile]) 声明了configure通过Makefile.ins需要生成的一系列Makefile文件。
    AC_OUTPUT                                   这是一个结束命令
    AC_OUTPUT([Makefile subdir/Makefile])       以上两条命令可以使用这一条命令替换
    AC_PROG_RANLIB                              多线程支持
    AC_CHECK_LIB([pthread], [main])             系统库检查
    AC_CHECK_EXTRA_OPTIONS                      用于自定义configure选项
  我们在使用automake时,实际上还需要用到其他的一些宏,但我们可以用aclocal 来帮我们自动产生。执行aclocal后我们会得到aclocal.m4文件。
  产生了configure.in和aclocal.m4 两个宏文件后,我们就可以使用autoconf来产生configure文件了。
    #有可能需要将AC_CONFIG_HEADER([config.h])修改为:AM_CONFIG_HEADER(config.h), 并加入AM_INIT_AUTOMAKE(hello,1.0)

6、 Makefile.am

  Makefile.am是用来生成Makefile.in的,需要你手工书写。Makefile.am中定义了一些内容:
    AUTOMAKE_OPTIONS                            这个是automake的选项。在执行automake时,它会检查目录下是否存在标准GNU软件包中应具备的各种文件,例如AUTHORS、ChangeLog、NEWS等文件。我们将其设置成foreign时,automake会改用一般软件包的标准来检查。
    SUBDIRS=subdir                              指定子目录

    bin_PROGRAMS                                指定我们所要产生的可执行文件的文件名。如果你要产生多个可执行文件,那么在各个名字间用空格隔开。
    #noinst_PROGRAMS                            不安装的可执行文件的文件名。
    helloworld_SOURCES                          指定产生"helloworld"时所需要的源代码。如果它用到了多个源文件,那么请使用空格符号将它们隔开。比如需要helloworld.h,helloworld.c那么请写成helloworld_SOURCES= helloworld.h helloworld.c。
    #helloworld_LDADD=libhello.a                指定链接库文件
    #helloworld_LDFLAGS = -lpthread             指定链接库文件选项
    #helloworld_LDFLAGS = -static hello.a       指定链接库文件选项
    #helloworld_DEPENDENCIES                    指定依赖文件

    AUTOMAKE_OPTIONS=foreign                
    noinst_LIBRARIES=libhello.a                 不安装的静态库文件
    #lib_LIBRARIES=libhello.a                   安装的静态库文件
    hello_a_SOURCES=hello.c hello.h             这个是指定库文件的源文件
    #hello_a_LDADD=                             指定链接库文件
    #hello_a_LDFLAGS=                           指定链接库文件选项

    INCLUDES=-I/usr/include/                    指定链接时头文件路径。
    include_HEADERS                             指定头文件
    data_DATA                                   指定头数据文件
    SUBDIRS                                     指定在处理本目录之前要先递归处理那些子目录
    EXTRA_DIST=hello.a                          用于添加除源码外的文件到dist包
    $(top_srcdir)                               工程最顶层目录,用于引用源程序
    $(top_builddir)                             目标文件最上层目录
    如果你在bin_PROGRAMS定义了多个可执行文件,则对应每个可执行文件都要定义相对的filename_SOURCES。

7、 automake

  我们使用automake,根据configure.in和Makefile.am来产生Makefile.in。
  选项--add-missing的定义是"add missing standard files to package",它会让automake加入一个标准的软件包所必须的一些文件。
  我们用automake产生出来的Makefile.in文件是符合GNU Makefile惯例的,接下来我们只要执行configure这个shell 脚本就可以产生合适的 Makefile 文件了。
  
8、 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,来确认编译不出现错误,最后提示你软件包已经准备好,可以发布了。
  make distclean                            类似make clean,但同时也将configure生成的文件全部删除掉,包括Makefile。