
=encoding utf8

=head1 НАИМЕНОВАНИЕ

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

=head1 СИНТАКСИС

    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

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

=head1 ОПИСАНИЕ

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

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

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

=head1 ПАРАМЕТРЫ

=over 5

=item B<-h>

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

=item B<-D>

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

=item B<-t>

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

=item B<-u>

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

=item B<-m> I<модуль>

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

=item B<-l>

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

=item B<-F>

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

=item B<-f> I<perlfunc>

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

Пример:

      perldoc -f sprintf


=item B<-q> I<perlfaq-search-regexp>

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

Пример:

     perldoc -q shuffle


=item B<-v> I<perlпеременная>

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

Примеры:

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


=item B<-T>

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

=item B<-d> I<файл-назначения>

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

=item B<-o> I<название-формата-вывода>

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

Например, C<-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.

=item B<-M> I<название-модуля>

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

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

=item B<-w> I<параметр:значение> или B<-w> I<параметр> I<option>

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

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

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

=item B<-X>

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

=item B<-L> I<код_языка>

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

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

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

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

=item B<-n> I<форматирование>

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

=item B<-r>

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

=item B<-i>

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

=item B<-V>

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

=back

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

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

=head1 ОКРУЖЕНИЕ

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

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

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

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

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

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

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


=head1 ИЗМЕНЕНИЯ

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

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

L<perlpod>, L<Pod::Perldoc>

=head1 АВТОР

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

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

=cut

=head1 ПЕРЕВОДЧИКИ

=over

=item * Николай Мишин  C<< <mishin@cpan.org> >>

=item * Анатолий Шарифулин  C<< <sharifulin@gmail.com> >>

=item * Алексей Суриков (Language) C<< <KSURi> >>

=item * Михаил Любимов (Language) C<< <mikhail.lyubimov> >>

=item * Дмитрий Константинов (Language) C<< <Dim_K> >>

=item * Евгений Баранов (Language) C<< <Baranov> >>

=back    
