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 принимает следующие аргументы:

help

--help

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

htmldir

--htmldir=name

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

Не используйте этот параметр и --htmlroot в одном вызове pod2html; они несовместимы.

htmlroot

--htmlroot=URL

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

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

Не передавайте этот параметр и --htmldir в pod2html; они несовместимы.

infile

--infile=name

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

outfile

--outfile=name

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

podroot

--podroot=name

Укажите базовый каталог для поиска подкаталогов с документацией.

podpath

--podpath=name:...:name

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

cachedir

--cachedir=name

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

flush

--flush

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

backlink

--backlink

Преобразует директивы =head1 в ссылки, ведущие к началу HTML-файла.

nobacklink

--nobacklink

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

header

--header

Создаёт заголовки и подвалы, содержащие текст раздела "ИМЯ".

noheader

--noheader

Не создавать заголовки и подвалы, содержащие текст раздела "ИМЯ" (по умолчанию).

poderrors

--poderrors

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

nopoderrors

--nopoderrors

Не включать раздел "ОШИБКИ ПОД" в outfile, если в infile были ошибки POD.

index

--index

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

noindex

--noindex

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

recurse

--recurse

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

norecurse

--norecurse

Не обрабатывать рекурсивно подкаталоги, указанные в podpath.

css

--css=URL

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

title

--title=title

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

quiet

--quiet

Не отображать предупреждающие сообщения.

noquiet

--noquiet

Отображать предупреждающие сообщения (по умолчанию). Однако это не то же самое, что режим "verbose".

verbose

--verbose

Отображать сообщения о ходе процесса.

noverbose

--noverbose

Не отображать сообщения о ходе процесса (по умолчанию).

АВТОР

Tom Christiansen, <tchrist@perl.com>.

ОШИБКИ

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

СМОТРИТЕ ТАКЖЕ

perlpod, Pod::Html

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

Эта программа распространяется на условиях Лицензии Artistic.