CINXE.COM
pod2usage - print usage messages from embedded pod docs in files - metacpan.org
<!DOCTYPE html> <html lang="en-US"> <head> <title>pod2usage - print usage messages from embedded pod docs in files - metacpan.org</title> <link rel="preload" as="fetch" href="/account/login_status" crossorigin="anonymous" /> <link href="/assets/style-XFEQ536G.css" rel="stylesheet" type="text/css"> <script src="/assets/main-WXBSEDQJ.js" type="module"></script> <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of Pod-Usage - MetaCPAN" href="/dist/Pod-Usage/releases.rss" /> <link rel="canonical" href="https://metacpan.org/dist/Pod-Usage/view/scripts/pod2usage.PL" /> <meta name="description" content="print usage messages from embedded pod docs in files" /> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5"> <link rel="shortcut icon" href="/static/icons/favicon.ico"> <link rel="apple-touch-icon" sizes="152x152" href="/static/icons/apple-touch-icon.png"> <link rel="search" href="/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN"> <script async src="https://perl-ads.perlhacks.com/perl-ads.js"></script> <script async src="https://www.googletagmanager.com/gtag/js?id=G-E82Q2V8LVD"></script> <meta property="og:site_name" content="MetaCPAN" /> <meta name="twitter:site" content="@metacpan" /> <meta property="og:type" content="article" /> <meta name="twitter:card" content="summary" /> <meta property="og:url" content="https://metacpan.org/dist/Pod-Usage/view/scripts/pod2usage.PL" /> <meta property="og:title" content="pod2usage" /> <meta property="og:description" content="print usage messages from embedded pod docs in files" /> <meta property="og:image" content="https://metacpan.org/static/images/dots.png" /> </head> <body> <nav class="navbar navbar-default" role="navigation"> <div class="header-logo-large hidden-xs"> <a href="/" tabindex="0"> <svg class="logo" aria-label="MetaCPAN"> <use class="logo" href="/static/images/metacpan-logo.svg#logo" /> </svg> </a> </div> <div class="header-logo-icon visible-xs"> <a href="/"> <svg class="logo" aria-label="MetaCPAN"> <use class="logo" href="/static/images/metacpan-logo.svg#dots" /> </svg> </a> </div> <ul class="nav navbar-nav menu-items hidden-xs hidden-sm"> <li><a href="/about">About</a></li> <li><a href="/about/sponsors">Sponsor</a></li> <li><a href="https://grep.metacpan.org/">grep::cpan</a></li> <li><a href="/recent">Recent</a></li> <li><a href="/about/faq">FAQ</a></li> <li><a href="/tools">Tools</a></li> <li><a href="https://fastapi.metacpan.org/">API</a></li> </ul> <ul class="nav navbar-nav navbar-right"> <button type="button" class="searchbar-btn visible-xs visible-sm"> <i class="fa fa-search button-fa-icon"></i> </button> <form action="/search" class="searchbar-form visible-md visible-lg search-form form-horizontal"> <input type="hidden" name="size" id="metacpan_search-size" value="20"> <div class="form-group"> <div class="search-group"> <i class="fa fa-search"></i> <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value=""> </div> </div> </form> <li class="icon-slidepanel visible-xs visible-sm"> <button data-toggle="slidepanel" data-target=".slidepanel"> <span class="button-fa-icon"> <i class="fa fa-bars slidepanel-open"></i> <i class="fa fa-times slidepanel-close"></i> </span> </button> </li> <li class="dropdown login-dropdown show-logged-in"> <button type="button" class="dropdown-toggle" data-toggle="dropdown"> <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i> <i class="fas fa-chevron-down"></i> </button> <ul class="dropdown-menu"> <li><a href="/account/identities">Identities</a></li> <li><a href="/account/profile">Profile</a></li> <li><a href="/account/favorite/list">Favorites</a></li> <li> <a href="#" type="button" class="logout-button"> Logout </a> </li> </ul> </li> <li class="dropdown login-dropdown show-logged-out"> <button type="button" class="dropdown-toggle" data-toggle="dropdown"> <i class="fa fa-user button-fa-icon avatar-placeholder" aria-hidden="true"></i> <i class="fas fa-chevron-down"></i> </button> <ul class="dropdown-menu"> <li> <a href="/login/github"> <i class="fab fa-github fa-fw"></i> GitHub </a> </li> <li> <a href="/login/twitter"> <i class="fab fa-twitter fa-fw"></i> Twitter </a> </li> <li> <a href="/login/google"> <i class="fab fa-google fa-fw"></i> Google </a> </li> </ul> </li> <li class="dropdown login-dropdown hide-logged-in hide-logged-out"> <button> <i class="fa fa-user button-fa-icon" aria-hidden="true"></i> </button> </li> </ul> </nav> <div class="page-content "> <div id="perl-ad-target" class="top-notify-banner perl-ad-target"> </div> <nav class="sidebar"> <div class="slidepanel"> <ul class="nav-list "> <li class="nav-header no-margin-top"> <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of Pod-Usage was released."> <span class="relatize">21 May 2022 17:16:06 UTC</span> </div> </li> <li> Distribution: <a href="/dist/Pod-Usage">Pod-Usage</a> </li> <li> <a data-keyboard-shortcut="g s" href="/dist/Pod-Usage/source/scripts/pod2usage.PL">Source</a> (<a href="/dist/Pod-Usage/source/scripts/pod2usage.PL?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g b" href="/dist/Pod-Usage/source/scripts">Browse</a> (<a href="/dist/Pod-Usage/source/scripts?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g c" href="/dist/Pod-Usage/changes">Changes</a> </li> <li> <a rel="noopener nofollow" class="nopopup" href="https://github.com/Dual-Life/Pod-Usage">Homepage</a> </li> <li> <a class="nopopup" href="/dist/Pod-Usage/contribute">How to Contribute</a> </li> <li> <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/Dual-Life/Pod-Usage">Repository</a> </li> <li> <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://github.com/Dual-Life/Pod-Usage/issues">Issues</a> (9) </li> <li> <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=Pod-Usage+2.03" title="Matrix">Testers</a> <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-Usage.html?oncpan=1&distmat=1&version=2.03&grade=2" style="color: #090">3840</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-Usage.html?oncpan=1&distmat=1&version=2.03&grade=3" style="color: #900">2</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-Usage.html?oncpan=1&distmat=1&version=2.03&grade=4">0</a>)</span> </li> <li> <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/MAREKR/Pod-Usage-2.03">Kwalitee</a> </li> <li> <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on Pod-Usage who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)"> Bus factor: 5 </div> </li> <li> <a rel="noopener nofollow" href="http://cpancover.com/latest/Pod-Usage-2.03/index.html">73.64% Coverage </a> </li> <li> License: perl_5 </li> <li> Perl: v5.6.0 </li> <li class="nav-header">Activity</li> <li> <div class="activity-graph"> <img src="/dist/Pod-Usage/activity.svg?res=month" /> <div class="comment">24 month</div> </div> </li> <li class="nav-header">Tools</li> <li> <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/M/MA/MAREKR/Pod-Usage-2.03.tar.gz"> Download (<span itemprop="fileSize">79.47KB</span>)</a> </li> <li> <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FMAREKR%2FPod-Usage-2.03%2Fscripts%2Fpod2usage.PL"> MetaCPAN Explorer </a> </li> <li> <a href="/dist/Pod-Usage/permissions"> Permissions </a> </li> <li> <a href="/dist/Pod-Usage/releases.rss"> Subscribe to distribution </a> </li> <li> <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog"> Install Instructions </button> </li> <li> <form action="/search"> <input type="hidden" name="q" value="dist:Pod-Usage"> <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form"> <input type="submit" style="display: none"> </form> </li> <li> <form action="https://grep.metacpan.org/search"> <input type="hidden" name="qd" value="Pod-Usage"> <input type="hidden" name="source" value="metacpan"> <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form"> <input type="submit" style="display: none"> </form> </li> <li class="version-jump"> <select class="select-navigator form-control tool-bar-form"> <option disabled selected>Jump to version</option> <option disabled value="/release/MAREKR/Pod-Usage-2.03/view/scripts/pod2usage.PL" >2.03 (MAREKR on 2022-05-21)</option> <option value="/release/ATOOMIC/Pod-Usage-2.01/view/scripts/pod2usage.PL" >2.01 (ATOOMIC on 2020-10-13)</option> <option value="/release/MAREKR/Pod-Usage-2.0/view/scripts/pod2usage.PL" >2.0 (MAREKR on 2020-10-12)</option> <option value="/release/MAREKR/Pod-Usage-1.70/view/scripts/pod2usage.PL" >1.70 (MAREKR on 2020-03-15)</option> <option value="/release/MAREKR/Pod-Usage-1.69/view/scripts/pod2usage.PL" >1.69 (MAREKR on 2016-05-23)</option> <option value="/release/MAREKR/Pod-Usage-1.68/view/scripts/pod2usage.PL" >1.68 (MAREKR on 2016-01-03)</option> <option value="/release/MAREKR/Pod-Usage-1.67/view/scripts/pod2usage.PL" >1.67 (MAREKR on 2015-02-28)</option> <option value="/release/MAREKR/Pod-Usage-1.60/view/scripts/pod2usage.PL" >1.60 (MAREKR on 2013-02-03)</option> <optgroup label="BackPAN">' <option value="/release/MAREKR/Pod-Usage-1.66/view/scripts/pod2usage.PL" >1.66 (MAREKR on 2015-02-22)</option> <option value="/release/MAREKR/Pod-Usage-1.65/view/scripts/pod2usage.PL" >1.65 (MAREKR on 2015-02-12)</option> <option value="/release/MAREKR/Pod-Usage-1.64/view/scripts/pod2usage.PL" >1.64 (MAREKR on 2014-06-30)</option> <option value="/release/MAREKR/Pod-Usage-1.63/view/scripts/pod2usage.PL" >1.63 (MAREKR on 2013-06-02)</option> <option value="/release/MAREKR/Pod-Usage-1.62/view/scripts/pod2usage.PL" >1.62 (MAREKR on 2013-05-19)</option> <option value="/release/MAREKR/Pod-Usage-1.61/view/scripts/pod2usage.PL" >1.61 (MAREKR on 2013-02-05)</option> </optgroup> </select> </li> <li class="version-diff"> <select class="select-navigator form-control tool-bar-form"> <option disabled selected>Diff with version</option> <option disabled value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-2.03/scripts/pod2usage.PL" >2.03 (MAREKR on 2022-05-21)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/ATOOMIC/Pod-Usage-2.01/scripts/pod2usage.PL" >2.01 (ATOOMIC on 2020-10-13)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-2.0/scripts/pod2usage.PL" >2.0 (MAREKR on 2020-10-12)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.70/scripts/pod2usage.PL" >1.70 (MAREKR on 2020-03-15)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.69/scripts/pod2usage.PL" >1.69 (MAREKR on 2016-05-23)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.68/scripts/pod2usage.PL" >1.68 (MAREKR on 2016-01-03)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.67/scripts/pod2usage.PL" >1.67 (MAREKR on 2015-02-28)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.60/scripts/pod2usage.PL" >1.60 (MAREKR on 2013-02-03)</option> <optgroup label="BackPAN">' <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.66/scripts/pod2usage.PL" >1.66 (MAREKR on 2015-02-22)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.65/scripts/pod2usage.PL" >1.65 (MAREKR on 2015-02-12)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.64/scripts/pod2usage.PL" >1.64 (MAREKR on 2014-06-30)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.63/scripts/pod2usage.PL" >1.63 (MAREKR on 2013-06-02)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.62/scripts/pod2usage.PL" >1.62 (MAREKR on 2013-05-19)</option> <option value="/release/MAREKR/Pod-Usage-2.03/diff/MAREKR/Pod-Usage-1.61/scripts/pod2usage.PL" >1.61 (MAREKR on 2013-02-05)</option> </optgroup> </select> </li> <li> <ul class="dependencies"> <li class="nav-header">Dependencies</li> <li><a href="/pod/Cwd" title="Cwd" class="ellipsis">Cwd</a></li> <li><a href="/pod/File::Basename" title="File::Basename" class="ellipsis">File::Basename</a></li> <li><a href="/pod/File::Spec" title="File::Spec" class="ellipsis">File::Spec</a></li> <li><a href="/pod/Pod::Perldoc" title="Pod::Perldoc" class="ellipsis">Pod::Perldoc</a></li> <li><a href="/pod/Pod::Simple" title="Pod::Simple" class="ellipsis">Pod::Simple</a></li> <li><a href="/pod/Pod::Text" title="Pod::Text" class="ellipsis">Pod::Text</a></li> <li> <hr> </li> <li> <a href="/module/pod2usage/requires">Reverse dependencies</a> </li> <li> <a href="http://deps.cpantesters.org/?module=pod2usage">CPAN Testers List</a> </li> <li> <a href="https://cpandeps.grinnz.com/?dist=Pod-Usage">Dependency graph</a> </li> </ul> </li> <li class="nav-header">Permalinks</li> <li> <a href="/release/MAREKR/Pod-Usage-2.03/view/scripts/pod2usage.PL">This version</a> </li> <li> <a href="/dist/Pod-Usage/view/scripts/pod2usage.PL">Latest version</a> </li> <li> <div class="plussers"> <div class="nav-header">++ed by:</div> <div> <a class="display-all" href="/author/RRWO"><img src="https://www.gravatar.com/avatar/4a5274bc5d690ee3d619f044778771a7?d=identicon&s=20" title="RRWO" alt="RRWO"></a> <a class="display-all" href="/author/GENEHACK"><img src="https://www.gravatar.com/avatar/025d30f04795e1efc142701e4ac89bfd?d=identicon&s=20" title="GENEHACK" alt="GENEHACK"></a> <a class="display-all" href="/author/MIKEGRB"><img src="https://www.gravatar.com/avatar/db222feca6f1aa1c1df422d925b4e109?d=identicon&s=20" title="MIKEGRB" alt="MIKEGRB"></a> <a class="display-all" href="/author/PLICEASE"><img src="https://www.gravatar.com/avatar/0640fb1c0a5e82f5a777f2306efcac77?d=identicon&s=20" title="PLICEASE" alt="PLICEASE"></a> <a class="display-all" href="/author/MELO"><img src="https://www.gravatar.com/avatar/4809188f41ad2613f4c240b72d97604c?d=identicon&s=20" title="MELO" alt="MELO"></a> </div> <!-- Display counts of plussers--> <div> <a href="/dist/Pod-Usage/plussers">22 PAUSE users</a> </div> <div> 23 non-PAUSE users </div> </div> </li> <li> <div> <button class="contributors-show-button btn-link">and 2 contributors</button> <div id="metacpan_contributors" class="slide-out slide-out-hidden"> <div> <ul> <li class="contributor" data-cpan-author="KHW" data-contrib-email="khw@cpan.org" > <a href="/author/KHW" class="cpan-author"> <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/0a969d240f3770d67242df0150d85880?d=identicon&s=20" /> Karl Williamson </a> </li> <li class="contributor" data-contrib-email="nicolas@atoomic.org" > <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e?d=identicon&s=20" /> Nicolas R </li> </ul> </div> </div> </div> </li> </ul> </div> </nav> <div class="content-navigation"> <div class="breadcrumbs"> <span> <a data-keyboard-shortcut="g a" rel="author" href="/author/MAREKR" class="author-name">Marek Rouchal</a> </span> <span> / </span> <div class="release dist-release status-latest maturity-released"> <span class="dropdown"><b class="caret"></b></span> <select class="select-navigator "> <option selected value="/release/MAREKR/Pod-Usage-2.03/view/scripts/pod2usage.PL" >2.03 (MAREKR on 2022-05-21)</option> <option value="/release/ATOOMIC/Pod-Usage-2.01/view/scripts/pod2usage.PL" >2.01 (ATOOMIC on 2020-10-13)</option> <option value="/release/MAREKR/Pod-Usage-2.0/view/scripts/pod2usage.PL" >2.0 (MAREKR on 2020-10-12)</option> <option value="/release/MAREKR/Pod-Usage-1.70/view/scripts/pod2usage.PL" >1.70 (MAREKR on 2020-03-15)</option> <option value="/release/MAREKR/Pod-Usage-1.69/view/scripts/pod2usage.PL" >1.69 (MAREKR on 2016-05-23)</option> <option value="/release/MAREKR/Pod-Usage-1.68/view/scripts/pod2usage.PL" >1.68 (MAREKR on 2016-01-03)</option> <option value="/release/MAREKR/Pod-Usage-1.67/view/scripts/pod2usage.PL" >1.67 (MAREKR on 2015-02-28)</option> <option value="/release/MAREKR/Pod-Usage-1.60/view/scripts/pod2usage.PL" >1.60 (MAREKR on 2013-02-03)</option> <optgroup label="BackPAN">' <option value="/release/MAREKR/Pod-Usage-1.66/view/scripts/pod2usage.PL" >1.66 (MAREKR on 2015-02-22)</option> <option value="/release/MAREKR/Pod-Usage-1.65/view/scripts/pod2usage.PL" >1.65 (MAREKR on 2015-02-12)</option> <option value="/release/MAREKR/Pod-Usage-1.64/view/scripts/pod2usage.PL" >1.64 (MAREKR on 2014-06-30)</option> <option value="/release/MAREKR/Pod-Usage-1.63/view/scripts/pod2usage.PL" >1.63 (MAREKR on 2013-06-02)</option> <option value="/release/MAREKR/Pod-Usage-1.62/view/scripts/pod2usage.PL" >1.62 (MAREKR on 2013-05-19)</option> <option value="/release/MAREKR/Pod-Usage-1.61/view/scripts/pod2usage.PL" >1.61 (MAREKR on 2013-02-05)</option> </optgroup> </select> <a data-keyboard-shortcut="g d" class="release-name" href="/dist/Pod-Usage">Pod-Usage-2.03</a> </div> <span class="river-gauge-gauge"> <svg width="24px" height="15px" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> <g> <title> River stage five • 630 direct dependents • 20344 total dependents </title> <rect x="0" y="0" width="4" height="15" fill="#7ea3f2" /> <rect x="5" y="0" width="4" height="15" fill="#7ea3f2" /> <rect x="10" y="0" width="4" height="15" fill="#7ea3f2" /> <rect x="15" y="0" width="4" height="15" fill="#7ea3f2" /> <rect x="20" y="0" width="4" height="15" fill="#7ea3f2" /> </g> </svg> </span> <div id="Pod-Usage-fav" class="show-logged-in"> <form action="/account/favorite/add" style="display: inline" method="POST"> <input type="hidden" name="remove" value="0"> <input type="hidden" name="release" value="Pod-Usage-2.03"> <input type="hidden" name="author" value="MAREKR"> <input type="hidden" name="distribution" value="Pod-Usage"> <button type="submit" class="favorite highlight"><span>45</span> ++</button> </form> </div> <div class="show-logged-out"> <button class="fav-not-logged-in favorite highlight"><span>45</span> ++</button> </div> / <span>pod2usage</span> </div> </div> <main class="content"> <nav class="toc"> <div class="toc-header"><strong>Contents</strong></div> <ul> <li><a href="#NAME">NAME</a></li> <li><a href="#SYNOPSIS">SYNOPSIS</a></li> <li><a href="#OPTIONS-AND-ARGUMENTS">OPTIONS AND ARGUMENTS</a></li> <li><a href="#DESCRIPTION">DESCRIPTION</a></li> <li><a href="#SEE-ALSO">SEE ALSO</a></li> <li><a href="#AUTHOR">AUTHOR</a></li> </ul></nav> <div class="pod anchors"> <h1 id="NAME">NAME</h1> <p>pod2usage - print usage messages from embedded pod docs in files</p> <h1 id="SYNOPSIS">SYNOPSIS</h1> <dl> <dt id="pod2usage"><b>pod2usage</b></dt> <dd> <p>[<b>-help</b>] [<b>-man</b>] [<b>-exit</b><span style="white-space: nowrap;"> </span><i>exitval</i>] [<b>-output</b><span style="white-space: nowrap;"> </span><i>outfile</i>] [<b>-verbose</b> <i>level</i>] [<b>-pathlist</b> <i>dirlist</i>] [<b>-formatter</b> <i>module</i>] [<b>-utf8</b>] <i>file</i></p> </dd> </dl> <h1 id="OPTIONS-AND-ARGUMENTS"><a id="OPTIONS"></a>OPTIONS AND ARGUMENTS</h1> <dl> <dt id="-help"><a id="help"></a><b>-help</b></dt> <dd> <p>Print a brief help message and exit.</p> </dd> <dt id="-man"><a id="man"></a><b>-man</b></dt> <dd> <p>Print this command's manual page and exit.</p> </dd> <dt id="-exit-exitval"><a id="exit-exitval"></a><b>-exit</b> <i>exitval</i></dt> <dd> <p>The exit status value to return.</p> </dd> <dt id="-output-outfile"><a id="output-outfile"></a><b>-output</b> <i>outfile</i></dt> <dd> <p>The output file to print to. If the special names "-" or ">&1" or ">&STDOUT" are used then standard output is used. If ">&2" or ">&STDERR" is used then standard error is used.</p> </dd> <dt id="-verbose-level"><a id="verbose-level"></a><b>-verbose</b> <i>level</i></dt> <dd> <p>The desired level of verbosity to use:</p> <pre><code>1 : print SYNOPSIS only 2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections 3 : print the entire manpage (similar to running pod2text)</code></pre> </dd> <dt id="-pathlist-dirlist"><a id="pathlist-dirlist"></a><b>-pathlist</b> <i>dirlist</i></dt> <dd> <p>Specifies one or more directories to search for the input file if it was not supplied with an absolute path. Each directory path in the given list should be separated by a ':' on Unix (';' on MSWin32 and DOS).</p> </dd> <dt id="-formatter-module"><a id="formatter-module"></a><b>-formatter</b> <i>module</i></dt> <dd> <p>Which text formatter to use. Default is <a href="/pod/Pod::Text">Pod::Text</a>, or for very old Perl versions <a href="/pod/Pod::PlainText">Pod::PlainText</a>. An alternative would be e.g. <a href="/pod/Pod::Text::Termcap">Pod::Text::Termcap</a>.</p> </dd> <dt id="-utf8"><a id="utf8"></a><b>-utf8</b></dt> <dd> <p>This option assumes that the formatter (see above) understands the option "utf8". It turns on generation of utf8 output.</p> </dd> <dt id="file"><i>file</i></dt> <dd> <p>The pathname of a file containing pod documentation to be output in usage message format. If omitted, standard input is read - but the output is then formatted with <a href="/pod/Pod::Text">Pod::Text</a> only - unless a specific formatter has been specified with <b>-formatter</b>.</p> </dd> </dl> <h1 id="DESCRIPTION">DESCRIPTION</h1> <p><b>pod2usage</b> will read the given input file looking for pod documentation and will print the corresponding usage message. If no input file is specified then standard input is read.</p> <p><b>pod2usage</b> invokes the <b>pod2usage()</b> function in the <b>Pod::Usage</b> module. Please see <a href="/pod/Pod::Usage#pod2usage()">"pod2usage()" in Pod::Usage</a>.</p> <h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1> <p><a href="/pod/Pod::Usage">Pod::Usage</a>, <a href="/pod/pod2text">pod2text</a>, <a href="/pod/Pod::Text">Pod::Text</a>, <a href="/pod/Pod::Text::Termcap">Pod::Text::Termcap</a>, <a href="/pod/perldoc">perldoc</a></p> <h1 id="AUTHOR">AUTHOR</h1> <p>Please report bugs using <a href="http://rt.cpan.org">http://rt.cpan.org</a>.</p> <p>Brad Appleton <bradapp@enteract.com></p> <p>Based on code for <b>pod2text(1)</b> written by Tom Christiansen <tchrist@mox.perl.com></p></div> <div id="metacpan_install-instructions-dialog" class="modal fade"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> <h4 class="modal-title">Module Install Instructions</h4> </div> <div class="modal-body"> <p>To install Pod::Usage, copy and paste the appropriate command in to your terminal.</p> <p><a href="/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p> <pre><code>cpanm Pod::Usage</code></pre> <p><a href="/pod/CPAN">CPAN shell</a></p> <pre><code>perl -MCPAN -e shell install Pod::Usage</code></pre> <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p> </div> <div class="modal-footer"> <a href="#" data-dismiss="modal" class="btn">Close</a> </div> </div> </div> </div> </main> <div class="content-pagination"> </div> </div> <footer class="footer"> <div class="footer-container"> <div class="footer-social"> <div class="footer-link footer-logo"> <a href="/"> <img src="/static/images/metacpan-logo.svg" alt="MetaCPAN" /> </a> </div> <a class="footer-social-link" href="https://github.com/metacpan"> <i class="fab fa-github-square"></i> </a> <a class="footer-social-link" href="https://fosstodon.org/@metacpan"> <i class="fab fa-mastodon"></i> </a> </div> <div class="footer-links"> <div class="footer-link"> <a href="/about">About</a> </div> <div class="footer-link"> <a href="/about/sponsors">Sponsor</a> </div> <div class="footer-link"> <a href="https://grep.metacpan.org">grep::cpan</a> </div> <div class="footer-link"> <a href="/recent">Recent</a> </div> <div class="footer-link"> <a href="/about/faq">FAQ</a> </div> <div class="footer-link"> <a href="/tools">Tools</a> </div> <div class="footer-link"> <a href="https://fastapi.metacpan.org/">API</a> </div> <div class="footer-link"> <a href="https://www.perl.org/">Perl.org</a> </div> </div> <div class="footer-sponsors"> <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener"> <img class="footer-sponsor-bytemark" src="/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener"> <img class="footer-sponsor-liquidweb" src="/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener"> <img class="footer-sponsor-deriv" src="/static/images/sponsors/deriv.svg" alt="Deriv logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener"> <img class="footer-sponsor-geocode" src="/static/images/sponsors/geocodelogo.svg" alt="Geocode logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener"> <img class="footer-sponsor-fastly" src="/static/images/sponsors/fastly_logo.svg" alt="Fastly logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener"> <img class="footer-sponsor-opencage" src="/static/images/sponsors/open-cage.svg" alt="OpenCage logo"> </a> <!-- Added 2024-07-22 --> <a class="footer-sponsor-link" target="_blank" href="https://www.elastic.co/" rel="noopener"> <img class="footer-sponsor-elastic" src="/static/images/sponsors/elastic.svg" alt="Elastic logo"> </a> <!-- Added 2024-07-22 --> <a class="footer-sponsor-link" target="_blank" href="https://route4me.com/" rel="noopener"> <img class="footer-sponsor-route4me" src="/static/images/sponsors/route4me.png" alt="Route4Me logo"> </a> </div> </div> </footer> <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal">×</button> <h4 class="modal-title">Keyboard Shortcuts</h4> </div> <div class="modal-body row"> <div class="col-md-6"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>Global</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>s</kbd> </td> <td>Focus search bar</td> </tr> <tr> <td class="keys"> <kbd>?</kbd> </td> <td>Bring up this help dialog</td> </tr> </tbody> </table> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>GitHub</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>g</kbd> <kbd>p</kbd> </td> <td>Go to pull requests</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>i</kbd> </td> <td>go to github issues (only if github is preferred repository)</td> </tr> </tbody> </table> </div> <div class="col-md-6"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>POD</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>g</kbd> <kbd>a</kbd> </td> <td>Go to author</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>c</kbd> </td> <td>Go to changes</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>i</kbd> </td> <td>Go to issues</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>d</kbd> </td> <td>Go to dist</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>r</kbd> </td> <td>Go to repository/SCM</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>s</kbd> </td> <td>Go to source</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>b</kbd> </td> <td>Go to file browse</td> </tr> </tbody> </table> </div> <div class="col-md-12"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>Search terms</th> </tr> </thead> <tbody> <tr> <td><em>module:</em> (e.g. <a href="/search?q=module%3APlugin">module:Plugin</a>)</td> </tr> <tr> <td><em>distribution:</em> (e.g. <a href="/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td> </tr> <tr> <td><em>author:</em> (e.g. <a href="/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td> </tr> <tr> <td><em>version:</em> (e.g. <a href="/search?q=version%3A1.00">version:1.00</a>)</td> </tr> </tbody> </table> </div> </div> <div class="modal-footer"></div> </div> </div> </div> </body> </html>