.TH dtxgen 1 "July 31, 2025" "dtxgen version 1.09" "DekDoc scripts"
.SH "نام (NAME)"

dtxgen \- تولید قالب برای پرونده‌های خوداستخراج‌کنندهٔ dtx. در LaTeX

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

.B dtxgen [options] basename.[sty,cls]

.SS "گزینه‌ها (Options)"

.B -h,--help
.RS
چاپ راهنمای کوتاه و خروج
.RE
.B -H,--Help
.RS
چاپ مستندات کامل از طریق less و خروج
.RE
.B -V
.RS
چاپ نسخه و خروج
.RE
.B -s,--short=X
.RS
تنظیم توضیح کوتاه و یک‌خطی بسته روی X
.RE
.B -v,--version=X
.RS
تنظیم نسخهٔ اولیه روی X.
.RE
.RS
پیش‌فرض: 1.00
.RE
.B -d,--date=X
.RS
تنظیم تاریخ نسخهٔ اولیه روی X.
.RE
.RS
پیش‌فرض: تاریخ جاری
.RE
.B -m,--mail=X
.RS
تنظیم نشانی رایانامهٔ شما روی X.
.RE
.RS
پیش‌فرض: $EMAIL
.RE
.B -n,--name=X
.RS
تنظیم نام شما روی X.
.RE
.RS
پیش‌فرض: $NAME
.RE
.B -c,--class=X
.RS
(تنها برای بسته‌های کلاس) تنظیم کلاسی که باید از پیش بارگذاری شود روی X.
.RE
.RS
پیش‌فرض: article
.RE
.B -f,--format=X
.RS
تنظیم قالب latex مورد استفاده برای کامپایل روی X.
.RE
.RS
پیش‌فرض: pdflatex
.RE
.B -b,--body=X
.RS
سبک یا کلاس موجود X برای استفاده به جای پیش‌نمایش
.RE
.B -i,--history
.RS
جایگزینی بخش استاندارد Change History با بخشی ساده‌تر.
.RE

.SH "توضیحات (DESCRIPTION)"
برنامهٔ dtxgen یک قالب برای پرونده‌های dtx. خوداستخراج‌کننده، بر اساس مدل شرح داده شده توسط Joseph Wright در (www.texdev.net\fI2009\fR10\fI06\fRa-model-dtx-file) ایجاد می‌کند. این برنامه برای کسانی که قصد ایجاد یک پروندهٔ منبع مستندسازی‌شدهٔ لاتک (.dtx یا Documented LaTeX Source) جدید دارند مفید است.

مثال کاربرد:

  dtxgen -n 'your name' -m 'your@email.ad' myclass.cls

این اسکریپت متغیرهایی مانند:
.IP ‣ 2
نام و نشانی رایانامهٔ نویسنده،
.IP ‣ 2
توضیحی کوتاه دربارهٔ کلاس یا بسته‌ای که از پروندهٔ dtx. تولید می‌شود،

.IP ‣ 2
یک تاریخ

.PP
را از متغیرهای محیطی یا از گزینه‌های خط فرمان دریافت کرده و در کنار موارد دیگر، قالبی برای پروندهٔ dtx. به همراه چند مثال کمینه ایجاد می‌کند. البته کاربر باید آن مثال‌ها را با کار واقعی خود جایگزین کند، اما تاریخ‌ها، نام پایه (basename)، نام نویسنده و نشانی رایانامه از پیش در جای خود قرار دارند و بسته به این که در آرگومان از پسوند cls. یا sty. استفاده کرده باشید، قالب‌بندی آن متناسب با پروندهٔ منبع یک کلاس یا بسته انجام می‌شود.

اگر در محیط خود نام و نشانی رایانامه‌تان را در متغیرهای NAME و EMAIL تعریف کرده باشید، می‌توانید به سادگی دستور زیر را اجرا کنید:

  dtxgen myclass.cls

و در نهایت پنج پرونده دریافت خواهید کرد: myclass.dtx، myclass.cls، myclass.pdf، README.md و Makefile.

.SH "گزینه‌ها (OPTIONS)"
دستور dtxgen گزینه‌های زیر را تشخیص می‌دهد:

.B -h,--help
.RS
اطلاعات راهنما را چاپ کرده و خارج می‌شود.
.RE
.B -H,--Help
.RS
مستندات کامل را از طریق less چاپ کرده و خارج می‌شود.
.RE
.B -V
.RS
نسخهٔ اسکریپت را چاپ کرده و خارج می‌شود.
.RE
-s,--short=X 	توضیحی کوتاه و یک‌خطی برای کلاس یا بسته. به‌طور پیش‌فرض، رشتهٔ /A new LaTeX class/ یا /A new LaTeX package/ استفاده خواهد شد.

-n,--name=X 	نام شما (نام کوچک و به دنبال آن نام خانوادگی). همچنین، می‌توانید یک مقدار پیش‌فرض در متغیر محیطی |NAME| تنظیم کنید؛ اگر چنین کنید و همچنان از این گزینه استفاده نمایید، مقدار این گزینه اولویت خواهد داشت.

-m,--mail=X نشانی رایانامهٔ شما. همچنین، می‌توانید یک مقدار پیش‌فرض در متغیر محیطی |EMAIL| تنظیم کنید؛ اگر چنین کنید و همچنان از این گزینه استفاده نمایید، مقدار این گزینه اولویت خواهد داشت.

-c,--class=X تنها برای قالب‌های کلاس: یک |\LoadClass{...}| درج می‌کند تا کلاس جدید با ویژگی‌های کلاس |...| آغاز شود. مقدار پیش‌فرض |article| است.

-v,--version=X تنظیم نسخهٔ اولیه؛ به‌طور پیش‌فرض از 1.00 استفاده خواهد شد.

-d,--date=X تنظیم تاریخ نسخهٔ اولیه. به‌طور پیش‌فرض، از تاریخ جاری استفاده خواهد شد. تاریخ باید در قالب |yyyymmdd| وارد شود، هرچند به شیوهٔ LaTeX ذخیره خواهد شد: |yyyy/mm/dd|.

-f,--format=X قالب Latex مورد استفاده برای کامپایل. پیش‌فرض pdflatex است، اما ممکن است به قالب دیگری مانند xelatex یا lualatex نیاز داشته باشید.

.B -i,--history
.RS
ایجاد بخش History به جای بخش استاندارد Change History. بخش استاندارد Change History امکان گزارش‌های بسیار مفصل را فراهم می‌کند، اما بیشتر افراد خود را به نکات کلی دربارهٔ تغییرات میان نسخه‌ها محدود می‌کنند که در یک بخش از سند ظاهر می‌شود. گزینهٔ \-\-history یک بخش تاریخچهٔ سرراست فراهم می‌کند که در محیط longtable قالب‌بندی شده است.
.RE

.SH Makefile
از Makefile می‌توان برای کامپایل نسخه‌های جدید کار خود استفاده کرد؛ این پرونده شامل هدف‌های (target) زیر است:

.B all
.RS
(پیش‌فرض) تولید پروندهٔ سبک یا کلاس،
.RE
.RS
مستندات pdf و یک پروندهٔ README.md.
.RE
.B distclean
.RS
حذف تمام پرونده‌هایی که امکان تولید مجدد آن‌ها وجود دارد،
.RE
.B clean
.RS
مشابه قبلی، به جز پروندهٔ سبک یا کلاس،
.RE
.RS
مستندات pdf و یک پروندهٔ README.md.
.RE
.B inst
.RS
نصب در درخت TeX کاربر،
.RE
.B install
.RS
نصب در درخت TeX محلی (از sudo استفاده می‌کند)
.RE
.B zip
.RS
تولید یک پروندهٔ zip آماده برای بارگذاری در CTAN
.RE

.SH "نویسندگان (AUTHORS)"
Wybo Dekker (wybodekker@me.com)

.SH "کپی‌رایت و تکثیر (COPYRIGHT)"
تحت مجوز عمومی همگانی گنو (GNU General Public License) منتشر شده است (www.gnu.org\fIcopyleft\fRgpl.html)