نحوه استفاده (Usage)

pod2pdf [options] input.pod >output.pdf

اگر نام پرونده ورودی مشخص نشود، pod2pdf از ورودی استاندارد (STDIN) داده‌ها را می‌خواند؛ مانند:

perldoc -u File::Find | pod2pdf [options] >File-Find.pdf

گزینه‌ها (Options)

دستور pod2pdf گزینه‌های خط فرمان زیر را می‌پذیرد:

"--output-file"

نام پرونده خروجی را برای فایل PDF تولیدشده تعیین می‌کند. به‌طور پیش‌فرض، pod2pdf خروجی را به خروجی استاندارد (STDOUT) می‌فرستد.

"--page-size"

اندازه صفحه را برای استفاده در پرونده PDF تنظیم می‌کند؛ می‌تواند روی هر یک از اندازه‌های استاندارد کاغذ (A4، A5، Letter و غیره) تنظیم شود. مقدار پیش‌فرض A4 است.

"--page-orientation"

جهت صفحات را به‌صورت افقی (landscape) یا عمودی (portrait) کنترل می‌کند. مقدار پیش‌فرض 'portrait' است.

"--page-width", "--page-height"

عرض و ارتفاع صفحات تولیدشده را بر حسب پوینت (point) برای استفاده از اندازه‌های غیراستاندارد کاغذ تعیین می‌کند.

"--left-margin", "--right-margin", "--top-margin", "--bottom-margin"

امکان تنظیم جداگانه هر یک از حاشیه‌های صفحه (بالا، پایین، چپ و راست) را بر حسب پوینت فراهم می‌کند.

"--margins"

تمام حاشیه‌های صفحه را روی یک اندازه یکسان (مشخص‌شده بر حسب پوینت) تنظیم می‌کند.

"--header", "--noheader"

درج سرصفحه (شامل عنوان صفحه و برچسب زمانی و نشان اختیاری) در هر صفحه را کنترل می‌کند. این گزینه به‌طور پیش‌فرض فعال است، بنابراین برای غیرفعال کردن از "--noheader" استفاده کنید.

"--title"

عنوان صفحه را تنظیم می‌کند (به‌طور پیش‌فرض نام پرونده ورودی است).

"--timestamp"

گزینه دودویی (بولی) - در صورت تعیین، برچسب زمانی «آخرین تغییر» پرونده ورودی را در سرصفحه قرار می‌دهد.

"--icon"

نام پرونده نشانی که باید در گوشه بالا سمت چپ هر صفحه نمایش داده شود.

"--icon-scale"

مقدار مقیاس‌بندی برای نشان سرصفحه (پیش‌فرض 0.25 است).

"--footer", "--nofooter"

درج پانویس (شامل شماره صفحه فعلی و رشته متنی اختیاری) در هر صفحه را کنترل می‌کند. به‌طور پیش‌فرض پانویس درج می‌شود، بنابراین برای غیرفعال کردن از "--nofooter" استفاده کنید.

"--footer-text"

یک رشته متنی اختیاری برای پانویس تعیین می‌کند که در گوشه پایین سمت چپ هر صفحه قرار می‌گیرد.

"--version"

شماره نسخه را چاپ کرده و خارج می‌شود.

فایل‌های پیکربندی (Configuration files)

می‌توان مجموعه‌ای از گزینه‌های خط فرمان را در فایل‌های پیکربندی ذخیره کرد.

یک فایل پیکربندی شامل گزینه‌هایی با همان فرمت مورد استفاده توسط pod2pdf در خط فرمان است، به‌طوری که در هر خط فایل یک گزینه قرار می‌گیرد؛ مانند:

--page-size A5
--page-orientation landscape

برای استفاده از یک فایل پیکربندی، pod2pdf را همراه با گزینه "@/path/to/configfile.conf" فراخوانی کنید.

برای نمونه، اگر می‌خواهید همیشه نشان‌واره (لوگو) شرکت، برچسب زمانی و اعلان حق نشر (کپی‌رایت) را در پرونده‌های PDF خود بگنجانید، فایلی به نام mycompany.conf با محتوای زیر ایجاد کنید:

--icon "/path/to/your/logo.png"
--footer-text "Copyright 2007 MyCompany Limited"
--timestamp

سپس pod2pdf را به این صورت اجرا کنید:

pod2pdf @/path/to/mycompany.conf input.pod >output.pdf

اگر یک فایل پیکربندی به نام pod2pdf.conf ایجاد کرده و آن را در همان پوشه‌ای قرار دهید که اسکریپت pod2pdf در آن قرار دارد، به عنوان پیکربندی پیش‌فرض بارگذاری خواهد شد.