pod2man - онлайн в хмарі

ПРОГРАМА:

ІМ'Я

pod2man - Перетворення даних POD у форматований вхід *roff

СИНТАКСИС

pod2man [--центр=рядок] [--дата=рядок] [-- помилки=стиль]
[--виправлено=шрифт] [--виправлено жирним шрифтом=шрифт] [-- фіксована редакція=шрифт]
[-- фіксовано жирним курсивом=шрифт] [--ім'я=ім'я] [--nourls]
[-- офіційний] [--цитати=лапки] [--звільнення[=версія]]
[--розділ=manex] [--stderr] [--utf8] [-багатослівний]
[вхід [вихід] ...]

pod2man --допомога

ОПИС

pod2man є інтерфейсом для Pod::Man, який використовує його для створення *roff введення з джерела POD.
Отриманий код *roff підходить для відображення на терміналі за допомогою nroff(1), як правило
через людина(1) або друк за допомогою троф(1).

вхід є файлом для читання для джерела POD (POD можна вбудувати в код). Якщо вхід
не вказано, за замовчуванням має значення "STDIN". вихід, якщо вказано, це файл, у який потрібно записати
відформатований вихід. Якщо вихід не надано, відформатований вихід записується в "STDOUT".
Кілька файлів POD можна обробляти в одному pod2man виклик (збереження навантаження модуля і
час компіляції) шляхом надання кількох пар вхід та вихід файли в командному рядку.

--розділ, --звільнення, --центр, --дата та -- офіційний можна використовувати для встановлення заголовків і
колонтитули для використання; якщо не вказано, Pod::Man прийме різні значення за замовчуванням. Дивіться нижче або
Pod::Man для деталей.

pod2man передбачає, що ваші формати *roff мають шрифт фіксованої ширини під назвою "CW". Якщо ваш
називається по-іншому (наприклад, "CR"), використання --виправлено щоб уточнити це. Це взагалі тільки
питання для виведення трофів для друку. Аналогічно, ви можете встановити шрифти, які використовуються для жирного,
курсив і жирний курсив фіксованої ширини.

Окрім очевидних конверсій pod, Pod::Man і, отже, pod2man також піклуються про них
форматування func (), func(n) і прості посилання на змінні, такі як $foo або @bar, щоб ви цього не зробили
повинні використовувати для них екрани коду; складні вирази, як-от $fred{'stuff'}, все одно знадобляться
але втекти. Він також перекладає тире, які не використовуються як дефіси, на en
тире, робить довгі тире, наприклад, у правильні тире, виправляє "парні лапки" та
піклується про декілька інших специфічних для троффа налаштувань. Дивіться Pod::Man для повної інформації.

ВАРІАНТИ

-c рядок, --центр=рядок
Встановлює центрований верхній колонтитул сторінки на рядок. За замовчуванням — «Perl, який вносить користувач
Документація», але також див -- офіційний нижче.

-d рядок, --дата=рядок
Встановіть це значення для рядка лівого нижнього колонтитула. За замовчуванням дата зміни
буде використаний вхідний файл або поточна дата, якщо введення надходить із "STDIN", і буде
базуватися на UTC (тобто вихідні дані будуть відтворюватися незалежно від місцевого часу
зона).

- помилки=стиль
Встановіть стиль обробки помилок. "die" каже створити виняток для будь-якого форматування POD
помилка. "stderr" каже повідомляти про помилки стандартної помилки, але не викидати
виняток. "pod" каже, щоб включити розділ ПОМИЛКИ POD в результуючу документацію
підсумовуючи помилки. "none" ігнорує помилки POD повністю, наскільки це можливо.

За замовчуванням — «померти».

--виправлено=шрифт
Шрифт фіксованої ширини для дослівного тексту та коду. За замовчуванням встановлено "CW". Дещо
системам може знадобитися "CR". Має значення лише для троф(1) вихід.

--виправлено жирним шрифтом=шрифт
Жирний варіант шрифту фіксованої ширини. За замовчуванням "CB". Має значення лише для троф(1)
вихід.

-- фіксована редакція=шрифт
Курсивна версія шрифту з фіксованою шириною (насправді це щось неправильне, оскільки більшість
шрифти фіксованої ширини мають лише похилий варіант, а не курсив). За замовчуванням
"CI". Має значення лише для троф(1) вихід.

-- фіксовано жирним курсивом=шрифт
Жирний курсив (ймовірно, насправді косий) варіант шрифту фіксованої ширини. Pod::Людина
не передбачає, що у вас це є, і за замовчуванням має значення "CB". Деякі системи (наприклад, Solaris)
мати цей шрифт доступним як "CX". Має значення лише для троф(1) вихід.

-h, --допомога
Роздрукуйте інформацію про використання.

-l, --послаблений
Більше не використовується. pod2man використовується для перевірки його введених даних на дійсність як сторінка посібника, але
це має зробити зараз підчекер(1) замість цього. Прийнято для відставання
сумісність; ця опція більше нічого не робить.

-n ім'я, --ім'я=ім'я
Встановіть назву сторінки посібника на ім'я. Без цієї опції встановлюється назва вручну
до основної назви файлу, що перетворюється, у верхньому регістрі, якщо не розділ ручної роботи
3, у цьому випадку шлях аналізується, щоб перевірити, чи це шлях модуля Perl. Якщо так, а
шлях, наприклад ".../lib/Pod/Man.pm", перетворюється на ім'я, наприклад "Pod::Man". Цей варіант,
якщо вказано, перевизначає будь-яке автоматичне визначення імені.

Зауважте, що ця опція, ймовірно, не корисна під час конвертації кількох файлів POD на
один раз. Конвенція для сторінок керівництва Unix для команд полягає в тому, щоб заголовок сторінки мав бути
у верхньому регістрі, навіть якщо команда не є.

Під час перетворення джерела POD зі стандартного входу ця опція потрібна, оскільки є
інакше неможливо дізнатися, що використовувати як назву сторінки посібника.

--nourls
Зазвичай коди форматування L<> з URL-адресою, але прив’язним текстом форматуються так, щоб відображати обидва
текст прив’язки та URL-адреса. Іншими словами:

Лhttp://example.com/>

форматується як:

foohttp://example.com/>

Цей прапор, якщо вказано, пригнічує URL-адресу, коли надається текст прив’язки, тому цей приклад
буде відформатовано як просто "foo". Це може призвести до менш захаращеного результату у випадках
де URL-адреси не є особливо важливими.

-o, -- офіційний
Встановіть заголовок за замовчуванням, щоб вказати, що ця сторінка є частиною стандартного Perl
звільнити, якщо --центр також не дається.

-q лапки, --цитати=лапки
Встановлює лапки, які використовуються для оточування тексту C<> лапки. Якщо лапки є єдиним
символ, він використовується як ліва, так і права лапка; якщо лапки це два символи,
перший символ використовується як ліва лапка, а другий як правий; і
if лапки складається з чотирьох символів, перші два використовуються як ліві лапки, а другі
два як правильна цитата.

лапки також може бути встановлено спеціальне значення "none", і в цьому випадку немає лапок
додано навколо тексту C<> (але шрифт все ще змінено для виведення troff).

-r, --звільнення
Установіть центрований нижній колонтитул. За замовчуванням це версія Perl, яку ви використовуєте pod2man
під. Зауважте, що деякі системи, які встановлює макрос, припускають, що центрований нижній колонтитул буде a
дата модифікації та додасть щось на кшталт "Останнє змінене: "; якщо це те
ви можете встановити --звільнення до дати останньої зміни та --дата до
номер версії.

-s, --розділ
Встановіть розділ для макросу ".TH". Стандартна умова нумерації розділів полягає в тому
використовуйте 1 для команд користувача, 2 для системних викликів, 3 для функцій, 4 для пристроїв, 5 для
формати файлів, 6 для ігор, 7 для різної інформації та 8 для адміністратора
команди. Однак тут є багато варіацій; деякі системи (наприклад, Solaris) використовують
4 для форматів файлів, 5 для різної інформації та 7 для пристроїв. Ще інші
використовуйте 1 м замість 8 або деяку суміш обох. Приблизно єдині номери розділів, які є
надійно узгоджені 1, 2 і 3.

За замовчуванням буде використовуватися розділ 1, якщо в цьому випадку файл не закінчується на ".pm".
буде обрано розділ 3.

--stderr
За замовчуванням pod2man вмирає, якщо виявлено якісь помилки на вході POD. Якщо --stderr is
дано і ні -- помилки прапорець присутній, помилки надсилаються до стандартної помилки, але pod2man
не перериває. Це еквівалентно "--errors=stderr" і підтримується для зворотного
Сумісність.

-u, --utf8
За замовчуванням pod2man виробляє найбільш консервативний можливий вихід *roff
переконайтеся, що він працюватиме з якомога більшою кількістю різних реалізацій *roff.
Багато реалізацій *roff не можуть обробляти символи, відмінні від ASCII, тому це означає, що всі не-
Символи ASCII перетворюються або в керуючу послідовність *roff, яку намагаються створити
правильно наголошений символ (принаймні для виведення troff) або до "X".

Ця опція передбачає виведення літеральних символів UTF-8. Якщо ваш *roff
реалізація може впоратися з цим, це найкращий вихідний формат для використання, якого можна уникнути
пошкодження документів, що містять символи, відмінні від ASCII. Однак попереджаємо, що
*джерело roff з буквальними символами UTF-8 не підтримується багатьма реалізаціями
і навіть може призвести до помилок та інших видів поганої поведінки.

Майте на увазі, що при використанні цієї опції має бути введене кодування джерела POD
правильно оголошено, якщо це не US-ASCII або Latin-1. Вхід POD без "=кодування"
Передбачається, що команда написана на латинській мові-1, а якщо вона насправді в UTF-8, то вихід
буде подвійно закодовано. Побачити perlpod(1) для отримання додаткової інформації про "=кодування"
команда

-v, -багатослівний
Роздрукуйте назву кожного вихідного файлу під час його створення.

EXIT СТАТУС

Поки всі оброблені документи призводять до певного результату, навіть якщо цей результат містить
errata (розділ "ПОМИЛКИ POD" генерується за допомогою "--errors=pod"), pod2man вийде з
статус 0. Якщо будь-який з документів, що обробляються, не призводить до отримання вихідного документа,
pod2man вийде зі статусом 1. Якщо в документі POD є синтаксичні помилки
оброблено, а стиль обробки помилок встановлений за замовчуванням "die", pod2man перерве
негайно зі статусом виходу 255.

ДІАГНОСТИКА

If pod2man не вдається через помилки, див. Pod::Man і Pod::Simple, щоб дізнатися про що
ці помилки можуть означати.

ПРИКЛАДИ

program pod2man > програма.1
pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3
pod2man --section=7 note.pod > note.7

Якщо ви хочете безперервно роздруковувати багато сторінок керівництва, ви, ймовірно, захочете встановити
регістри C і D для встановлення безперервної нумерації сторінок і парних/непарних сторінок, щонайменше
деякі версії людина(7).

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

Щоб отримати записи індексу на "STDERR", увімкніть регістр F, як у:

troff -man -rF1 perl.1

Індексація просто виводить повідомлення через ".tm" для кожної основної сторінки, розділу, підрозділу,
item і будь-які директиви "X<>". Дивіться Pod::Man для більш детальної інформації.

Використовуйте pod2man онлайн за допомогою служб onworks.net