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.
pod2man | nroff -man | $PAGER
col -x
На вашей системе тоже могут быть установлены руководства по этим модулям. В этом случае вы можете пользоваться командой man(1).
Если вы ищете оглавление к библиотеке документаций модулей Perl, смотрите perltoc.
Выводит справочную информацию по использованию (help).
Описывает поиск элемента подробнее.
Показывать документацию, используя текстовый конвертер (text), а не nroff. Возможно, это быстрей, но, вероятно, будет смотреться хуже.
Игнорировать POD-форматирование и отобразить исходный код (Unformatted)
Показать содержимое модуля: код и неотформатированную POD-документацию. Это может быть полезно, если документация не достаточно объясняет работу функции и Вы хотите посмотреть непосредственно код; perldoc найдет файл для Вас и просто выведет содержимое.
Отобразить только (only), если название модуля найдено.
Рассматривает аргументы как имена файлов; поиск по каталогам производиться не будет.
Опция -f вместе с названием встроенной Perl-функции позволяет получить документацию по этой функции из perlfunc.
Пример:
perldoc -f sprintf
Опция -q задает регулярное выражение в качестве аргумента, которое позволяет найти вопрос (question) в FAQ по Perl [1-9] и вывести записи, удовлетворяющие этому выражению.
perldoc -q shuffle
Ключ -v с последующим названием Perl предопределенной переменной будет извлекать документацию этой переменной из perlvar.
perldoc -v '$"' perldoc -v @+ perldoc -v DATA
Это указывает, что вывод нужен не для отправки на страницу, но вывод можно получить непосредственно на стандартный вывод (STDOUT).
Этот параметр позволяет сохранить вывод в файл, не выводя на страницу или в STDOUT. Example: perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap
perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap
Используйте этот параметр, если вы хотите, чтобы Perldoc попытался использовать класс POD-форматирования в качестве выходного формата. Например: -oman. На самом деле, это обертка вокруг переключателя -M; используйте -oназвание-формата для загрузки класса, имя класса формируется добавлением названия формата в конец имени (без учета регистра).
-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.
-oLaTeX
С помощью этого параметра можно указать модуль, с помощью которого Вы хотите форматировать POD-документацию. Класс должен содержать метод parse_from_file. Например: perldoc -MPod::Perldoc::ToChecker.
parse_from_file
perldoc -MPod::Perldoc::ToChecker
Вы можете указать несколько классов, разделив их запятыми или точкой с запятой, например: -MTk::SuperPod;Tk::Pod.
-MTk::SuperPod;Tk::Pod
Этот параметр позволяет вызвать форматирование с параметрами. Например, -w textsize:15 вызовет $formatter->textsize(15) до использования объекта форматирования. Для корректного выполнения, необходимо чтобы класс форматирования содержал такой метод, как переданный параметр, и значение было верным. (Так если textsize ожидает целочисленное значение и передана строка -w textsize:big, то будут проблемы).
-w textsize:15
$formatter->textsize(15)
textsize
-w textsize:big
Вы можете использовать -w название-параметра (без значения) в качестве короткой записи -w название-параметра:TRUE. Предположительно, это удобно в переключателях да/нет таких, как: -w номер_страницы.
-w название-параметра
-w название-параметра:TRUE
-w номер_страницы
Можете использовать "=" вместо ":", т. е. -w textsize=15. Возможно, это намного удобней (или наоборот), все зависит от ваших предпочтений.
-w textsize=15
Используйте индекс, если он присутствует. Если присутствует параметр -X, то будет использован индекс для поиска записи, чье имя совпадает с именем, полученным из командной строки в файле $config{archlib}/pod.idx. Файл pod.idx должен содержать подходящие имена файлов, по одному имени на строке.
$config{archlib}/pod.idx
Этот параметр позволяет использовать перевод документации на том языке, которому соответствует код_языка. Если POD2::<код_языка<gt> не существует (или не установлен на вашей системе), то параметр игнорируется. Все существующие переводы доступны в пространстве имен POD2::*. Смотрите POD2::IT (или POD2::FR, или POD2::LT, или POD2::RU) в порядке появления и интеграции новой локализации POD2::* документации в Pod::Perldoc.
POD2::<код_языка<gt
POD2::*
Название того, чего хотите найти. Модули вида File::Basename могут быть определены как File::Basename или File/Basename. Также вы можете задать имя страницы документации, например С<perlfunc>. Для ссылок (URLs), HTTP и HTTPS являются единственным поддерживаемым видом.
File::Basename
File/Basename
Для простых имен, как 'foo', когда нормальный поиск не удался, также пытайтесь найти соответствующую страницу поиска с префиксом "perl" . Таким образом, "perldoc intro" достаточно, чтобы найти/сделать "perlintro.pod".
Укажите замены для groff
Рекурсивный поиск.
Игнорировать регистр.
Отображает версию Perldoc с которой вы работаете.
Т. к. perldoc не запускается в tainted-режиме, существуют проблемы с безопасностью. Когда программа запускается из-под суперпользователя, она пытается удалить привилегии и сменить настоящий ID на неопределенный или на неопределенный аккаунт, если не получилось, то на -2. Если смена прав не удалась, то программа не запускается.
Все параметры из переменной окружения PERLDOC будут использованы перед аргументами командной строки.
PERLDOC
Полезные значения для PERLDOC включают -oman, -otext, -otk, -ortf, -oxml и так далее, в зависимости от имеющихся у вас модулей; или явно укажите класс определяющий форматирование с помощью -MPod::Perldoc::ToMan или подобного.
-otext
-otk
-ortf
-oxml
-MPod::Perldoc::ToMan
perldoc также ищет в директориях определённых в переменных окружения PERL5LIB (или PERLLIB, если PERL5LIB не определено) и PATH. (Последнее таково, что встроенная POD-документация для исполняемых файлов, таких как сам perldoc, доступна.)
perldoc
PERL5LIB
PERLLIB
PATH
В каталогах, где есть либо Makefile.PL либо Build.PL, perldoc добавляет . и lib первым его пути поиска, и до тех пор, пока суперпользователь не добавит blib тоже. Это очень полезно, если вы работаете внутри каталог сборки и хотите прочитать документацию, даже если у вас есть версия модулем, установленным ранее.
Makefile.PL
Build.PL
.
lib
blib
perldocбудет использовать пейджер, в порядке предпочтения, определённый в PERLDOC_PAGER, MANPAGER, или PAGER перед тем как попытается найти собственный. (MANPAGER не используется, если perldoc указывает отображать простой текст или неформатированный pod.)
PERLDOC_PAGER
MANPAGER
PAGER
Одно из полезных значений для PERLDOC_PAGER - это less -+C -E.
less -+C -E
При установке в PERLDOCDEBUG положительного целого числа perldoc выводит более подробно, чем это делает ключ -D. Большее значение даёт больший вывод.
-D
До 3.14_05, переключатель -v использовался для получения подробных сообщений из perldoc операции, которая теперь включен по -D.
perlpod, Pod::Perldoc
Текущий сопровождающий (maintainer): Mark Allen <mallen@cpan.org>
<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>, и много других.
<bdfoy@cpan.org>
<ferreira@cpan.org>
<sburke@cpan.org>
<kjahds@kjahds.com>
<doughera@lafcol.lafayette.edu>
Николай Мишин <mishin@cpan.org>
<mishin@cpan.org>
Анатолий Шарифулин <sharifulin@gmail.com>
<sharifulin@gmail.com>
Алексей Суриков (Language) <KSURi>
<KSURi>
Михаил Любимов (Language) <mikhail.lyubimov>
<mikhail.lyubimov>
Дмитрий Константинов (Language) <Dim_K>
<Dim_K>
Евгений Баранов (Language) <Baranov>
<Baranov>
To install POD2::RU, copy and paste the appropriate command in to your terminal.
cpanm
cpanm POD2::RU
CPAN shell
perl -MCPAN -e shell install POD2::RU
For more information on module installation, please visit the detailed CPAN module installation guide.