.TH doctext 1 "6/23/2019" " " ""
.SH "نام (NAME)"
doctext \- تولید صفحات راهنما و مستندات از کدهای C و Fortran
.SH "خلاصه دستور (SYNOPSIS)"
.nf
doctext [ -mpath path ] [ -ext n ] [ -I filename ] [ -latex ]
[ -html ] [ -index filename ] [ -indexdir filename ]
[ -jumpfile filename ] [ -outfile filename ]
[ -mapref filename ] [ -nolocation ] [ -location ]
[ -defn defnfile ] [ -dosnl ] [ -skipprefix name ]
[ -ignore string ] [ -oldargstyle ]
[ -heading string ] [ -basedir dirname ] filenames
[ -Wargdesc ] [ -Wnone ]
.fi

.SH "پارامترهای ورودی (INPUT PARAMETERS)"
.PD 0
.TP
.B -mpath path
مسیر ذخیره و نوشتن صفحات راهنما را تعیین می‌کند.
.PD 1
.PD 0
.TP
.B -ext n
پسوند فایل‌های خروجی را مشخص می‌کند (1-9، l و غیره).
.PD 1
.PD 0
.TP
.B -nolocation
از درج نام فایلی که اطلاعات صفحه راهنما از آن استخراج شده خودداری می‌کند.
.PD 1
.PD 0
.TP
.B -I filename
نام فایلی که شامل includeهای عمومی مورد نیاز این توابع است را مشخص می‌کند.
.PD 1
.PD 0
.TP
.B -latex
خروجی را به‌جای صفحات راهنما با قالب LaTeX تولید می‌کند.
.PD 1
.PD 0
.TP
.B -html
خروجی را به‌جای صفحات راهنما با قالب HTML (وب) تولید می‌کند.
.PD 1
.PD 0
.TP
.B -man
خروجی را با قالب صفحات راهنما (nroff) تولید می‌کند (پیش‌فرض).
.PD 1
.PD 0
.TP
.B -index filename
یک فایل فهرست مناسب برای tohtml تولید می‌کند (جهت تولید پرونده‌های وب).
.PD 1
.PD 0
.TP
.B -defn defnfilename
پس از بارگذاری دستورات پیش‌فرض، دستورات را از این فایل می‌خواند.
.PD 1
.PD 0
.TP
.B -mapref filename
پایگاه داده پیوندها (hyperlink) را خوانده و روی خروجی اعمال می‌کند.
.PD 1
.PD 0
.TP
.B -indexdir dirname
دایرکتوری ریشه را برای ورودی‌های فایل فهرست تنظیم می‌کند. برای مثال:
.PD 1
.br
         -index foo.cit -indexdir \\"http://www.mcs.anl.gov/foo/man\\"
.PD 0
.TP
.B -outfile filename
صفحات راهنما را در فایل مشخص‌شده قرار می‌دهد.
.PD 1
.PD 0
.TP
.B -heading name
نام سربرگ (بخش میانی سطر بالا) را تعیین می‌کند.
.PD 1
.PD 0
.TP
.B -quotefmt
از قالب‌های '\\\\tt' و `\\\\em` پشتیبانی می‌کند.
.PD 1
.PD 0
.TP
.B -oldargstyle
به‌جای استفاده از '+ .... -' برای فهرست آرگومان‌های چندتایی، استفاده از چندین '. ' را مجاز می‌کند.
.PD 1
.PD 0
.TP
.B -skipprefix name
عبارت 'name' را در ابتدای هر خط نادیده می‌گیرد. این گزینه برای کدهای منبع فرترن یا شل کاربرد دارد.
.PD 1
.PD 0
.TP
.B -ignore string
رشته مورد نظر را در ساختار تابع نادیده می‌گیرد. این گزینه برای حذف کلمات کلیدی خاص مورد نیاز در کامپایل روال که کاربر به آن‌ها نیاز ندارد کاربرد دارد (مانند کلمات کلیدی خاص export هنگام ساخت DLLها).
.PD 1
.PD 0
.TP
.B -keyword filename
ورودی‌های کلیدواژه را به انتهای فایل مشخص‌شده اضافه می‌کند.
.PD 1
.PD 0
.TP
.B -locdir directory
از دایرکتوری مشخص‌شده در فیلد Location: استفاده می‌کند.
.PD 1
.PD 0
.TP
.B -dosnl
فایل‌هایی با قالب DOS تولید می‌کند (return-newline به‌جای newline).
.PD 1
.PD 0
.TP
.B filenames
نام فایل‌هایی که مستندات باید از آن‌ها استخراج شوند.
.PD 1
.PD 0
.TP
.B -Wargdesc
درباره آرگومان‌های بدون توضیح هشدار می‌دهد.
.PD 1
.PD 0
.TP
.B -Wnone
نمایش هشدارها را غیرفعال می‌کند.
.PD 1

.SH "محل قرارگیری (LOCATION)"
doctext.cc