GNU Automake使用手册

需积分: 10 92 浏览量更新于2024-08-02 收藏 929KB PDF 举报

"automake.pdf 是一份关于 GNU Automake 的使用说明文档，适合学习 Automake 的初学者，提供了详细的 Automake 相关知识。" GNU Automake 是一个自动化工具，主要用于根据模板文件生成遵循 GNU 标准的 Makefile 文件。这个工具版本为 1.9.6，发布于2005年7月9日，由 David MacKenzie、Tom Tromey 和 Alexandre Duret-Lutz 编写。Automake 的设计目标是帮助开发者创建符合 GNU 规范的 Makefile，以便构建软件项目。 Automake 的工作原理是通过解析名为 `Makefile.am` 的模板文件，生成 `Makefile.in` 文件。`Makefile.am` 文件包含了用户定义的一系列 make 变量，这些变量定义了构建过程中的各种规则和配置。这些规则通常包括编译源代码、链接目标、处理依赖关系以及执行其他构建步骤。当 `automake` 工具处理 `Makefile.am` 文件后，生成的 `Makefile.in` 文件可以被 configure 脚本进一步处理，生成最终的 `Makefile`，供用户使用 `make` 命令来构建项目。在 Automake 中，用户可以定义如 `SRCS`（源文件列表）、`LIBS`（库文件）和 `bin_PROGRAMS`（二进制程序）等变量，Automake 会根据这些变量自动生成相应的构建规则。此外，Automake 还支持多语言编程，比如 C、C++、Fortran 等，并且能够处理库文件的创建，包括静态库和动态库。 Automake 还遵循了一些 GNU 的标准约定，例如 `configure.ac` 文件用于生成 configure 脚本，它检测系统特性并生成定制的 `config.h` 头文件。同时，Automake 支持国际化和本地化（i18n 和 l10n），使得软件可以支持多种语言。在实际使用 Automake 时，开发者需要理解以下关键概念： 1. `configure.ac`：这是配置脚本的源文件，包含了一系列宏和条件检查，用于生成 configure 脚本。 2. `Makefile.am`：这是用户定义构建规则的地方，包含了目标文件、依赖关系和其他构建指令。 3. `configure`：运行后生成的脚本，用于检查系统环境，生成 `config.h` 并设置构建选项。 4. `Makefile.in`：由 Automake 生成的中间文件，`configure` 脚本会将其转换为最终的 `Makefile`。 Automake 与其他工具如 Autoconf 和 Libtool 配合使用，可以提供一套完整的自动化构建系统，简化了跨平台软件的构建过程。通过遵循 GNU 的标准，Automake 确保了软件的可移植性和一致性。总结来说，Automake 是一个强大的工具，用于自动化生成符合 GNU 标准的 Makefile 文件，它简化了软件构建过程，特别是对于大型或复杂的项目，可以显著提高开发效率。通过理解和熟练使用 Automake，开发者能够更好地管理和维护其软件项目。

Chapter 5: Scanning ‘configure.ac’ 14

AC_CANONICAL_BUILD

AC_CANONICAL_HOST

AC_CANONICAL_TARGET

Automake will ensure that ‘config.guess’ and ‘config.sub’ exist. Also, the

‘Makefile’ variables build_triplet, host_triplet and target_triplet are

introduced. See section “Getting the Canonical System Type” in The Autoconf

Manual.

AC_LIBSOURCE

AC_LIBSOURCES

AC_LIBOBJ

Automake will automatically distribute any ﬁle listed in AC_LIBSOURCE or AC_

LIBSOURCES.

Note that the AC_LIBOBJ macro calls AC_LIBSOURCE. So if an Autoconf macro

is documented to call ‘AC_LIBOBJ([file])’, then ‘file.c’ will be distributed

automatically by Automake. This encompasses many macros like AC_FUNC_

ALLOCA, AC_FUNC_MEMCMP, AC_REPLACE_FUNCS, and others.

By the way, direct assignments to LIBOBJS are no longer supported. You should

always use AC_LIBOBJ for this purpose. See section “AC_LIBOBJ vs. LIBOBJS”

in The Autoconf Manual.

AC_PROG_RANLIB

This is required if any libraries are built in the package. See section “Particular

Program Checks” in The Autoconf Manual.

AC_PROG_CXX

This is required if any C++ source is included. See section “Particular Program

Checks” in The Autoconf Manual.

AC_PROG_F77

This is required if any Fortran 77 source is included. This macro is distributed

with Autoconf version 2.13 and later. See section “Particular Program Checks”

in The Autoconf Manual.

AC_F77_LIBRARY_LDFLAGS

This is required for programs and shared libraries that are a mixture of lan-

guages that include Fortran 77 (see Section 7.11.3 [Mixing Fortran 77 With C

and C++], page 50). See Section 5.6 [Autoconf macros supplied with Automake],

page 19.

AC_PROG_FC

This is required if any Fortran 90/95 source is included. This macro is dis-

tributed with Autoconf version 2.58 and later. See section “Particular Program

Checks” in The Autoconf Manual.

AC_PROG_LIBTOOL

Automake will turn on processing for libtool (see se ction “Introduction” in

The Libtool Manual).

Chapter 5: Scanning ‘configure.ac’ 15

AC_PROG_YACC

If a Yacc source ﬁle is seen, then you must either use this macro or deﬁne the

variable YACC in ‘configure.ac’. The former is preferred (see section “Partic-

ular Program Checks” in The Autoconf Manual).

AC_PROG_LEX

If a Lex source ﬁle is seen, then this macro must be used. See section “Particular

Program Checks” in The Autoconf Manual.

AC_SUBST The ﬁrst argument is automatically deﬁned as a variable in each generated

‘Makefile.in’. See section “Setting Output Variables” in The Autoconf Man-

ual.

If the Autoconf manual says that a macro calls AC_SUBST for var, or deﬁnes the

output variable var then var will be deﬁned in each ‘Makefile.in’ generated

by Automake. E.g. AC_PATH_XTRA deﬁnes X_CFLAGS and X_LIBS, so you can

use these variables in any ‘Makefile.am’ if AC_PATH_XTRA is called.

AM_C_PROTOTYPES

This is required when using automatic de-ANSI-ﬁcation; see Section 7.15

[ANSI], page 53.

AM_GNU_GETTEXT

This macro is required for packages that use GNU gettext (see Section 9.2

[gettext], page 61). It is distributed with gettext. If Automake sees this macro

it ensures that the package meets some of gettext’s requirements.

AM_MAINTAINER_MODE

This macro adds a ‘--enable-maintainer-mode’ option to configure. If this

is used, automake will cause “maintainer-only” rules to be turned oﬀ by default

in the generated ‘Makefile.in’s. This macro deﬁnes the MAINTAINER_MODE

conditional, which you can use in your own ‘Makefile.am’. See Section 26.2

[maintainer-mode], page 90.

m4_include

Files included by ‘configure.ac’ using this mac ro will be detected by Au-

tomake and automatically distributed. They will also appear as dependencies

in ‘Makefile’ rules.

m4_include is seldom used by ‘configure.ac’ authors, but can appear in

‘aclocal.m4’ when aclocal detects that some required macros come from ﬁles

local to your package (as opposed to macros installed in a system-wide directory,

see Section 5.3 [Invoking aclocal], page 15).

5.3 Auto-generating aclocal.m4

Automake includes a number of Autoconf macros that can be used in your package (see

Section 5.6 [Macros], page 19); some of them are actually required by Automake in certain

situations. These macros must be deﬁned in your ‘aclocal.m4’; otherwise they will not be

seen by autoconf.

The aclocal program will automatically generate ‘aclocal.m4’ ﬁles based on the con-

tents of ‘configure.ac’. This provides a convenient way to get Automake-provided macros,

Chapter 5: Scanning ‘configure.ac’ 16

without having to search around. The aclocal mechanism allows other packages to supply

their own macros (see Section 5.7 [Extending aclocal], page 21). You can also use it to

maintain your own set of custom macros (see Section 5.8 [Local Macros], page 23).

At startup, aclocal scans all the ‘.m4’ ﬁles it can ﬁnd, looking for macro deﬁnitions (see

Section 5.5 [Macro search path], page 17). Then it scans ‘configure.ac’. Any mention

of one of the macros found in the ﬁrst step causes that macro, and any mac ros it in turn

requires, to be put into ‘aclocal.m4’.

Putting the ﬁle that contains the macro deﬁnition into ‘aclocal.m4’ is usually done by

copying the entire text of this ﬁle, including unused macro deﬁnitions as well as both ‘#’

and ‘dnl’ comments. If you want to make a comment that will be completely ignored by

aclocal, use ‘##’ as the comment leader.

When a ﬁle selected by aclocal is located in a subdirectory speciﬁed as a relative

search path with aclocal’s ‘-I’ argume nt, aclocal assumes the ﬁle belongs to the package

and uses m4_include instead of copying it into ‘aclocal.m4’. This makes the package

smaller, eases dependency tracking, and cause the ﬁle to be distributed automatically. (See

Section 5.8 [Local Macros], page 23, for an example.) Any macro that is found in a system -

wide directory, or via an absolute search path will be copied. So use ‘-I ‘pwd‘/reldir’

instead of ‘-I reldir’ whenever some relative directory need to be considered outside the

package.

The contents of ‘acinclude.m4’, if this ﬁle exists, are also automatically included in

‘aclocal.m4’. We recommend against using ‘acinclude.m4’ in new packages (see Sec-

tion 5.8 [Local Macros], page 23).

While computing ‘aclocal.m4’, aclocal runs autom4te (see section “Using Autom4te”

in The Autoconf Manual) in order to trace the macros that are really used, and omit from

‘aclocal.m4’ all macros that are mentioned but otherwise unexpanded (this can happen

when a macro is called conditionally). autom4te is expected to be in the PATH, just as

autoconf. Its location can be ove rridden using the AUTOM4TE environment variable.

5.4 aclocal options

aclocal accepts the following options:

--acdir=dir

Look for the macro ﬁles in dir instead of the installation directory. This is

typically used for debugging.

--help Print a summary of the command line options and exit.

-I dir Add the directory dir to the list of directories searched for ‘.m4’ ﬁles.

--force Always overwrite the output ﬁle. The default is to overwrite the output ﬁle only

when really needed, i.e., when its c ontents changes or if one of its dependencies

is younger.

--output=file

Cause the output to be put into ﬁle instead of ‘aclocal.m4’.

Chapter 5: Scanning ‘configure.ac’ 17

--print-ac-dir

Prints the name of the directory that aclocal will search to ﬁnd third-party

‘.m4’ ﬁles. When this option is given, normal processing is suppressed. This

option can be used by a package to determine where to install a macro ﬁle.

--verbose

Print the names of the ﬁles it examines.

--version

Print the version number of Automake and exit.

5.5 Macro search path

By default, aclocal searches for ‘.m4’ ﬁles in the following directories, in this order:

acdir-APIVERSION

This is where the ‘.m4’ macros distributed with automake itself are stored.

APIVERSION depends on the automake release used; for automake 1.6.x,

APIVERSION = 1.6.

acdir This directory is intended for third party ‘.m4’ ﬁles, and is conﬁgured when

automake itself is built. This is ‘@datadir@/aclocal/’, which typically expands

to ‘${prefix}/share/aclocal/’. To ﬁnd the compiled-in value of acdir, use

the ‘--print-ac-dir’ option (see Section 5.4 [aclocal options], page 16).

As an example, suppose that automake-1.6.2 was conﬁgured with ‘--prefix=

/usr/local’. Then, the search path would be:

1. ‘/usr/local/share/aclocal-1.6/’

2. ‘/usr/local/share/aclocal/’

As explained in (see Section 5.4 [aclocal options], page 16), there are several options that

can be used to change or extend this search path.

5.5.1 Modifying the macro search path: --acdir

The most erroneous option to modify the search path is --acdir=dir , which changes de-

fault directory and drops the APIVERSION directory. For example, if one speciﬁes --

acdir=/opt/private/, then the search path becomes:

1. ‘/opt/private/’

This option, --acdir, is intended for use by the internal automake test suite only; it is

not ordinarily needed by end-users.

5.5.2 Modifying the macro search path: -I dir

Any extra directories speciﬁed using -I options (see Section 5.4 [aclo c al options], page 16)

are prepended to this search list. Thus, aclocal -I /foo -I /bar results in the following

search path:

1. ‘/foo’

2. ‘/bar’

3. acdir-APIVERSION

4. acdir

Chapter 5: Scanning ‘configure.ac’ 18

5.5.3 Modifying the macro search path: ‘dirlist’

There is a third me chanism for customizing the search path. If a ‘dirlist’ ﬁle exists in

acdir, then that ﬁle is assumed to contain a list of directories, one per line, to be added to

the search list. These directories are searched after all other directories.

For example, suppose ‘acdir/dirlist’ contains the following:

/test1

/test2

and that aclocal was called with the ‘-I /foo -I /bar’ options. Then, the se arch path

would be

1. /foo

2. /bar

3. acdir-APIVERSION

4. acdir

5. /test1

6. /test2

If the ‘--acdir=dir ’ option is used, then aclocal will search for the ‘dirlist’

ﬁle in dir. In the ‘--acdir=/opt/private/’ example above, aclocal would look for

‘/opt/private/dirlist’. Again, however, the ‘--acdir’ option is intended for use by the

internal automake test suite only; ‘--acdir’ is not ordinarily needed by end-users.

‘dirlist’ is useful in the following situation: suppose that automake version 1.6.2 is

installed with ‘--prefix=/usr’ by the system vendor. Thus, the default search directories

are

1. /usr/share/aclocal-1.6/

2. /usr/share/aclocal/

However, suppose further that many packages have been manually installed on the sys-

tem, with $preﬁx=/usr/local, as is typical. In that case, many of these “extra” ‘.m4’ ﬁles

are in ‘/usr/local/share/aclocal’. The only way to force ‘/usr/bin/aclocal’ to ﬁnd

these “extra” ‘.m4’ ﬁles is to always call ‘aclocal -I /usr/local/share/aclocal’. This

is inconvenient. With ‘dirlist’, one may create a ﬁle ‘/usr/share/aclocal/dirlist’

containing only the single line

/usr/local/share/aclocal

Now, the “default” search path on the aﬀected system is

1. /usr/share/aclocal-1.6/

2. /usr/share/aclocal/

3. /usr/local/share/aclocal/

without the need for ‘-I’ options; ‘-I’ options c an be reserved for project-speciﬁc needs

(‘my-source-dir/m4/’), rather than using it to work around local system-dependent tool

installation directories.

Similarly, ‘dirlist’ can be handy if you have installed a local c opy Automake on your

account and want aclocal to look for macros installed at other places on the system.

剩余143页未读，继续阅读

skyyuer21

粉丝: 0
资源: 1

GNU Automake使用手册

GNU-Automake-中文.pdf

轻松学automake.pdf

linux下的automake和autoconf.pdf

compiler.automake.allow.when.app.running找不到

idea gradle 热部署

idea javaweb项目热部署

automake升级

idea中springboot的热部署

springboot热部署时间怎么修改

最新资源