نام (NAME)

pod2texi - تبدیل مستندات POD به قالب Texinfo

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

pod2texi [OPTION]... POD...

توضیحات (DESCRIPTION)

تبدیل فایل(های) Pod به Texinfo. دو حالت کلی برای این عملیات وجود دارد. نخست، به‌طور پیش‌فرض، هر فایل Pod به یک راهنمای مستقل Texinfo تبدیل می‌شود.

دوم، اگر مقدار "--base-level" بزرگ‌تر از 0 تنظیم شود، هر فایل Pod به فایلی مناسب برای @include تبدیل می‌شود، و یک فایل دیگر شامل یک منوی اصلی و تمام دستورات @include تولید می‌گردد.

گزینه‌ها (OPTIONS)

--appendix-sections

استفاده از دستورات بخش‌بندی پیوست (@appendix، ...) به‌جای دستورات پیش‌فرض شماره‌دار بخش‌بندی در Texinfo (@chapter، @section، ...).

--base-level=NUM|NAME

سطح دستورات "head1" را تنظیم می‌کند. این مقدار می‌تواند یک عدد صحیح یا یک دستور بخش‌بندی Texinfo (بدون "@") باشد: 1 متناظر با سطح @chapter/@unnumbered است، 2 متناظر با سطح @section است، و به همین ترتیب. مقدار پیش‌فرض 0 است، به این معنی که دستورات "head1" همچنان به صورت فصل‌ها در خروجی قرار می‌گیرند، اما خروجی به شکل یک راهنمای مستقل سازمان‌دهی می‌شود.

اگر سطح 0 نباشد، فایل Pod به صورت بخشی از یک راهنمای Texinfo رندر می‌شود که برای @include مناسب است. در این حالت، هر فایل Pod دارای یک دستور بخش‌بندی اضافی خواهد بود که کل فایل را در بر می‌گیرد و یک سطح بالاتر از مقدار "--base-level" قرار دارد. بنابراین، برای تبدیل هر فایل Pod به یک فصل در یک راهنمای بزرگ، باید از "section" به عنوان سطح پایه استفاده کنید.

برای مشاهده نمونه‌ای از ساخت Texinfo از روی مستندات خود Perl، به "contrib/perldoc-all" در توزیع سورس Texinfo مراجعه کنید.

--debug=NUM

تنظیم سطح اشکال‌زدایی روی NUM.

--generate-setfilename

تولید سطر @setfilename برای راهنماهای مستقل. می‌تواند با "--no-generate-setfilename" نفی (غیرفعال) شود. در صورتی که مقدار "--base-level" برابر 0 نباشد نادیده گرفته می‌شود.

--headings-as-sections

استفاده از دستورات سرعنوان (@heading، ...) به‌جای دستورات پیش‌فرض شماره‌دار بخش‌بندی در Texinfo (@chapter، @section، ...). دستور بخش‌بندیِ پوشش‌دهنده کل فایل که برای هر فایل Pod در صورت غیرصفر بودن --base-level خروجی داده می‌شود، یک دستور شماره‌دار است.

--help

نمایش راهنما و خروج.

--menus

خروجی دادن منوهای گره (node). در صورت وجود یک راهنمای اصلی، منوی گره Top آن همواره خروجی داده می‌شود، زیرا یک منوی اصلی (master menu) تولید می‌گردد. منوهای سایر گره‌ها در حالت پیش‌فرض در خروجی قرار نمی‌گیرند.

--outdir=NAME

اگر یک راهنمای اصلی به همراه فایل‌های include (که هر کدام متناظر با یک فایل Pod ورودی است) وجود داشته باشد، فایل‌های Texinfo تولیدشده در دایرکتوری NAME قرار می‌گیرند. مقدار پیش‌فرض بر اساس "--subdir" تعیین می‌شود.

--output=NAME

نام برای راهنمای اول، یا راهنمای اصلی در صورتی که راهنمای اصلی وجود داشته باشد. پیش‌فرض نوشتن در خروجی استاندارد است.

--no-section-nodes

استفاده از لنگرها (anchors) برای بخش‌ها به‌جای گره‌ها (nodes).

--no-fill-section-gaps

پر نکردن فاصله‌های بخش‌بندی با فایل‌های خالی @unnumbered. در حالت عادی، حفظ سلسله‌مراتب بخش‌بندی به همان شکل دست‌نخورده کار مناسبی است.

--preamble=STR

درج STR به عنوان مقدمه اولیه (top boilerplate) پیش از منو و includeها. اگر مقدار STR برابر "-" تنظیم شود، مقدمه اولیه از ورودی استاندارد خوانده می‌شود. مقدمه اولیه پیش‌فرض، یک شروع حداقلی برای یک سند Texinfo است.

--setfilename=STR

استفاده از STR در مقدمه اولیه پیش از منو و includeها برای دستور @setfilename در راهنمای اصلی، در صورتی که مقدار "--base-level" برابر 0 تنظیم نشده باشد. اگر "--base-level" برابر 0 باشد نادیده گرفته می‌شود. در حالت پیش‌فرض، هیچ @setfilename در خروجی برای راهنمای اصلی نوشته نمی‌شود.

--subdir=NAME

اگر یک راهنمای اصلی به همراه فایل‌های include (که هرکدام متناظر با یک فایل Pod ورودی است) وجود داشته باشد، آن فایل‌های include از دایرکتوری NAME گنجانده می‌شوند.

اگر "--outdir" تنظیم شده باشد، NAME باید به‌طور کلی روی مسیر دایرکتوری نسبی میان راهنمای اصلی و آرگومان "--outdir" تنظیم شود.

--unnumbered-sections

استفاده از دستورات بخش‌بندی بدون شماره (@unnumbered، ...) به‌جای دستورات پیش‌فرض شماره‌دار بخش‌بندی در Texinfo (@chapter، @section، ...).

--top=TOP

نام عنصر @top برای راهنمای اصلی. می‌تواند شامل کدهای Texinfo باشد.

--version

نمایش اطلاعات نسخه و خروج.

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

Pod::Simple::Texinfo. perlpod. راهنمای Texinfo. صفحه خانگی Texinfo: https://www.gnu.org/software/texinfo

حق نشر و مجوز (COPYRIGHT AND LICENSE)

حق نشر 2012-2026 Free Software Foundation, Inc.

این برنامه یک نرم‌افزار آزاد است؛ شما می‌توانید آن را تحت شرایط مجوز عمومی همگانی گنو (GNU General Public License) همان‌طور که توسط بنیاد نرم‌افزارهای آزاد منتشر شده است، بازتوزیع کرده یا تغییر دهید؛ چه نسخه ۳ این مجوز و چه (به انتخاب خودتان) هر نسخه بعدی آن.

هیچ تضمینی وجود ندارد (NO WARRANTY)، تا جایی که قانون اجازه می‌دهد.

نویسنده (AUTHOR)

Patrice Dumas <bug-texinfo@gnu.org>.