.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
.\" DO NOT EDIT! Generated from XML source.
.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "APXS" 1 "2026-04-30" "Apache HTTP Server" "apxs"

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

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

.PP
\fB\fBapxs\fR -\fBg\fR [ -\fBS\fR \fIname\fR=\fIvalue\fR ] -\fBn\fR \fImodname\fR\fR

.PP
\fB\fBapxs\fR -\fBq\fR [ -\fBv\fR ] [ -\fBS\fR \fIname\fR=\fIvalue\fR ] \fIquery\fR \&.\&.\&.\fR

.PP
\fB\fBapxs\fR -\fBc\fR [ -\fBS\fR \fIname\fR=\fIvalue\fR ] [ -\fBo\fR \fIdsofile\fR ] [ -\fBI\fR \fIincdir\fR ] [ -\fBD\fR \fIname\fR=\fIvalue\fR ] [ -\fBL\fR \fIlibdir\fR ] [ -\fBl\fR \fIlibname\fR ] [ -\fBWc,\fR\fIcompiler-flags\fR ] [ -\fBWl,\fR\fIlinker-flags\fR ] \fIfiles\fR \&.\&.\&.\fR

.PP
\fB\fBapxs\fR -\fBi\fR [ -\fBS\fR \fIname\fR=\fIvalue\fR ] [ -\fBn\fR \fImodname\fR ] [ -\fBa\fR ] [ -\fBA\fR ] \fIdso-file\fR \&.\&.\&.\fR

.PP
\fB\fBapxs\fR -\fBe\fR [ -\fBS\fR \fIname\fR=\fIvalue\fR ] [ -\fBn\fR \fImodname\fR ] [ -\fBa\fR ] [ -\fBA\fR ] \fIdso-file\fR \&.\&.\&.\fR


.SH "توضیحات (DESCRIPTION)"

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

.PP
بنابراین برای استفاده از این سازوکار افزونه، پلتفرم شما باید از ویژگی DSO پشتیبانی کند و فایل اجرایی \fBhttpd\fR آپاچی شما باید به همراه ماژول mod_so کامپایل شده باشد\&. ابزار \fBapxs\fR در صورتی که چنین نباشد به طور خودکار هشدار می‌دهد\&. شما می‌توانید این مورد را با اجرای دستی دستور زیر بررسی کنید:

.nf

$ httpd -l

.fi

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

.nf

$ 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
$ _

.fi

.PP
آرگومان‌های \fIfiles\fR می‌توانند هر فایل منبع C با پسوند (\&.c)، فایل شیء (\&.o) یا حتی یک آرشیو کتابخانه (\&.a) باشند\&. ابزار \fBapxs\fR این پسوندها را به طور خودکار شناسایی کرده و به صورت خودکار از فایل‌های منبع C برای کامپایل استفاده می‌کند، در حالی که از فایل‌های شیء و آرشیو صرفاً برای مرحله پیوند (linking) بهره می‌برد\&. اما هنگام استفاده از چنین اشیاء پیش‌کامپایل‌شده‌ای، مطمئن شوید که آن‌ها برای کد مستقل از موقعیت (PIC) کامپایل شده باشند تا بتوان از آن‌ها برای یک شیء اشتراکی با بارگذاری پویا استفاده کرد\&. برای نمونه، در کامپایلر GCC همیشه کافی است از \fB-fpic\fR استفاده کنید\&. برای سایر کامپایلرهای C به صفحه راهنمای آن‌ها مراجعه کنید یا پرچم‌هایی را که \fBapxs\fR برای کامپایل فایل‌های شیء استفاده می‌کند بررسی نمایید\&.

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


.SH "گزینه‌ها (OPTIONS)"

.SS "گزینه‌های عمومی (Common Options)"


.TP
\fB-n \fImodname\fR\fR
نام ماژول را صراحتاً برای گزینه‌های \fB-i\fR (نصب) و \fB-g\fR (تولید قالب) تنظیم می‌کند\&. از این گزینه برای مشخص کردن صریح نام ماژول استفاده کنید\&. برای گزینه \fB-g\fR این مورد الزامی است؛ برای گزینه \fB-i\fR ابزار \fBapxs\fR تلاش می‌کند نام را از روی منبع یا (به عنوان راهکار جایگزین) حداقل با حدس زدن از روی نام فایل تعیین کند\&.

.SS "گزینه‌های پرس‌وجو (Query Options)"


.TP
\fB-q\fR
پرس‌وجویی برای متغیرها و تنظیمات محیطی مورد استفاده در ساخت \fBhttpd\fR انجام می‌دهد\&. هنگامی که بدون پارامترهای \fIquery\fR فراخوانی شود، تمام متغیرهای شناخته‌شده و مقادیر آن‌ها را چاپ می‌کند\&. پارامتر اختیاری \fB-v\fR خروجی فهرست را قالب‌بندی می‌کند\&.
.PP
از این گزینه برای تعیین دستی تنظیمات مورد استفاده برای ساخت \fBhttpd\fR که ماژول شما را بارگذاری خواهد کرد استفاده کنید\&. برای نمونه، در صورت نیاز به دسترسی دستی به فایل‌های هدر C آپاچی، از عبارت زیر درون Makefileهای خود استفاده کنید:
.PP
INC=-I`apxs -q INCLUDEDIR`

.SS "گزینه‌های پیکربندی (Configuration Options)"


.TP
\fB-S \fIname\fR=\fIvalue\fR\fR
این گزینه تنظیمات apxs شرح‌داده‌شده در بالا را تغییر می‌دهد\&.

.SS "گزینه‌های تولید قالب (Template Generation Options)"


.TP
\fB-g\fR
یک زیرپوشه به نام \fIname\fR (گزینه \fB-n\fR را ببینید) و دو فایل در آن ایجاد می‌کند: یک فایل نمونه کد منبع ماژول به نام \fBmod_\fIname\fR\&.c\fR که می‌تواند به عنوان یک قالب برای ایجاد ماژول‌های خودتان یا به عنوان شروعی سریع برای آزمودن سازوکار apxs استفاده شود؛ و یک \fBMakefile\fR متناظر برای ساخت و نصب حتی ساده‌تر این ماژول\&.

.SS "گزینه‌های کامپایل DSO (DSO Compilation Options)"


.TP
\fB-c\fR
عملیات کامپایل را مشخص می‌کند\&. این گزینه ابتدا فایل‌های منبع C با پسوند (\&.c) در \fIfiles\fR را به فایل‌های شیء متناظر (\&.o) کامپایل کرده و سپس با پیوند دادن این فایل‌های شیء به همراه سایر فایل‌های شیء و آرشیو (\&.o و \&.a) در \fIfiles\fR، یک شیء اشتراکی پویا در \fIdsofile\fR می‌سازد\&. اگر گزینه \fB-o\fR مشخص نشده باشد، نام فایل خروجی از روی اولین نام فایل در \fIfiles\fR حدس زده می‌شود و بنابراین معمولاً به صورت پیش‌فرض \fBmod_\fIname\fR\&.so\fR خواهد بود\&.
.TP
\fB-o \fIdsofile\fR\fR
نام فایل شیء اشتراکی پویای ایجادشده را صراحتاً مشخص می‌کند\&. اگر مشخص نشود و نام از فهرست \fIfiles\fR قابل حدس نباشد، نام جایگزین \fBmod_unknown\&.so\fR استفاده می‌شود\&.
.TP
\fB-D \fIname\fR=\fIvalue\fR\fR
این گزینه مستقیماً به دستور(های) کامپایل ارسال می‌شود\&. از این گزینه برای افزودن ماکروها یا تعاریف دلخواه (defines) خود به فرآیند ساخت استفاده کنید\&.
.TP
\fB-I \fIincdir\fR\fR
این گزینه مستقیماً به دستور(های) کامپایل ارسال می‌شود\&. از این گزینه برای افزودن پوشه‌های include دلخواه خود جهت جستجو در فرآیند ساخت استفاده کنید\&.
.TP
\fB-L \fIlibdir\fR\fR
این گزینه مستقیماً به دستور پیونددهنده (linker) ارسال می‌شود\&. از این گزینه برای افزودن پوشه‌های کتابخانه دلخواه خود جهت جستجو در فرآیند ساخت استفاده کنید\&.
.TP
\fB-l \fIlibname\fR\fR
این گزینه مستقیماً به دستور پیونددهنده (linker) ارسال می‌شود\&. از این گزینه برای افزودن کتابخانه‌های دلخواه خود جهت جستجو در فرآیند ساخت استفاده کنید\&.
.TP
\fB-Wc,\fIcompiler-flags\fR\fR
این گزینه \fIcompiler-flags\fR را به عنوان پرچم‌های اضافی به دستور \fBlibtool --mode=compile\fR ارسال می‌کند\&. از این گزینه برای افزودن گزینه‌های خاص کامپایلر محلی استفاده کنید\&.
.TP
\fB-Wl,\fIlinker-flags\fR\fR
این گزینه \fIlinker-flags\fR را به عنوان پرچم‌های اضافی به دستور \fBlibtool --mode=link\fR ارسال می‌کند\&. از این گزینه برای افزودن گزینه‌های خاص پیونددهنده (linker) محلی استفاده کنید\&.
.TP
\fB-p\fR
این گزینه باعث می‌شود apxs پیوند را با کتابخانه‌های apr/apr-util برقرار کند\&. این قابلیت هنگام کامپایل برنامه‌های کمکی که از کتابخانه‌های apr/apr-util استفاده می‌کنند مفید است\&.

.SS "گزینه‌های نصب و پیکربندی DSO (DSO Installation and Configuration Options)"


.TP
\fB-i\fR
عملیات نصب را مشخص می‌کند و یک یا چند شیء اشتراکی پویا را در پوشه \fImodules\fR سرور نصب می‌نماید\&.
.TP
\fB-a\fR
ماژول را با افزودن خودکار یک خط متناظر LoadModule به فایل پیکربندی \fBhttpd\&.conf\fR آپاچی، یا با فعال کردن آن در صورت وجود، فعال می‌کند\&.
.TP
\fB-A\fR
مشابه گزینه \fB-a\fR است، اما در ابتدای دستورالعمل LoadModule ایجادشده یک علامت هش (\fB#\fR) قرار می‌گیرد؛ به این معنی که ماژول صرفاً برای فعال‌سازی بعدی آماده شده ولی در ابتدا غیرفعال است\&.
.TP
\fB-e\fR
عملیات ویرایش را مشخص می‌کند، که می‌تواند همراه با گزینه‌های \fB-a\fR و \fB-A\fR مشابه با عملیات \fB-i\fR جهت ویرایش فایل پیکربندی \fBhttpd\&.conf\fR آپاچی بدون تلاش برای نصب ماژول استفاده شود\&.

.SH "مثال‌ها (EXAMPLES)"

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

.nf

$ 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
$ _

.fi

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

.nf

$ 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]
$ _

.fi

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

.nf

LoadModule foo_module modules/mod_foo\&.so

.fi

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

.nf

$ apxs -i -A mod_foo\&.c

.fi

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

.nf

$ 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
$ _

.fi

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

.nf

$ 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
$ _

.fi