نام (NAME)

doxygen2man - ابزاری برای تولید صفحات راهنما از فایل‌های XML داکسیژن (Doxygen)

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

doxygen2man [گزینه‌ها] <فایل XML>

توضیحات (DESCRIPTION)

این ابزاری برای تولید صفحات راهنمای API از یک فایل سرآیند دارای توضیحات داکسیژن است. ابتدا داکسیژن را روی فایل اجرا کنید و سپس این برنامه را بر روی فایل XML اصلی تولیدشده و پوشه حاوی فایل‌های کمکی اجرا نمایید. سپس تعداد زیادی فایل صفحه راهنمای *.3 تولید خواهد شد که می‌توانید آن‌ها را همراه با کتابخانه خود عرضه کنید.

لازم است این برنامه را برای هر فایل .h در کتابخانه خود یک‌بار اجرا کنید، با استفاده از نام فایل .xml تولیدشده. این فایل معمولاً نامی شبیه به <include-file>_8h.xml خواهد داشت، مانند qbipcs_8h.xml

اگر خروجی HTML می‌خواهید، همانند هر صفحه راهنمای دیگری به سادگی از nroff روی فایل‌های تولیدشده استفاده کنید.

گزینه‌ها (OPTIONS)

-a

چاپ رونوشت اسکی (ASCII dump) صفحات راهنما در خروجی استاندارد

-m

نوشتن فایل‌های صفحه راهنما در <output dir>

-P

چاپ بخش PARAMS

-g

چاپ صفحه راهنمای عمومی برای کل فایل سرآیند

-s <n>

نوشتن صفحات راهنما در بخش <n> (پیش‌فرض: 3)

-p <package>

استفاده از نام بسته <package> (پیش‌فرض: <Package>)

-H <header>

تنظیم عنوان سرآیند (پیش‌فرض:

-I <include>

تنظیم نام فایل include (پیش‌فرض نام موجود در فایل XML یا unknown.h)

-i <prefix>

تنظیم پیشوند برای فایل‌های سرآیند (مانند qb/) چنانچه در یک زیرپوشه از /usr/include نصب شده باشند

-C <company>

تنظیم نام شرکت در حق نشر (پیش‌فرض: Red Hat)

-D <date>

تاریخ چاپ در بالای صفحات راهنما (فرمت بررسی نمی‌شود، پیش‌فرض: امروز)

-Y <year>

سال چاپ در انتهای خط حق نشر (پیش‌فرض: سال جاری)

-S <year>

سال چاپ در ابتدای خط حق نشر (پیش‌فرض: 2010)

-o <dir>

نوشتن تمامی صفحات راهنما در پوشه <dir> (پیش‌فرض: .)

-d <dir>

پوشه فایل‌های XML (پیش‌فرض: ./xml/)

-c

استفاده از خط حق نشر موجود در فایل سرآیند به عنوان خط حق نشر در صفحه راهنما. این قابلیت نیازمند آن است که doxygen2man به فایل .h اصلی دسترسی داشته باشد (گزینه -O را در زیر ببینید) و خط حق نشر دارای فرمت مشخصی باشد. این خط باید در ۱۰ خط اول فایل بوده و با متن " * Copyright" شروع شود. اگر این خط پیدا نشود، سال جاری یا سال تعیین‌شده با گزینه -Y استفاده خواهد شد.

-O

تعیین پوشه حاوی فایل‌های سرآیند اصلی. این گزینه (در حال حاضر) فقط توسط گزینه -c در بالا استفاده می‌شود.

-h

چاپ متن راهنمای استفاده

همچنین ببینید (SEE ALSO)

doxygen(1)

نویسنده (AUTHOR)

Christine Caulfield