Perldoc

Perl comes with its own documentation. The most straightforward and widely preferred way to read it is by means of the perldoc command line utility. It will give access to specific perl manpages (e.g.: [doc://perlsyn] for Perl syntax or [doc://perlop] for Perl operators) as well as to the documentation for individual functions and faq entries: it supports a large number of command line switches that are described in its own documentation. To access the latter just issue the following command at your shell's prompt:

[doc://perldoc|perldoc perldoc]

For some tips about where to look for some particular information, see [brian_d_foy]'s [id://408254] [tutorials|tutorial].

To put it briefly, however, most times you will want to use perldoc as in one of the following examples:

• [doc://perldata|perldoc perldata] - to read about Perl data types;
• [doc://open|perldoc -f open] - to read about the open() function;
• perldoc -q "how do I do X" - to search the [doc://perlfaq|FAQ].

HTML

The language used by perldoc, [doc://perlpod|POD] makes it easy to render the documentation in a variety of target formats, including HTML. Some Perl distributions, most notably [http://www.activestate.com/|ActiveState]'s [http://www.activestate.com/Products/ActivePerl/|ActivePerl], a very popular one under Windows, come with ready made HTML documentation, wich some find easier to read and walk through.

An HTML version of the documentation is also available on the web at [http://perldoc.perl.org/] and some other locations. As such, it can be searched through with [http://www.google.com|Google] and the above mentioned [id://408254|tutorial] contains some specific examples about how to do so.

A [id://352893|POD Quick Reference] is also available here, at the [href://?|Monastery], which provides a categorized list of the most frequently used docs right in front of the reader for easy and intuitive access to them.

Grep

Some people prefer to use a [wp://grep] or grep-like utility to search specific stuff in the POD documentation installed on their computers, and one can indeed use such an approach when everything else fails.

Under *NIX osen or [http://www.cygwin.com/|cygwin], several grep-like utilities are generally availabe out of the box. Under Windows one can use ports from the [http://unxutils.sourceforge.net/|UNXUTILS] or [http://gnuwin32.sourceforge.net/|GnuWin32] collections.

Other options include:

• the pure Perl [wp://grep|tcgrep] [http://search.cpan.org/dist/ppt/bin/grep|implementation] from the [dist://ppt|Perl Power Tools] project;
• the specialized [http://search.cpan.org/dist/pmtools/podgrep|podgrep] utility from the [dist://pmtools] distribution;
• [zentara]'s [id://524324];
• [id://573020], which in turn borrows the pretty formatting of
• [petdance]'s [http://search.cpan.org/~petdance/ack/ack|ack].

Other options

One additional possibility is to use the [http://search.cpan.org/~ulpfr/perlindex-1.502/perlindex.PL|perlindex] utility, which is "a program to index and search the perl documentation."

The [http://search.cpan.org/dist/Tk-Pod/tkpod|tkpod] standalone [mod://Tk] POD viewer from [mod://Tk::Pod] (which is a GUI for viewing and browsing Perl's POD documentation) also provides an interface to perlindex if it is installed, and its features additionally include:

• support for single or multiple POD windows;
• tree view of available PODs.

Yet another alternative to perldoc is [mod://Pod::Webserver], a minimal web server which serves local Perl documentation: with it one can browse all the docs available on the machine it runs on with a web browser.