podchecker

СОДЕРЖАНИЕ

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

НАЗВАНИЕ

podchecker - проверка синтаксиса файлов документации в формате POD

СИНТАКСИС

podchecker [-help] [-man] [-(no)warnings] [file...]

ПАРАМЕТРЫ И АРГУМЕНТЫ

-help

Выводит краткую справку и завершает работу.

-man

Выводит страницу руководства и завершает работу.

-warnings -nowarnings

Включает/выключает вывод предупреждений. Повторное указание -warnings увеличивает уровень предупреждений, т.е. выводится больше предупреждений. В настоящее время увеличение до уровня два приводит к выделению неэкранированных символов "<,>".

file

Путь к файлу POD для синтаксической проверки (по умолчанию - стандартный ввод).

ОПИСАНИЕ

podchecker будет читать указанные входные файлы, искать синтаксические ошибки в документации POD и выводить любые найденные ошибки в STDERR. В конце он выведет сообщение о статусе, указывающее количество найденных ошибок.

Директории игнорируются, выводится соответствующее сообщение об ошибке.

podchecker вызывает функцию podchecker(), экспортируемую Pod::Checker. Подробнее см. "podchecker()" в Pod::Checker.

ЗНАЧЕНИЕ ВОЗВРАЩАЕМОГО ЗНАЧЕНИЯ

podchecker возвращает код завершения 0 (ноль), если все указанные файлы POD корректны.

ОШИБКИ

podchecker возвращает код завершения 1, если хотя бы один из указанных файлов POD содержит синтаксические ошибки.

Код завершения 2 указывает, что хотя бы один из указанных файлов не содержит никаких команд POD.

Код завершения 1 имеет приоритет над кодом 2. Если вам нужны однозначные результаты, вызовите podchecker только с одним аргументом.

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

Pod::Simple и Pod::Checker

АВТОРЫ

Пожалуйста, сообщайте об ошибках с помощью http://rt.cpan.org.

Brad Appleton <bradapp@enteract.com>, Marek Rouchal <marekr@cpan.org>

Основано на коде для Pod::Text::pod2text(1), написанном Tom Christiansen <tchrist@mox.perl.com>