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 вместо него.

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

infile

--infile=name

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

outfile

--outfile=name

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

podroot

--podroot=name

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

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

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

nopoderrors

--nopoderrors

Не включать раздел "ОШИБКИ POD" в 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

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

noverbose

--noverbose

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

АВТОР

Tom Christiansen, <tchrist@perl.com>.

ОШИБКИ

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

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

perlpod, Pod::Html

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

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