pod2html

СОДЕРЖАНИЕ

• НАЗВАНИЕ
• СИНОПСИС
• ОПИСАНИЕ
• АРГУМЕНТЫ
• АВТОР
• ОШИБКИ
• СМОТРИ ТАКЖЕ
• АВТОРСКИЕ ПРАВА

НАЗВАНИЕ

pod2html - конвертировать файлы .pod в .html файлы

СИНОПСИС

pod2html --help --htmldir=<name> --htmlroot=<URL>
         --infile=<name> --outfile=<name>
         --podpath=<name>:...:<name> --podroot=<name>
         --cachedir=<name> --flush --recurse --norecurse
         --quiet --noquiet --verbose --noverbose
         --index --noindex --backlink --nobacklink
         --header --noheader --poderrors --nopoderrors
         --css=<URL> --title=<name>

ОПИСАНИЕ

Преобразует файлы из формата pod (см. perlpod) в формат HTML.

АРГУМЕНТЫ

pod2html принимает следующие аргументы:

backlink

--backlink
--nobacklink

Преобразовать директивы =head1 в ссылки, указывающие на верхнюю часть HTML-файла. --nobacklink (по умолчанию) не создаёт эти обратные ссылки.

cachedir

--cachedir=name

Указывает каталог для хранения кэша. По умолчанию используется текущий рабочий каталог.

css

--css=URL

Указывает URL каскадной таблицы стилей, которую нужно связать с результирующим HTML-файлом. По умолчанию стиль отсутствует.

flush

--flush

Очистить кэш.

header

--header
--noheader

Создать заголовки и подвалы, содержащие текст раздела "НАЗВАНИЕ". --noheader (по умолчанию) не создаёт заголовков и подвалов.

help

--help

Отображает сообщение об использовании.

htmldir

--htmldir=name

Устанавливает каталог, относительно которого будут указываться все перекрёстные ссылки в результирующем HTML-файле. Если не передать этот параметр, все ссылки будут абсолютными, так как это значение указывает корень дерева документации для Pod::Html.

Не используйте его вместе с --htmlroot в одном вызове pod2html; они взаимоисключающие.

htmlroot

--htmlroot=URL

Устанавливает базовый URL для HTML-файлов. При создании перекрестных ссылок к URL добавляется HTML-корень.

Не используйте этот параметр, если нужны относительные ссылки: используйте --htmldir вместо него.

Не передавайте оба параметра --htmlroot и --htmldir в pod2html; они взаимоисключающие.

index

--index

Создать индекс в верхней части HTML-файла (по умолчанию).

noindex

--noindex

Не создавать индекс в верхней части HTML-файла.

infile

--infile=name

Указывает файл pod для преобразования. Входные данные берутся из стандартного ввода, если infile не указан.

outfile

--outfile=name

Указывает HTML-файл для создания. Выходные данные выводятся в стандартный вывод, если outfile не указан.

poderrors

--poderrors
--nopoderrors

Включить раздел "ОШИБКИ POD" в outfile, если в infile были ошибки POD (по умолчанию). --nopoderrors не создаёт этот раздел.

podpath

--podpath=name:...:name

Указывает подкаталоги podroot, содержащие файлы pod, чьи преобразованные в HTML формы могут быть связаны перекрёстными ссылками.

podroot

--podroot=name

Указывает базовый каталог для поиска библиографических pod.

quiet

--quiet
--noquiet

Не отображать в основном безобидные сообщения об ошибках. --noquiet (по умолчанию) отображает эти в основном безобидные сообщения об ошибках (но это не то же самое, что режим "verbose").

recurse

--recurse
--norecurse

Рекурсивно заходить в подкаталоги, указанные в podpath (по умолчанию). --norecurse не рекурсивно заходит в эти подкаталоги.

title

--title=title

Указывает заголовок результирующего HTML-файла.

verbose

--verbose
--noverbose

Отображать сообщения о ходе выполнения. --noverbose (по умолчанию) не отображает эти сообщения о ходе выполнения.

АВТОР

Tom Christiansen, <tchrist@perl.com>.

ОШИБКИ

См. Pod::Html для списка известных ошибок переводчика.

СМОТРИ ТАКЖЕ

perlpod, Pod::Html

АВТОРСКИЕ ПРАВА

Эта программа распространяется по лицензии Artistic License.