pod2man - آنلاین در ابر

برنامه:

نام

pod2man - داده های POD را به ورودی *roff فرمت شده تبدیل کنید

خلاصه

pod2man [-- مرکز=رشته] [--تاریخ=رشته] [-- خطاها=سبک]
[--درست شد=فونت] [--fixedbold=فونت] [-- ثابت=فونت]
[--fixedbolditalic=فونت] [--نام=نام] [-- نورلز]
[-- رسمی] [-- نقل قول ها=نقل قول] [--رهایی[=نسخه]]
[--بخش=manext] [--stderr] [--utf8] [-- پرحرف]
[ورودی [تولید]...]

pod2man --کمک

شرح

pod2man یک جلویی برای Pod::Man است که از آن برای تولید *ورودی roff از منبع POD استفاده می کند.
کد *roff حاصل برای نمایش در ترمینال با استفاده از آن مناسب است ناگهان(1)، به طور معمول
از طريق مرد(1)، یا چاپ با استفاده از تپه(1).

ورودی فایلی است که باید برای منبع POD خوانده شود (POD را می توان در کد جاسازی کرد). اگر ورودی
داده نمی شود، به طور پیش فرض "STDIN" است. تولید، اگر داده شود، فایلی است که باید در آن نوشته شود
خروجی فرمت شده اگر تولید داده نمی شود، خروجی فرمت شده به "STDOUT" نوشته می شود.
چندین فایل POD را می توان در همان پردازش کرد pod2man فراخوانی (صرفه جویی در بار ماژول و
بار کامپایل) با ارائه چندین جفت از ورودی و تولید فایل های موجود در خط فرمان

--بخش, --رهایی, -- مرکز, --تاریخو -- رسمی می توان برای تنظیم هدرها و
پاورقی برای استفاده؛ اگر داده نشود، Pod::Man پیش فرض های مختلفی را در نظر می گیرد. زیر یا
Pod:: مرد برای جزئیات.

pod2man فرض می‌کند که فرمت‌کننده‌های *roff شما یک فونت با عرض ثابت به نام "CW" دارند. اگر مال شماست
چیز دیگری نامیده می شود (مانند "CR")، استفاده کنید --درست شد تا آن را مشخص کند. این به طور کلی فقط
برای خروجی troff برای چاپ اهمیت دارد. به طور مشابه، می توانید فونت های مورد استفاده را برای پررنگ تنظیم کنید،
مورب و خروجی با عرض ثابت مورب برجسته.

علاوه بر تبدیل‌های آشکار پاد، Pod::Man، و بنابراین pod2man نیز از آن مراقبت می‌کند
قالب بندی func()، func(n) و ارجاعات متغیر ساده مانند $foo یا @bar بنابراین شما این کار را نکنید
باید از کد فرار برای آنها استفاده کرد. عبارات پیچیده مانند $fred{'stuff'} همچنان نیاز دارند
گرچه برای فرار همچنین خط تیره هایی که به عنوان خط تیره استفاده نمی شوند را به en ترجمه می کند
خط تیره، خط تیره های بلند را - مانند این - به خط تیره های مناسب تبدیل می کند، "نقل های جفت شده" را اصلاح می کند، و
از چندین ترفند دیگر مخصوص troff مراقبت می کند. برای اطلاعات کامل به Pod::Man مراجعه کنید.

OPTIONS

-c رشته, -- مرکز=رشته
سرصفحه وسط صفحه را روی آن تنظیم می کند رشته. پیش فرض "User Contributed Perl" است
مستندات»، بلکه ببینید -- رسمی زیر کلیک کنید.

-d رشته, --تاریخ=رشته
رشته پاورقی سمت چپ را روی این مقدار تنظیم کنید. به طور پیش فرض، تاریخ اصلاح از
فایل ورودی استفاده خواهد شد، یا تاریخ فعلی اگر ورودی از "STDIN" باشد، و خواهد شد
بر اساس UTC باشد (به طوری که خروجی بدون توجه به زمان محلی قابل تکرار باشد
منطقه).

-خطاها=سبک
سبک رسیدگی به خطا را تنظیم کنید. "die" می گوید که برای هر قالب بندی POD یک استثنا ایجاد کنید
خطا "stderr" می گوید که خطاها را در مورد خطای استاندارد گزارش کنید، اما نه پرتاب کردن
استثنا. "pod" می گوید که یک بخش POD ERRORS را در مستندات به دست آمده شامل می شود
خلاصه کردن خطاها "none" تا حد امکان خطاهای POD را به طور کامل نادیده می گیرد.

پیش فرض "بمیر" است.

--درست شد=فونت
فونت با عرض ثابت برای استفاده برای متن و کد کلمه به کلمه. پیش‌فرض «CW» است. مقداری
سیستم ها ممکن است به جای آن "CR" را بخواهند. فقط برای تپه(1) خروجی

--fixedbold=فونت
نسخه پررنگ فونت با عرض ثابت. پیش‌فرض «CB». فقط برای تپه(1)
خروجی.

-- ثابت=فونت
نسخه کج از فونت با عرض ثابت (در واقع، چیزی شبیه به اشتباه، زیرا اکثر
فونت های با عرض ثابت فقط یک نسخه مایل دارند، نه یک نسخه کج). پیش فرض به
"CI". فقط برای تپه(1) خروجی

--fixedbolditalic=فونت
نسخه ایتالیک پررنگ (احتمالاً در واقع مایل) فونت با عرض ثابت. پاد::مرد
فرض نمی کند که شما این را دارید، و به طور پیش فرض روی "CB" است. برخی از سیستم ها (مانند سولاریس)
این فونت را به عنوان "CX" در دسترس داشته باشید. فقط برای تپه(1) خروجی

-h, --کمک
اطلاعات استفاده را چاپ کنید

-l, -- سست
دیگر استفاده نمی شود pod2man برای بررسی اعتبار ورودی آن به عنوان یک صفحه دستی استفاده می شود، اما
اکنون باید این کار توسط پادچکر(1) در عوض. برای عقب ماندگی پذیرفته شده است
سازگاری؛ این گزینه دیگر کاری نمی کند.

-n نام, --نام=نام
نام صفحه دستی را روی آن تنظیم کنید نام. بدون این گزینه، نام دستی تنظیم می شود
به نام پایه با حروف بزرگ فایل در حال تبدیل، مگر اینکه بخش دستی باشد
3، در این صورت مسیر تجزیه می شود تا ببینیم آیا مسیر ماژول Perl است یا خیر. اگر هست، الف
مسیری مانند ".../lib/Pod/Man.pm" به نامی مانند "Pod::Man" تبدیل می شود. این گزینه،
اگر داده شود، هر گونه تعیین خودکار نام را لغو می کند.

توجه داشته باشید که این گزینه احتمالاً هنگام تبدیل چندین فایل POD در آن مفید نیست
یک بار. قرارداد صفحات man یونیکس برای دستورات این است که عنوان صفحه man باشد
با حروف بزرگ حتی اگر دستور اینطور نباشد.

هنگام تبدیل منبع POD از ورودی استاندارد، این گزینه مورد نیاز است، زیرا وجود دارد
در غیر این صورت هیچ راهی برای دانستن اینکه از چه چیزی به عنوان نام صفحه راهنما استفاده کنید، وجود ندارد.

-- نورلز
به طور معمول، کدهای قالب بندی L<> با URL اما متن لنگر برای نمایش هر دو فرمت می شوند
متن لنگر و URL. به عبارت دیگر:

Lhttp://example.com/>

فرمت شده است به صورت:

فوhttp://example.com/>

این پرچم، اگر داده شود، URL را در هنگام ارائه متن لنگر حذف می کند، بنابراین این مثال
فقط به عنوان "foo" قالب بندی می شود. این می تواند خروجی به هم ریخته کمتری را در کیس ها ایجاد کند
جایی که URL ها اهمیت خاصی ندارند.

-o, -- رسمی
هدر پیش فرض را طوری تنظیم کنید که نشان دهد این صفحه بخشی از پرل استاندارد است
آزاد کردن، اگر -- مرکز نیز داده نمی شود.

-q نقل قول, -- نقل قول ها=نقل قول
گیومه های مورد استفاده برای احاطه متن C<> را روی آن تنظیم می کند نقل قول. اگر نقل قول مجرد است
کاراکتر، هم به عنوان نقل قول چپ و راست استفاده می شود. اگر نقل قول دو شخصیت است،
کاراکتر اول به عنوان نقل قول سمت چپ و کاراکتر دوم به عنوان نقل قول سمت راست استفاده می شود. و
if نقل قول چهار کاراکتر است، دو کاراکتر اول به عنوان نقل قول سمت چپ و دومی استفاده می شود
دو به عنوان نقل قول درست

نقل قول همچنین ممکن است روی مقدار ویژه "none" تنظیم شود، در این صورت هیچ علامت نقل قولی وجود ندارد
در اطراف متن C<> اضافه شده است (اما فونت هنوز برای خروجی troff تغییر می کند).

-r, --رهایی
پاورقی وسط را تنظیم کنید. به طور پیش فرض، این نسخه از Perl است که شما اجرا می کنید pod2man
زیر. توجه داشته باشید که برخی از مجموعه‌های ماکرو سیستم فرض می‌کنند که پاورقی در مرکز a خواهد بود
تاریخ اصلاح و چیزی شبیه "آخرین تغییر: "; اگر این است
مورد، ممکن است بخواهید تنظیم کنید --رهایی تا آخرین تاریخ اصلاح و --تاریخ به
شماره نسخه

-s, --بخش
بخش ماکرو ".TH" را تنظیم کنید. استاندارد شماره گذاری بخش به این است
از 1 برای دستورات کاربر، 2 برای تماس های سیستمی، 3 برای توابع، 4 برای دستگاه ها، 5 برای
فرمت فایل، 6 برای بازی، 7 برای اطلاعات متفرقه، و 8 برای مدیر
دستورات با این حال، در اینجا تنوع زیادی وجود دارد. برخی از سیستم ها (مانند سولاریس) استفاده می کنند
4 برای فرمت های فایل، 5 برای اطلاعات متفرقه، و 7 برای دستگاه ها. هنوز دیگران
از 1 متر به جای 8 یا ترکیبی از هر دو استفاده کنید. در مورد تنها شماره بخش هایی که هستند
به طور قابل اعتمادی 1، 2 و 3 سازگار هستند.

به‌طور پیش‌فرض، بخش 1 استفاده می‌شود مگر اینکه فایل به «.pm» ختم شود، در این صورت
بخش 3 انتخاب خواهد شد.

--stderr
به طور پیش فرض، pod2man اگر خطایی در ورودی POD شناسایی شود می میرد. اگر --stderr is
داده شده و خیر -- خطاها پرچم وجود دارد، خطاها به خطای استاندارد ارسال می شوند، اما pod2man
سقط نمی کند. این معادل "--errors=stderr" است و برای Backward پشتیبانی می شود
سازگاری.

-u, --utf8
به طور پیش فرض، pod2man محافظه کارانه ترین خروجی *roff ممکن را تولید می کند
اطمینان حاصل کنید که تا آنجا که ممکن است با پیاده سازی های مختلف *roff کار می کند.
بسیاری از پیاده سازی های *roff نمی توانند کاراکترهای غیر ASCII را مدیریت کنند، بنابراین این بدان معنی است که همه غیر
کاراکترهای ASCII یا به یک دنباله *roff escape تبدیل می شوند که سعی در ایجاد آن دارد
یک کاراکتر به درستی تاکید شده (حداقل برای خروجی تروف) یا به "X".

این گزینه می گوید به جای خروجی کاراکترهای UTF-8 تحت اللفظی. اگر *روف شماست
پیاده سازی می تواند آن را مدیریت کند، این بهترین فرمت خروجی برای استفاده و اجتناب است
خراب شدن اسناد حاوی کاراکترهای غیر ASCII با این حال، هشدار داده شود که
* منبع roff با کاراکترهای واقعی UTF-8 توسط بسیاری از پیاده سازی ها پشتیبانی نمی شود
و حتی ممکن است منجر به خطاها و سایر رفتارهای بد شود.

توجه داشته باشید که هنگام استفاده از این گزینه، کدگذاری ورودی منبع POD شما باید باشد
به درستی اعلام شود مگر اینکه US-ASCII یا Latin-1 باشد. ورودی POD بدون "=encoding"
فرمان به زبان لاتین-1 در نظر گرفته می شود و اگر واقعاً در UTF-8 باشد، خروجی
دو کدگذاری خواهد شد. دیدن perlpod(1) برای اطلاعات بیشتر در مورد "=encoding"
فرمان

-v, -- پرحرف
نام هر فایل خروجی را هنگام تولید چاپ کنید.

خروج وضعیت

تا زمانی که تمام اسناد پردازش شده به برخی از خروجی ها منجر شود، حتی اگر این خروجی شامل شود
خطا (بخش "خطاهای POD" ایجاد شده با "--errors=pod")، pod2man با خروج خواهد شد
وضعیت 0. اگر هر یک از اسناد در حال پردازش منجر به سند خروجی نشود،
pod2man با وضعیت 1 خارج می شود. اگر خطاهای نحوی در یک سند POD وجود داشته باشد
پردازش شده و سبک رسیدگی به خطا روی پیش‌فرض «Die» تنظیم می‌شود، pod2man سقط خواهد کرد
بلافاصله با وضعیت خروج 255.

عیب یابی

If pod2man با خطاها از کار می افتد، برای اطلاعات در مورد چه، به Pod::Man و Pod::Simple مراجعه کنید
این خطاها ممکن است به این معنی باشد.

مثال ها

برنامه pod2man > برنامه.1
pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3
pod2man --section=7 note.pod > note.7

اگر می خواهید به طور مداوم تعداد زیادی صفحه man را چاپ کنید، احتمالاً می خواهید تنظیم کنید
ثبت‌های C و D برای تنظیم شماره‌گذاری صفحات پیوسته و صفحه‌بندی زوج/فرد، حداقل در این حالت
برخی از نسخه های مرد(7).

troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...

برای دریافت ورودی های فهرست در "STDERR"، رجیستر F را روشن کنید، مانند:

troff -man -rF1 perl.1

نمایه سازی صرفاً پیام ها را از طریق ".tm" برای هر صفحه اصلی، بخش، زیربخش، خروجی می دهد.
مورد، و هر دستور "X<>". برای جزئیات بیشتر به Pod::Man مراجعه کنید.

با استفاده از خدمات onworks.net از pod2man به صورت آنلاین استفاده کنید