.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "STY2DTX 1" .TH STY2DTX 1 "2022-10-18" "perl v5.30.0" "مستندات پرل ارائه‌شده توسط کاربر" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh.SH "نام (NAME)" sty2dtx \- تبدیل فایل .sty لاتک به یک فایل .dtx مستندسازی‌شده .SH "نسخه (VERSION)" .IX Header "VERSION" نسخه: v2.4 \- 2022/10/18 .SH "پیوندها (LINKS)" .IX Header "LINKS" \&\s-1CTAN:\s0 https://ctan.org/pkg/sty2dtx .PP مخزن: https://github.com/MartinScharrer/sty2dtx .PP گزارش اشکالات: https://github.com/MartinScharrer/sty2dtx/issues .SH "کپی‌رایت و تکثیر (COPYRIGHT)" .IX Header "COPYRIGHT" حق نشر (c) 2010\-2022 Martin Scharrer .PP این برنامه یک نرم‌افزار آزاد است: شما می‌توانید آن را تحت شرایط «پروانه عمومی همگانی گنو» (\s-1GNU\s0 General Public License) همان‌طور که توسط بنیاد نرم‌افزارهای آزاد منتشر شده است، چه نسخه ۳ پروانه و چه (به انتخاب خودتان) هر نسخهٔ متأخرتری بازتوزیع کنید یا تغییر دهید. .PP این برنامه به این امید توزیع شده است که مفید واقع شود، اما \s-1بدون هرگونه ضمانت\s0؛ حتی بدون ضمانت ضمنی \s-1قابل فروش بودن\s0 یا \s-1تناسب برای یک هدف خاص\s0. برای جزئیات بیشتر به «پروانه عمومی همگانی \s-1GNU\s0» مراجعه کنید. .PP شما باید همراه با این برنامه یک نسخه از «پروانه عمومی همگانی \s-1GNU\s0» را دریافت کرده باشید. در غیر این صورت، را ببینید. .SH "توضیحات (DESCRIPTION)" .IX Header "DESCRIPTION" یک فایل .sty (بسته LaTeX) را با احاطه کردن تعریف‌های ماکرو درون محیط‌های 'macro' و 'macrocode'، به قالب .dtx (منبع مستندسازی‌شدهٔ LaTeX) تبدیل می‌کند. نام ماکرو به‌طور خودکار به عنوان یک آرگومان در محیط 'macro' وارد می‌شود. خطوط کد خارج از تعاریف ماکرو، تنها درون محیط‌های 'macrocode' قرار می‌گیرند. خطوط خالی حذف می‌شوند. این اسکریپت لزوماً خطاناپذیر و ۱۰۰٪ بی‌نقص طراحی نشده است، بلکه نقطهٔ شروع مناسبی برای تبدیل فایل‌های شیوه (style) فاقد مستندات به فایل‌های .dtx به شمار می‌رود. .SS "کاربرد پایه (Basic Usage)" .IX Subsection "Basic Usage" .Vb 1 \& perl sty2dtx.pl infile [infile ...] outfile .Ve .PP یا .PP .Vb 1 \& perl sty2dtx.pl < file.sty > file.dtx .Ve .SS "تعریف‌های پشتیبانی‌شده (Supported Definitions)" .IX Subsection "Supported Definitions" تعریف‌های ماکروی زیر زمانی که در آغاز یک خط باشند شناسایی می‌شوند (می‌توانند پیشوندهای \eglobal، \elong، \eprotected و/یا \eouter داشته باشند): .PP .Vb 8 \& \edef \eedef \egdef \exdef \& \enewcommand{\ename} \enewcommand*{\ename} \& \enewcommand\ename \enewcommand*\ename \& \erenewcommand{\ename} \erenewcommand*{\ename} \& \erenewcommand\ename \erenewcommand*\ename \& \eprovidecommand{\ename} \eprovidecommand*{\ename} \& \eprovidecommand\ename \eprovidecommand*\ename \& \e@namedef{\ename} \e@namedef\ename .Ve .PP تعریف‌های محیطی زیر زمانی که در ابتدای یک خط باشند شناسایی می‌شوند: .PP .Vb 1 \& \enewenvironment{name} \erenewenvironemnt{name} \eprovideenvironment{name} .Ve .PP تعریف ماکرو و محیط باید یا در همان خط پایان یابد یا به یک '\f(CW\*(C`}\*(C'\fR' به تنهایی در یک خط ختم شود. .SH "نحوه استفاده (USAGE)" .IX Header "USAGE" .Vb 1 \& sty2dtx [] [\-\-= ...] [\-\-] [] [] .Ve .SS "فایل‌ها (Files)" .IX Subsection "Files" .IP "\(bu" 2 می‌تواند برای \s-1STDIN\s0 یا \s-1STDOUT\s0 برابر با '\f(CW\*(C`\-\*(C'\fR' باشد، که در صورت تعیین نشدن هیچ فایلی، حالت پیش‌فرض است .IP "\(bu" 2 چندین فایل ورودی در یک فایل خروجی ادغام می‌شوند.SS "متغیرها (Variables)" .IX Subsection "Variables" متغیرها را می‌توان با استفاده از .PP .Vb 1 \& \-\-= .Ve .PP یا .PP .Vb 1 \& \-\- .Ve .PP تعریف کرد و برای جایگزینی‌ها در فایل الگو استفاده خواهند شد. .PP \fIمتغیرهای رایج:\fR .IX Subsection "Common variables:" .PP .Vb 4 \& author, email, maintainer, year (برای حق تکثیر), \& version, date, description (برای بسته/کلاس), \& type (یا پیش‌فرض \*(Aqpackage\*(Aq یا \*(Aqclass\*(Aq), \& filebase (تنظیم خودکار از روی نام فایل ورودی یا خروجی), .Ve .SS "گزینه‌ها (Options)" .IX Subsection "Options" .IP "\fB\-h\fR \ \ \ \ \ \ \ \ \ \ چاپ این متن راهنما" 8 .IX Item "-h چاپ این متن راهنما" .PD 0 .IP "\fB\-H\fR \ \ \ \ \ \ \ \ \ \ چاپ راهنمای گسترده" 8 .IX Item "-H چاپ راهنمای گسترده" .IP "\fB\-V\fR \ \ \ \ \ \ \ \ \ \ چاپ نسخه و حق تکثیر" 8 .IX Item "-V چاپ نسخه و حق تکثیر" .IP "\fB\-v\fR \ \ \ \ \ \ \ \ \ \ حالت پرگو (نمایش جزئیات بیشتر)" 8 .IX Item "-v حالت پرگو (نمایش جزئیات بیشتر)" .IP "\fB\-o\fR \fIoutput\fR \ \ \ استفاده از فایل داده‌شده به عنوان خروجی" 8 .IX Item "-o output استفاده از فایل داده‌شده به عنوان خروجی" .IP "\fB\-O\fR \ \ \ \ \ \ \ \ \ \ بازنویسی روی فایل(های) خروجی موجود" 8 .IX Item "-O بازنویسی روی فایل(های) خروجی موجود" .IP "\fB\-B\fR \ \ \ \ \ \ \ \ \ \ استفاده از نام پایه تک‌فایل ورودی برای فایل خروجی" 8 .IX Item "-B استفاده از نام پایه تک‌فایل ورودی برای فایل خروجی" .IP "\fB\-I\fR \ \ \ \ \ \ \ \ \ \ ایجاد فایل .ins (نصب) نیز علاوه بر خروجی" 8 .IX Item "-I ایجاد فایل .ins (نصب) نیز علاوه بر خروجی" .IP "\fB\-c\fR \ \ \ \ \ \ \ \ \ \ فقط استفاده از بخش کد (مانند v1.0)" 8 .IX Item "-c فقط استفاده از بخش کد (مانند v1.0)" .IP "\fB\-r\fR \ \ \ \ \ \ \ \ \ \ حذف محیط‌های موجود مانند \*(Aqmacro\*(Aq، \*(Aqmacrocode\*(Aq و غیره." 8 .IX Item "-r حذف محیط‌های موجود مانند 'macro'، 'macrocode' و غیره." .IP "\fB\-R\fR \ \ \ \ \ \ \ \ \ \ عدم حذف محیط‌های موجود مانند \*(Aqmacro\*(Aq، \*(Aqmacrocode\*(Aq و غیره." 8 .IX Item "-R عدم حذف محیط‌های موجود مانند 'macro'، 'macrocode' و غیره." .IP "\fB\-i\fR \fIins-file\fR \ ایجاد فایل .ins با نام داده‌شده" 8 .IX Item "-i ins-file ایجاد فایل .ins با نام داده‌شده" .IP "\fB\-t\fR \fItemplate\fR \ استفاده از این فایل به عنوان الگو به‌جای الگوی پیش‌فرض" 8 .IX Item "-t template استفاده از این فایل به عنوان الگو به‌جای الگوی پیش‌فرض" .IP "\fB\-T\fR \fItemplate\fR \ استفاده از این فایل به عنوان الگو برای فایل .ins" 8 .IX Item "-T template استفاده از این فایل به عنوان الگو برای فایل .ins" .IP "\fB\-e\fR \fIfile\fR \ \ \ \ \ برون‌ریزی الگوی پیش‌فرض .dtx در فایل و خروج" 8 .IX Item "-e file برون‌ریزی الگوی پیش‌فرض .dtx در فایل و خروج" .IP "\fB\-E\fR \fIfile\fR \ \ \ \ \ برون‌ریزی الگوی پیش‌فرض .ins در فایل و خروج" 8 .IX Item "-E file برون‌ریزی الگوی پیش‌فرض .ins در فایل و خروج" .IP "\fB\-D\fR \ \ \ \ \ \ \ \ \ \ استفاده از تاریخ جاری به عنوان تاریخ فایل" 8 .IX Item "-D استفاده از تاریخ جاری به عنوان تاریخ فایل" .IP "\fB\-F\fR \fIfile\fR \ \ \ \ \ خواندن گزینه‌ها و متغیرهای بیشتر از فایل." 8 .IX Item "-F file خواندن گزینه‌ها و متغیرهای بیشتر از فایل." .IP "\fB\-N\fR \ \ \ \ \ \ \ \ \ \ فایل پیکربندی پیش‌فرض خوانده نشود؛ باید نخستین گزینه باشد" 8 .IX Item "-N فایل پیکربندی پیش‌فرض خوانده نشود؛ باید نخستین گزینه باشد" .PD .SS "فایل‌های پیکربندی (Config files)" .IX Subsection "Config files" یک فایل پیکربندی پیش‌فرض با نام \*(Aqsty2dtx.cfg\*(Aq یا \*(Aq.sty2dtx.cfg\*(Aq به‌ترتیب در دایرکتوری جاری، دایرکتوری خانگی کاربر و دایرکتوری این اسکریپت جستجو می‌شود. نخستین فایل یافت‌شده بارگذاری می‌شود. اگر هیچ فایلی پیدا نشود، درخت \&\*(Aqtexmf\*(Aq برای یافتن فایل پیکربندی \*(Aqsty2dtx.cfg\*(Aq جستجو خواهد شد. همانند فایل‌های \-F، فایل پیکربندی باید در هر سطر شامل یک گزینه یا متغیر باشد. سطرهایی که با '\f(CW\*(C`%\*(C'\fR' یا '\f(CW\*(C`#\*(C'\fR' آغاز می‌شوند نادیده گرفته می‌شوند. .SH "مثال‌ها (EXAMPLES)" .IX Header "Examples" تولید \*(Aqfile.dtx\*(Aq از \*(Aqfile.sty\*(Aq: .PP .Vb 1 \& sty2dtx.pl < file.sty > file.dtx .Ve .PP یا .PP .Vb 1 \& sty2dtx.pl file.sty file.dtx .Ve .PP یا .PP .Vb 1 \& sty2dtx.pl \-B file.sty .Ve .PP تولید \*(Aqfile.dtx\*(Aq و \*(Aqfile.ins\*(Aq از \*(Aqfile.sty\*(Aq: .PP .Vb 1 \& sty2dtx.pl \-I file.sty file.dtx .Ve .PP یا .PP .Vb 1 \& sty2dtx.pl file.sty \-i file.sty file.dtx .Ve .PP یا .PP .Vb 1 \& sty2dtx.pl \-IB file.sty .Ve .PP تنظیم مقادیر سفارشی برای متغیرها: .PP .Vb 1 \& sty2dtx.pl \-\-author Me \-\-email me@there.com mypkg.sty mypkg.dtx .Ve .PP تولید فایل \s-1DTX\s0 برای یک کلاس: .PP .Vb 1 \& sty2dtx.pl \-\-type class mycls.sty mycls.dtx .Ve.SH "نویسنده (AUTHOR)" .IX Header "AUTHOR" Martin Scharrer .PP رایانامه: martin.scharrer@web.de .PP وبگاه: