perldoc - Look up Perl documentation in pod format.

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>perldoc - Look up Perl documentation in pod format. - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/perldoc"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.6.2</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/perldoc">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/perldoc">5.40.1</a> <a class="dropdown-item" href="/5.40.0/perldoc">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/perldoc">5.38.3</a> <a class="dropdown-item" href="/5.38.2/perldoc">5.38.2</a> <a class="dropdown-item" href="/5.38.1/perldoc">5.38.1</a> <a class="dropdown-item" href="/5.38.0/perldoc">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/perldoc">5.36.3</a> <a class="dropdown-item" href="/5.36.2/perldoc">5.36.2</a> <a class="dropdown-item" href="/5.36.1/perldoc">5.36.1</a> <a class="dropdown-item" href="/5.36.0/perldoc">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/perldoc">5.34.3</a> <a class="dropdown-item" href="/5.34.2/perldoc">5.34.2</a> <a class="dropdown-item" href="/5.34.1/perldoc">5.34.1</a> <a class="dropdown-item" href="/5.34.0/perldoc">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/perldoc">5.32.1</a> <a class="dropdown-item" href="/5.32.0/perldoc">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/perldoc">5.30.3</a> <a class="dropdown-item" href="/5.30.2/perldoc">5.30.2</a> <a class="dropdown-item" href="/5.30.1/perldoc">5.30.1</a> <a class="dropdown-item" href="/5.30.0/perldoc">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/perldoc">5.28.3</a> <a class="dropdown-item" href="/5.28.2/perldoc">5.28.2</a> <a class="dropdown-item" href="/5.28.1/perldoc">5.28.1</a> <a class="dropdown-item" href="/5.28.0/perldoc">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/perldoc">5.26.3</a> <a class="dropdown-item" href="/5.26.2/perldoc">5.26.2</a> <a class="dropdown-item" href="/5.26.1/perldoc">5.26.1</a> <a class="dropdown-item" href="/5.26.0/perldoc">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/perldoc">5.24.4</a> <a class="dropdown-item" href="/5.24.3/perldoc">5.24.3</a> <a class="dropdown-item" href="/5.24.2/perldoc">5.24.2</a> <a class="dropdown-item" href="/5.24.1/perldoc">5.24.1</a> <a class="dropdown-item" href="/5.24.0/perldoc">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/perldoc">5.22.4</a> <a class="dropdown-item" href="/5.22.3/perldoc">5.22.3</a> <a class="dropdown-item" href="/5.22.2/perldoc">5.22.2</a> <a class="dropdown-item" href="/5.22.1/perldoc">5.22.1</a> <a class="dropdown-item" href="/5.22.0/perldoc">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/perldoc">5.20.3</a> <a class="dropdown-item" href="/5.20.2/perldoc">5.20.2</a> <a class="dropdown-item" href="/5.20.1/perldoc">5.20.1</a> <a class="dropdown-item" href="/5.20.0/perldoc">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/perldoc">5.18.4</a> <a class="dropdown-item" href="/5.18.3/perldoc">5.18.3</a> <a class="dropdown-item" href="/5.18.2/perldoc">5.18.2</a> <a class="dropdown-item" href="/5.18.1/perldoc">5.18.1</a> <a class="dropdown-item" href="/5.18.0/perldoc">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/perldoc">5.16.3</a> <a class="dropdown-item" href="/5.16.2/perldoc">5.16.2</a> <a class="dropdown-item" href="/5.16.1/perldoc">5.16.1</a> <a class="dropdown-item" href="/5.16.0/perldoc">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/perldoc">5.14.4</a> <a class="dropdown-item" href="/5.14.3/perldoc">5.14.3</a> <a class="dropdown-item" href="/5.14.2/perldoc">5.14.2</a> <a class="dropdown-item" href="/5.14.1/perldoc">5.14.1</a> <a class="dropdown-item" href="/5.14.0/perldoc">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/perldoc">5.12.5</a> <a class="dropdown-item" href="/5.12.4/perldoc">5.12.4</a> <a class="dropdown-item" href="/5.12.3/perldoc">5.12.3</a> <a class="dropdown-item" href="/5.12.2/perldoc">5.12.2</a> <a class="dropdown-item" href="/5.12.1/perldoc">5.12.1</a> <a class="dropdown-item" href="/5.12.0/perldoc">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/perldoc">5.10.1</a> <a class="dropdown-item" href="/5.10.0/perldoc">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/perldoc">5.8.9</a> <a class="dropdown-item" href="/5.8.8/perldoc">5.8.8</a> <a class="dropdown-item" href="/5.8.7/perldoc">5.8.7</a> <a class="dropdown-item" href="/5.8.6/perldoc">5.8.6</a> <a class="dropdown-item" href="/5.8.5/perldoc">5.8.5</a> <a class="dropdown-item" href="/5.8.4/perldoc">5.8.4</a> <a class="dropdown-item" href="/5.8.3/perldoc">5.8.3</a> <a class="dropdown-item" href="/5.8.2/perldoc">5.8.2</a> <a class="dropdown-item" href="/5.8.1/perldoc">5.8.1</a> <a class="dropdown-item" href="/5.8.0/perldoc">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item active" href="/5.6.2/perldoc">5.6.2</a> <a class="dropdown-item" href="/5.6.1/perldoc">5.6.1</a> <a class="dropdown-item" href="/5.6.0/perldoc">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/perldoc">5.005_04</a> <a class="dropdown-item" href="/5.005_03/perldoc">5.005_03</a> <a class="dropdown-item" href="/5.005_02/perldoc">5.005_02</a> <a class="dropdown-item" href="/5.005_01/perldoc">5.005_01</a> <a class="dropdown-item" href="/5.005/perldoc">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/perldoc">blead</a> <a class="dropdown-item" href="/5.41.9/perldoc">5.41.9</a> <a class="dropdown-item" href="/5.41.8/perldoc">5.41.8</a> <a class="dropdown-item" href="/5.41.7/perldoc">5.41.7</a> <a class="dropdown-item" href="/5.41.6/perldoc">5.41.6</a> <a class="dropdown-item" href="/5.41.5/perldoc">5.41.5</a> <a class="dropdown-item" href="/5.41.4/perldoc">5.41.4</a> <a class="dropdown-item" href="/5.41.3/perldoc">5.41.3</a> <a class="dropdown-item" href="/5.41.2/perldoc">5.41.2</a> <a class="dropdown-item" href="/5.41.1/perldoc">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/perldoc">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/perldoc">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/perldoc">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/perldoc">5.39.10</a> <a class="dropdown-item" href="/5.39.9/perldoc">5.39.9</a> <a class="dropdown-item" href="/5.39.8/perldoc">5.39.8</a> <a class="dropdown-item" href="/5.39.7/perldoc">5.39.7</a> <a class="dropdown-item" href="/5.39.6/perldoc">5.39.6</a> <a class="dropdown-item" href="/5.39.5/perldoc">5.39.5</a> <a class="dropdown-item" href="/5.39.4/perldoc">5.39.4</a> <a class="dropdown-item" href="/5.39.3/perldoc">5.39.3</a> <a class="dropdown-item" href="/5.39.2/perldoc">5.39.2</a> <a class="dropdown-item" href="/5.39.1/perldoc">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/perldoc">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.6.2/perl">Perl</a> <a class="dropdown-item" href="/5.6.2/perlintro">Intro</a> <a class="dropdown-item" href="/5.6.2/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.6.2/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.6.2/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/perlop">Operators</a> <a class="dropdown-item" href="/5.6.2/functions">Functions</a> <a class="dropdown-item" href="/5.6.2/variables">Variables</a> <a class="dropdown-item" href="/5.6.2/modules">Modules</a> <a class="dropdown-item" href="/5.6.2/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.6.2/perlcommunity">Community</a> <a class="dropdown-item" href="/5.6.2/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.6.2/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.6.2/perldoc">perldoc</a> <div id="more"> (<a href="/5.6.2/perldoc.txt">source</a>, <a href="https://metacpan.org/pod/perldoc">CPAN</a>) </div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.6.2. <a href="/perldoc">View the latest version</a> </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#OPTIONS">OPTIONS</a> </li> <li> <a class="text-decoration-none" href="#ENVIRONMENT">ENVIRONMENT</a> </li> <li> <a class="text-decoration-none" href="#VERSION">VERSION</a> </li> <li> <a class="text-decoration-none" href="#AUTHOR">AUTHOR</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>perldoc - Look up Perl documentation in pod format.</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <p><b>perldoc</b> [<b>-h</b>] [<b>-v</b>] [<b>-t</b>] [<b>-u</b>] [<b>-m</b>] [<b>-l</b>] [<b>-F</b>] [<b>-X</b>] PageName|ModuleName|ProgramName</p> <p><b>perldoc</b> <b>-f</b> BuiltinFunction</p> <p><b>perldoc</b> <b>-q</b> FAQ Keyword</p> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p><i>perldoc</i> looks up a piece of documentation in .pod format that is embedded in the perl installation tree or in a perl script, and displays it via <code>pod2man | nroff -man | $PAGER</code>. (In addition, if running under HP-UX, <code>col -x</code> will be used.) This is primarily used for the documentation for the perl library modules.</p> <p>Your system may also have man pages installed for those modules, in which case you can probably just use the man(1) command.</p> <h1 id="OPTIONS"><a class="permalink" href="#OPTIONS">#</a>OPTIONS</h1> <dl> <dt id="-h-help"><a class="permalink" href="#-h-help">#</a><a id="h-help"></a><b>-h</b> help</dt> <dd> <p>Prints out a brief help message.</p> </dd> <dt id="-v-verbose"><a class="permalink" href="#-v-verbose">#</a><a id="v-verbose"></a><b>-v</b> verbose</dt> <dd> <p>Describes search for the item in detail.</p> </dd> <dt id="-t-text-output"><a class="permalink" href="#-t-text-output">#</a><a id="t-text-output"></a><b>-t</b> text output</dt> <dd> <p>Display docs using plain text converter, instead of nroff. This may be faster, but it won't look as nice.</p> </dd> <dt id="-u-unformatted"><a class="permalink" href="#-u-unformatted">#</a><a id="u-unformatted"></a><b>-u</b> unformatted</dt> <dd> <p>Find docs only; skip reformatting by pod2*</p> </dd> <dt id="-m-module"><a class="permalink" href="#-m-module">#</a><a id="m-module"></a><b>-m</b> module</dt> <dd> <p>Display the entire module: both code and unformatted pod documentation. This may be useful if the docs don't explain a function in the detail you need, and you'd like to inspect the code directly; perldoc will find the file for you and simply hand it off for display.</p> </dd> <dt id="-l-file-name-only"><a class="permalink" href="#-l-file-name-only">#</a><a id="l-file-name-only"></a><b>-l</b> file name only</dt> <dd> <p>Display the file name of the module found.</p> </dd> <dt id="-F-file-names"><a class="permalink" href="#-F-file-names">#</a><a id="F-file-names"></a><b>-F</b> file names</dt> <dd> <p>Consider arguments as file names, no search in directories will be performed.</p> </dd> <dt id="-f-perlfunc"><a class="permalink" href="#-f-perlfunc">#</a><a id="f-perlfunc"></a><b>-f</b> perlfunc</dt> <dd> <p>The <b>-f</b> option followed by the name of a perl built in function will extract the documentation of this function from <a href="/5.6.2/perlfunc">perlfunc</a>.</p> </dd> <dt id="-q-perlfaq"><a class="permalink" href="#-q-perlfaq">#</a><a id="q-perlfaq"></a><b>-q</b> perlfaq</dt> <dd> <p>The <b>-q</b> option takes a regular expression as an argument. It will search the question headings in perlfaq[1-9] and print the entries matching the regular expression.</p> </dd> <dt id="-X-use-an-index-if-present"><a class="permalink" href="#-X-use-an-index-if-present">#</a><a id="X-use-an-index-if-present"></a><b>-X</b> use an index if present</dt> <dd> <p>The <b>-X</b> option looks for a entry whose basename matches the name given on the command line in the file <code>$Config{archlib}/pod.idx</code>. The pod.idx file should contain fully qualified filenames, one per line.</p> </dd> <dt id="-U-run-insecurely"><a class="permalink" href="#-U-run-insecurely">#</a><a id="U-run-insecurely"></a><b>-U</b> run insecurely</dt> <dd> <p>Because <b>perldoc</b> does not run properly tainted, and is known to have security issues, it will not normally execute as the superuser. If you use the <b>-U</b> flag, it will do so, but only after setting the effective and real IDs to nobody's or nouser's account, or -2 if unavailable. If it cannot relinguish its privileges, it will not run.</p> </dd> <dt id="PageName|ModuleName|ProgramName"><a class="permalink" href="#PageName%7CModuleName%7CProgramName">#</a><a id="PageName"></a><a id="PageName-ModuleName-ProgramName"></a><b>PageName|ModuleName|ProgramName</b></dt> <dd> <p>The item you want to look up. Nested modules (such as <code>File::Basename</code>) are specified either as <code>File::Basename</code> or <code>File/Basename</code>. You may also give a descriptive name of a page, such as <code>perlfunc</code>. You may also give a partial or wrong-case name, such as "basename" for "File::Basename", but this will be slower, if there is more then one page with the same partial name, you will only get the first one.</p> </dd> </dl> <h1 id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">#</a>ENVIRONMENT</h1> <p>Any switches in the <code>PERLDOC</code> environment variable will be used before the command line arguments. <code>perldoc</code> also searches directories specified by the <code>PERL5LIB</code> (or <code>PERLLIB</code> if <code>PERL5LIB</code> is not defined) and <code>PATH</code> environment variables. (The latter is so that embedded pods for executables, such as <code>perldoc</code> itself, are available.) <code>perldoc</code> will use, in order of preference, the pager defined in <code>PERLDOC_PAGER</code>, <code>MANPAGER</code>, or <code>PAGER</code> before trying to find a pager on its own. (<code>MANPAGER</code> is not used if <code>perldoc</code> was told to display plain text or unformatted pod.)</p> <p>One useful value for <code>PERLDOC_PAGER</code> is <code>less -+C -E</code>.</p> <h1 id="VERSION"><a class="permalink" href="#VERSION">#</a>VERSION</h1> <p>This is perldoc v2.03.</p> <h1 id="AUTHOR"><a class="permalink" href="#AUTHOR">#</a>AUTHOR</h1> <p>Kenneth Albanowski <kjahds@kjahds.com></p> <p>Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>, and others.</p> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

perldoc - Look up Perl documentation in pod format. - Perldoc Browser