نام (NAME)

doctext - تولید صفحات راهنما و مستندات از کدهای C و Fortran

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

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 ]

پارامترهای ورودی (INPUT PARAMETERS)

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

محل قرارگیری (LOCATION)

doctext.cc