pod2usage

СОДЕРЖАНИЕ

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

ИМЯ

pod2usage - вывод сообщений об использовании из встроенных под-документов в файлах

СИНТАКСИС

pod2usage

[-help] [-man] [-exitexitval] [-outputoutfile] [-verbose level] [-pathlist dirlist] [-formatter module] [-utf8] file

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

-help

Вывести краткое сообщение справки и завершить работу.

-man

Вывести страницу руководства для этой команды и завершить работу.

-exit exitval

Значение возвращаемого кода выхода.

-output outfile

Файл вывода. Если используются специальные имена «-» или «>&1» или «>&STDOUT», используется стандартный вывод. Если используется «>&2» или «>&STDERR», используется стандартный поток ошибок.

-verbose level

Требуемый уровень подробности:

1 : print SYNOPSIS only
2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
3 : print the entire manpage (similar to running pod2text)

-pathlist dirlist

Указывает один или несколько каталогов для поиска входного файла, если он не был передан с абсолютным путем. Каждый путь к каталогу в данном списке должен быть разделен двоеточием на Unix (точкой с запятой на MSWin32 и DOS).

-formatter module

Формат текста. По умолчанию Pod::Text, или для очень старых версий Perl Pod::PlainText. Альтернативой может быть, например, Pod::Text::Termcap.

-utf8

Этот параметр предполагает, что форматировщик (см. выше) понимает параметр «utf8». Он включает создание вывода utf8.

file

Путь к файлу, содержащему документацию под, которая должна быть выведена в формате сообщения об использовании. Если параметр опущен, читается стандартный ввод — но вывод форматируется с помощью Pod::Text, если не указан конкретный формат с помощью -formatter.

ОПИСАНИЕ

pod2usage прочитает указанный входной файл, ища документацию под, и выведет соответствующее сообщение об использовании. Если входной файл не указан, будет прочитан стандартный ввод.

pod2usage вызывает функцию pod2usage() в модуле Pod::Usage. См. "pod2usage()" в Pod::Usage.

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

Pod::Usage, pod2text, Pod::Text, Pod::Text::Termcap, perldoc

АВТОР

Отчеты об ошибках отправляйте на http://rt.cpan.org.

Brad Appleton <bradapp@enteract.com>

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