apxs - APache扩展工具

apxs是一个为Apache超文本传输协议(HTTP)服务器编译安装扩展模块的工具，用于编译一个或多个源程序或目标代码文件为动态共享对象，使之可以用mod_so中的LoadModule指令在运行时刻加载到Apache服务器中。

因此，要使用这个扩展机制，你的平台必须支持DSO特性，而且Apache的httpd必须内建了mod_so模块。 apxs工具能自动探测是否具备这样的条件，你也可以自己用这个命令手动探测

$ httpd -l

该命令的输出列表中应该有mod_so模块。如果所有这些条件均已具备，则可以很容易地借助apxs安装你自己的DSO模块以扩展Apache服务器的功能：

$ apxs -i -a -c mod_foo.c gcc -fpic -DSHARED_MODULE -I/path/to/apache/include -c mod_foo.c ld -Bshareable -o mod_foo.so mod_foo.o cp mod_foo.so /path/to/apache/modules/mod_foo.so chmod 755 /path/to/apache/modules/mod_foo.so [activating module `foo' in /path/to/apache/etc/httpd.conf] $ apachectl restart /path/to/apache/sbin/apachectl restart: httpd not running, trying to start [Tue Mar 31 11:27:55 1998] [debug] mod_so.c(303): loaded module foo_module /path/to/apache/sbin/apachectl restart: httpd started $ _

其中的参数files可以是任何C源程序文件(.c)或者目标代码文件(.o)，甚至是一个库(.a)。 apxs工具会根据其后缀自动编译C源程序，或连接目标代码和库。但是，使用预编译的目标代码时，必须保证它们是独立地址代码(position independent code [PIC])，使之能被动态地加载。如果使用GCC编译，则应该使用-fpic参数；如果使用其他C编译器，则应该查阅其手册，为apxs寻找相应的编译参数。

有关Apache对DSO的支持的详细信息，可以阅读mod_so的文档，或者直接阅读源程序src/modules/standard/mod_so.c。

概要
选项
举例

参见

概要

apxs -g [ -S name=value ] -n modname

apxs -q [ -S name=value ] query ...

apxs -c [ -S name=value ] [ -o dsofile ] [ -I incdir ] [ -D name=value ] [ -L libdir ] [ -l libname ] [ -Wc,compiler-flags ] [ -Wl,linker-flags ] files ...

apxs -i [ -S name=value ] [ -n modname ] [ -a ] [ -A ] dso-file ...

apxs -e [ -S name=value ] [ -n modname ] [ -a ] [ -A ] dso-file ...

选项

一般选项

-n modname: 它明确设置了-i(install)和-g (template generation)选项的模块名称。对-g选项，它是必须的；对-i选项，apxs工具会按文件名判断至少是推测出这个模块名称。

查询选项

-q: 查询某种apxs设置的信息。 query参数可以是下列一个或多个字串：CC, CFLAGS, CFLAGS_SHLIB, INCLUDEDIR, LD_SHLIB, LDFLAGS_SHLIB, LIBEXECDIR, LIBS_SHLIB, SBINDIR, SYSCONFDIR, TARGET.
这个参数用于手动查询某些设置。比如，要手动处理Apache的C头文件，可以在Makefile中使用

INC=-I`apxs -q INCLUDEDIR`

配置选项

-S name=value: 此选项可以改变apxs的上述设置。

模板生成选项

-g: 此选项生成一个名为name的子目录(见选项-n)和其中的两个文件：一个是名为mod_name.c的样板模块源程序，可以用作建立你自己的模块的模板，或是学习使用apxs机制的良好开端；另一个则是对应的Makefile，用于编译和安装此模块。

DSO编译选项

-c: 此选项表示需要执行编译操作。它首先会编译C源程序(.c)files为对应的目标代码文件(.o)，然后，连接这些目标代码和files中其余的目标代码文件(.o and .a)，以生成动态共享对象dsofile。如果没有指定-o选项，则此输出文件名由files中的第一个文件名推测得到，所以，缺省时，它一般会是mod_name.so.
-o dsofile: 明确指定所建立的动态共享对象的文件名。如果没有明确指定，而且也不能从files文件列表中推测得到，则其文件名将为mod_unknown.so。
-D name=value: 此选项定义直接提交给编译器的，以增加用于编译的变量。
-I incdir: 此选项定义直接提交给编译器的变量，以增加用于编译的你自己的头文件目录。
-L libdir: 此选项定义直接提交给编译器的变量，以增加用于编译的你自己的库文件目录。
-l libname: 此选项定义直接提交给编译器的变量，以增加用于编译的你自己的库文件。
-Wc,compiler-flags: 此选项用于附加编译参数compiler-flags到编译命令中，以增加编译器特有的参数。
-Wl,linker-flags: 此选项用于附加连接参数linker-flags到连接命令中，以增加连接器特有的参数。

DSO的安装和配置选项

-i: 此选项表示需要执行安装操作，以安装一个或多个动态共享对象到服务器的modules目录中。
-a: 此选项自动在httpd.conf文件中增加一个LoadModule行，以激活此模块，或者，如果此行已经存在，则启用之。
-A: 与-a选项类似，但是它增加的LoadModule指令由一个井号前缀(#)，即，此模块已经准备就绪，但尚处于禁用状态。
-e: 此选项表示需要执行编辑操作，它可以与-a和-A选项配合使用，与-i操作类似，修改Apache的httpd.conf配置文件，但是并不安装此模块。

举例

假设有一个扩展Apache服务器功能的Apache模块mod_foo.c，使用下列命令，可以编译C源程序为共享模块，以在运行时刻加载到Apache服务器中：

$ apxs -c mod_foo.c gcc -fpic -DSHARED_MODULE -I/path/to/apache/include -c mod_foo.c ld -Bshareable -o mod_foo.so mod_foo.o $ _

然后，必须修改Apache的配置，以确保有一个LoadModule指令来加载此共享对象。为了简化这一步骤，apxs可以自动进行该操作，以安装此共享对象到"modules"目录，并更新httpd.conf文件，命令如下：

$ apxs -i -a mod_foo.c cp mod_foo.so /path/to/apache/modules/mod_foo.so chmod 755 /path/to/apache/modules/mod_foo.so [activating module `foo' in /path/to/apache/etc/httpd.conf] $ _

如此，如果配置文件中尚不存在，会增加下列的行

LoadModule foo_module modules/mod_foo.so

如果你希望缺省时禁用此模块，可以使用-A选项，即

$ apxs -i -A mod_foo.c

要快速测试apxs机制，可以建立一个Apache模块样板及其对应的Makefile:

$ apxs -g -n foo Creating [DIR] foo Creating [FILE] foo/Makefile Creating [FILE] foo/mod_foo.c $ _

然后，立即可以编译此样板模块为共享对象并加载到Apache服务器中：

$ cd foo $ make all reload apxs -c mod_foo.c gcc -fpic -DSHARED_MODULE -I/path/to/apache/include -c mod_foo.c ld -Bshareable -o mod_foo.so mod_foo.o apxs -i -a -n "foo" mod_foo.so cp mod_foo.so /path/to/apache/modules/mod_foo.so chmod 755 /path/to/apache/modules/mod_foo.so [activating module `foo' in /path/to/apache/etc/httpd.conf] apachectl restart /path/to/apache/sbin/apachectl restart: httpd not running, trying to start [Tue Mar 31 11:27:55 1998] [debug] mod_so.c(303): loaded module foo_module /path/to/apache/sbin/apachectl restart: httpd started $ _

甚至还可以使用apxs在脱离Apache源代码树的情况下编译复杂模块，比如PHP3:

$ cd php3 $ ./configure --with-shared-apache=../apache-1.3 $ apxs -c -o libphp3.so mod_php3.c libmodphp3-so.a gcc -fpic -DSHARED_MODULE -I/tmp/apache/include -c mod_php3.c ld -Bshareable -o libphp3.so mod_php3.o libmodphp3-so.a $ _

由于apxs能自动识别C源程序文件和目标代码文件，所以，只有C源程序才会被编译，而其余的目标代码文件则用于连接操作中。