نام (NAME)

apxs - ابزار ساخت و نصب افزونه‌های آپاچی (APache eXtenSion tool)

خلاصه دستور (SYNOPSIS)

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

apxs -q [ -v ] [ -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 ...

توضیحات (DESCRIPTION)

ابزار apxs ابزاری برای ساخت و نصب ماژول‌های افزونه برای سرور وب Apache HyperText Transfer Protocol (HTTP) است. این کار با ساخت یک شیء اشتراکی پویا (DSO) از یک یا چند files (فایل منبع یا شیء) انجام می‌شود که سپس می‌تواند در زمان اجرا از طریق دستورالعمل LoadModule مربوط به mod_so در سرور آپاچی بارگذاری شود.

بنابراین برای استفاده از این سازوکار افزونه، پلتفرم شما باید از ویژگی DSO پشتیبانی کند و فایل اجرایی httpd آپاچی شما باید به همراه ماژول mod_so کامپایل شده باشد. ابزار apxs در صورتی که چنین نباشد به طور خودکار هشدار می‌دهد. شما می‌توانید این مورد را با اجرای دستی دستور زیر بررسی کنید:

$ httpd -l

ماژول mod_so باید بخشی از فهرست نمایش داده شده باشد. اگر این پیش‌نیازها برآورده شده باشند، می‌توانید به راحتی قابلیت‌های سرور آپاچی خود را با نصب ماژول‌های خود با استفاده از سازوکار DSO و به کمک این ابزار apxs گسترش دهید:

$ 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 برای کامپایل استفاده می‌کند، در حالی که از فایل‌های شیء و آرشیو صرفاً برای مرحله پیوند (linking) بهره می‌برد. اما هنگام استفاده از چنین اشیاء پیش‌کامپایل‌شده‌ای، مطمئن شوید که آن‌ها برای کد مستقل از موقعیت (PIC) کامپایل شده باشند تا بتوان از آن‌ها برای یک شیء اشتراکی با بارگذاری پویا استفاده کرد. برای نمونه، در کامپایلر GCC همیشه کافی است از -fpic استفاده کنید. برای سایر کامپایلرهای C به صفحه راهنمای آن‌ها مراجعه کنید یا پرچم‌هایی را که apxs برای کامپایل فایل‌های شیء استفاده می‌کند بررسی نمایید.

برای جزئیات بیشتر درباره پشتیبانی از DSO در آپاچی، مستندات mod_so را مطالعه کنید یا شاید حتی فایل منبع src/modules/standard/mod_so.c را بخوانید.

گزینه‌ها (OPTIONS)

مثال‌ها (EXAMPLES)

فرض کنید یک ماژول آپاچی به نام mod_foo.c در دسترس دارید که قرار است عملکردهای سرور آپاچی را گسترش دهد. برای انجام این کار ابتدا باید با دستور زیر، کد منبع C را به یک شیء اشتراکی مناسب برای بارگذاری در زمان اجرای سرور آپاچی کامپایل کنید:

$ apxs -c mod_foo.c
/path/to/libtool --mode=compile gcc ... -c mod_foo.c
/path/to/libtool --mode=link gcc ... -o mod_foo.la mod_foo.slo
$ _

سپس باید پیکربندی آپاچی را با اطمینان از وجود یک دستورالعمل LoadModule برای بارگذاری این شیء اشتراکی به‌روزرسانی کنید. برای ساده‌سازی این مرحله، ابزار apxs روشی خودکار جهت نصب شیء اشتراکی در پوشه "modules" و به‌روزرسانی متناظر فایل httpd.conf ارائه می‌دهد. این کار با اجرای دستور زیر قابل انجام است:

$ apxs -i -a mod_foo.la
/path/to/instdso.sh mod_foo.la /path/to/apache/modules
/path/to/libtool --mode=install cp mod_foo.la /path/to/apache/modules
...
chmod 755 /path/to/apache/modules/mod_foo.so
[activating module `foo' in /path/to/apache/conf/httpd.conf]
$ _

به این ترتیب خطی با نام

LoadModule foo_module modules/mod_foo.so

در صورتی که در فایل پیکربندی وجود نداشته باشد، به آن اضافه می‌شود. اگر می‌خواهید این ماژول به صورت پیش‌فرض غیرفعال باشد، از گزینه -A استفاده کنید، یعنی:

$ apxs -i -A mod_foo.c

برای یک آزمایش سریع از سازوکار apxs، می‌توانید یک قالب نمونه ماژول آپاچی به همراه یک Makefile متناظر از طریق دستور زیر ایجاد کنید:

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

سپس می‌توانید بلافاصله این ماژول نمونه را در قالب یک شیء اشتراکی کامپایل کرده و در سرور آپاچی بارگذاری کنید:

$ cd foo
$ make all reload
apxs -c mod_foo.c
/path/to/libtool --mode=compile gcc ... -c mod_foo.c
/path/to/libtool --mode=link gcc ... -o mod_foo.la mod_foo.slo
apxs -i -a -n "foo" mod_foo.la
/path/to/instdso.sh mod_foo.la /path/to/apache/modules
/path/to/libtool --mode=install cp mod_foo.la /path/to/apache/modules
...
chmod 755 /path/to/apache/modules/mod_foo.so
[activating module `foo' in /path/to/apache/conf/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
$ _