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>