NAME/НАИМЕНОВАНИЕ

perldoc - Perl-документация в POD-формате.

СИНТАКСИС

perldoc [-h] [-D] [-t] [-u] [-m] [-l] [-F]
    [-i] [-V] [-T] [-r]
    [-d файл_назначения]
    [-o название_формата]
    [-M названиеклассаформата]
    [-w параметрформатирования:значение]
    [-n nroff-аналог]
    [-X]
    [-L код_языка]
    ИмяСтраницы|НазваниеМодуля|НазваниеПрограммы|URL

Примеры:

perldoc -f BuiltinFunction

perldoc -L it -f ВстроеннаяФункция

perldoc -q FAQ КлючевоеСлово

perldoc -L ru -q FAQ КлючевоеСлово

perldoc -v ПеременнаяPerl

Подробная информация о параметрах командной строки ниже.

ОПИСАНИЕ

perldoc позволяет получить часть документации в .pod формате, которая встроена в дистрибутив perl или Perl-скрипты и доступна с помощью pod2man | nroff -man | $PAGER. (а также col -x для ОС HP-UX). В основном используется для получения документации по модулям Perl.

На вашей системе тоже могут быть установлены руководства по этим модулям. В этом случае вы можете пользоваться командой man(1).

Если вы ищете оглавление к библиотеке документаций модулей Perl, смотрите perltoc.

ПАРАМЕТРЫ

-h

Выводит справочную информацию по использованию (help).

-D

Описывает поиск элемента подробнее.

-t

Показывать документацию, используя текстовый конвертер (text), а не nroff. Возможно, это быстрей, но, вероятно, будет смотреться хуже.

-u

Игнорировать POD-форматирование и отобразить исходный код (Unformatted)

-m модуль

Показать содержимое модуля: код и не отформатированную POD-документацию. Это может быть полезно, если документация не достаточно объясняет работу функции и Вы хотите посмотреть непосредственно код; perldoc найдет файл для Вас и просто выведет содержимое.

-l

Отобразить только (only), если название модуля найдено.

-F

Рассматривает аргументы как имена файлов; поиск по каталогам производиться не будет.

-f perlfunc

Опция -f вместе с названием встроенной Perl-функции позволяет получить документацию по этой функции из perlfunc.

Пример:

perldoc -f sprintf

-q perlfaq-search-regexp

Опция -q задает регулярное выражение в качестве аргумента, которое позволяет найти вопрос (question) в FAQ по Perl [1-9] и вывести записи, удовлетворяющие этому выражению.

Пример:

perldoc -q shuffle

-v perlпеременная

Ключ -v с последующим названием Perl предопределенной переменной будет извлекать документацию этой переменной из perlvar.

Примеры:

perldoc -v '$"'
perldoc -v @+
perldoc -v DATA

-T

Это указывает, что вывод нужен не для отправки на страницу, но вывод можно получить непосредственно на стандартный вывод (STDOUT).

-d файл-назначения

Этот параметр позволяет сохранить вывод в файл, не выводя на страницу или в STDOUT. Example: perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap

-o название-формата-вывода

Используйте этот параметр, если вы хотите, чтобы Perldoc попытался использовать класс POD-форматирования в качестве выходного формата. Например: -oman. На самом деле, это обертка вокруг переключателя -M; используйте -oназвание-формата для загрузки класса, имя класса формируется добавлением названия формата в конец имени (без учета регистра).

Например, -oLaTeX пытается использовать следующие классы: Pod::Perldoc::ToLaTeX Pod::Perldoc::Tolatex Pod::Perldoc::ToLatex Pod::Perldoc::ToLATEX Pod::Simple::LaTeX Pod::Simple::latex Pod::Simple::Latex Pod::Simple::LATEX Pod::LaTeX Pod::latex Pod::Latex Pod::LATEX.

-M название-модуля

С помощью этого параметра можно указать модуль, с помощью которого Вы хотите форматировать POD-документацию. Класс должен содержать метод parse_from_file. Например: perldoc -MPod::Perldoc::ToChecker.

Вы можете указать несколько классов, разделив их запятыми или точкой с запятой, например: -MTk::SuperPod;Tk::Pod.

-w параметр:значение или -w параметр option

Этот параметр позволяет вызвать форматирование с параметрами. Например, -w textsize:15 вызовет $formatter->textsize(15) до использования объекта форматирования. Для корректного выполнения, необходимо чтобы класс форматирования содержал такой метод, как переданный параметр, и значение было верным. (Так если textsize ожидает целочисленное значение и передана строка -w textsize:big, то будут проблемы).

Вы можете использовать -w название-параметра (без значения) в качестве короткой записи -w название-параметра:TRUE. Предположительно, это удобно в переключателях да/нет таких, как: -w номер_страницы.

Можете использовать "=" вместо ":", т. е. -w textsize=15. Возможно, это намного удобней (или наоборот), все зависит от ваших предпочтений.

-X

Используйте индекс, если он присутствует. Если присутствует параметр -X, то будет использован индекс для поиска записи, чье имя совпадает с именем, полученным из командной строки в файле $config{archlib}/pod.idx. Файл pod.idx должен содержать подходящие имена файлов, по одному имени на строке.

-L код_языка

Этот параметр позволяет использовать перевод документации на том языке, которому соответствует код_языка. Если POD2::<код_языка<gt> не существует (или не установлен на вашей системе), то параметр игнорируется. Все существующие переводы доступны в пространстве имен POD2::*. Смотрите POD2::IT (или POD2::FR, или POD2::LT, или POD2::RU) в порядке появления и интеграции новой локализации POD2::* документации в Pod::Perldoc.

НазваниеСтраницы|НазваниеМодуля|НазваниеПрограммы|URL

Название того, чего хотите найти. Модули вида File::Basename могут быть определены как File::Basename или File/Basename. Также вы можете задать имя страницы документации, например С<perlfunc>. Для ссылок (URLs), HTTP и HTTPS являются единственным поддерживаемым видом.

Для простых имен, как 'foo', когда нормальный поиск не удался, также пытайтесь найти соответствующую страницу поиска с префиксом "perl" . Таким образом, "perldoc intro" достаточно, чтобы найти/сделать "perlintro.pod".

-n форматирование

Укажите замены для groff

-r

Рекурсивный поиск.

-i

Игнорировать регистр.

-V

Отображает версию Perldoc с которой вы работаете.

БЕЗОПАСНОСТЬ

Т. к. perldoc не запускается в tainted-режиме, существуют проблемы с безопасностью. Когда программа запускается из-под суперпользователя, она пытается удалить привилегии и сменить настоящий ID на неопределенный или на неопределенный аккаунт, если не получилось, то на -2. Если смена прав не удалась, то программа не запускается.

ОКРУЖЕНИЕ

Все параметры из переменной окружения PERLDOC будут использованы перед аргументами командной строки.

Полезные значения для PERLDOC включают -oman, -otext, -otk, -ortf, -oxml и так далее, в зависимости от имеющихся у вас модулей; или явно укажите класс определяющий форматирование с помощью -MPod::Perldoc::ToMan или подобного.

perldoc также ищет в директориях определённых в переменных окружения PERL5LIB (или PERLLIB, если PERL5LIB не определено) и PATH. (Последнее таково, что встроенная POD-документация для исполняемых файлов, таких как сам perldoc, доступна.)

В каталогах, где есть либо Makefile.PL либо Build.PL, perldoc добавляет . и lib первым его пути поиска, и до тех пор, пока суперпользователь не добавит blib тоже. Это очень полезно, если вы работаете внутри каталог сборки и хотите прочитать документацию, даже если у вас есть версия модулем, установленным ранее.

perldocбудет использовать пейджер, в порядке предпочтения, определённый в PERLDOC_PAGER, MANPAGER, или PAGER перед тем как попытается найти собственный. (MANPAGER не используется, если perldoc указывает отображать простой текст или не форматированный pod.)

Одно из полезных значений для PERLDOC_PAGER - это less -+C -E.

При установке в PERLDOCDEBUG положительного целого числа perldoc выводит более подробно, чем это делает ключ -D. Большее значение даёт больший вывод.

ИЗМЕНЕНИЯ

До 3.14_05, переключатель -v использовался для получения подробных сообщений из perldoc операции, которая теперь включен по -D.

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

perlpod, Pod::Perldoc

АВТОР

Текущий сопровождающий (maintainer): Mark Allen <mallen@cpan.org>

Прошлыми участниками являются: brian d foy <bdfoy@cpan.org> Adriano R. Ferreira <ferreira@cpan.org>, Sean M. Burke <sburke@cpan.org>, Kenneth Albanowski <kjahds@kjahds.com>, Andy Dougherty <doughera@lafcol.lafayette.edu>, и много других.

ПЕРЕВОДЧИКИ

• Николай Мишин <mishin@cpan.org>

• Анатолий Шарифулин <sharifulin@gmail.com>

• Алексей Суриков (Language) <KSURi>

• Михаил Любимов (Language) <mikhail.lyubimov>

• Дмитрий Константинов (Language) <Dim_K>

• Евгений Баранов (Language) <Baranov>

cpanm POD2::RU

perl -MCPAN -e shell
install POD2::RU