README.md


<!DOCTYPE html>
<html lang="en">
<head>
<title>Perl Documentation - www.cpan.org</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <link rel="author" href="mailto:cpan+linkrelauthor@perl.org" />
<link rel="canonical" href="https://www.cpan.org/doc/index.html" />
<link type="text/css" rel="stylesheet" href="../misc/css/cpan.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">


<script defer data-domain="cpan.org" src="https://cdn.perl.org/js/script.js"></script>

<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-PXE98NKGY2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'G-PXE98NKGY2');
</script>

</head>
<body class="section_docs">

<table id="wrapper" border="0" width="95%" cellspacing="0" cellpadding="2" align="center">
<tr>
<td id="header">

<div id="header_left">
<a href="../index.html"><img src="../misc/images/cpan.svg" id="logo" alt="CPAN" width="250" height="77" /></a>
</div>

<div id="header_right">
<h1>Comprehensive Perl Archive Network</h1>
<p id="strapline">You can never have too many Perl modules</p>
</div>
</td>
</tr>
<tr>
<td id="menubar_holder">

<ul class="menubar">
<li><a href="../index.html">Home</a></li>
<li><a href="../modules/index.html">Modules</a></li>
<li><a href="../ports/index.html">Ports</a></li>
<li><a href="../src/README.html">Perl Source</a></li>
<li><a href="../misc/cpan-faq.html">FAQ</a></li>
<li><a href="../SITES.html">Mirrors</a></li>
</ul>

<div id="searchbar">
<form method="get" action="https://metacpan.org/search" name="f" class="searchbox menubar" id="f">
<a href="https://metacpan.org/">Search</a>:
<input id="searchfield" type="text" name="q" value="" placeholder="Module name" />
<input type="submit" value="Search" />
</form>
</div>
</td>
</tr>
<tr>
<td>
<div id="content">



<h1>Perl Documentation</h1>

<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td>
<h2>
Perl Core and Module Documentation
</h2>
<ul>
<li>
<a href=
"https://perldoc.perl.org/">perldoc.perl.org</a> -
core
</li>
<li>
<a href=
"https://metacpan.org/">metacpan.org</a> -
modules
</li>
</ul>
<h2>
Command line
</h2>
<ul>
<li>
<code>perldoc perldoc</code> - find out more about
<code>perldoc</code>
</li>
<li>
<code>perldoc perlintro</code> - introduction to Perl
</li>
<li>
<code>perldoc Module::Name</code> - documentation for an
installed module
</li>
</ul>
</td>
<td>
<h2>
FAQs
</h2>
<ul>
<li>
<a href="https://learn.perl.org/faq/">Perl FAQ</a>
</li>
<li>
<a href="../misc/cpan-faq.html">CPAN FAQ</a>
</li>
</ul>
<h2>
Other useful sites
</h2>
<ul>
<li>
<a href="https://www.perl.org/">www.perl.org</a>
</li>
<li>
<a href="https://lists.perl.org/">lists.perl.org</a> -
mailing lists
</li>
<li>
<a href="https://learn.perl.org/">learn.perl.org</a>
</li>
</ul>
</td>
</tr>
</table>

</div>
</td>
</tr>
<tr>
<td id="footer">
<div id="footer_copyright">
<p>Yours Eclectically, The Self-Appointed Master Librarians (<i>OOK!</i>) of the CPAN.<br/>
&copy; 1995-2010 Jarkko Hietaniemi.
&copy; 2011-2024 <a href="https://www.perl.org">Perl.org</a>.
All rights reserved.
<a href="../disclaimer.html">Disclaimer</a>.
</p>
</div>


<div id="footer_mirror">
<p>Master mirror hosted by <a href="https://www.netactuate.com/"><img class="netactuate" alt="NetActuate"
height="49" width="149" src="../misc/images/netactuate.png" /></a>
and
<a href="https://www.fastly.com/"><img alt="Fastly" height="49" width="118"
src="../misc/images/fastly.png" /></a>
</p>
</div>



</td>
</tr>
</table>

</body>
</html>