Pod::Usage - extracts POD documentation and shows usage information

<!DOCTYPE html> <html lang="en-US"> <head> <title>Pod::Usage - extracts POD documentation and shows usage information - 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/pod/Pod::Usage" /> <meta name="description" content="extracts POD documentation and shows usage information" /> <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/pod/Pod::Usage" /> <meta property="og:title" content="Pod::Usage" /> <meta property="og:description" content="extracts POD documentation and shows usage information" /> <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">25 Mar 2025 18:13:51 UTC</span> </div> </li> <li> Distribution: <a href="/dist/Pod-Usage">Pod-Usage</a> </li> <li> Module version: 2.04 </li> <li> <a data-keyboard-shortcut="g s" href="/dist/Pod-Usage/source/lib/Pod/Usage.pm">Source</a> (<a href="/dist/Pod-Usage/source/lib/Pod/Usage.pm?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g b" href="/dist/Pod-Usage/source/lib/Pod">Browse</a> (<a href="/dist/Pod-Usage/source/lib/Pod?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.04" title="Matrix">Testers</a> </li> <li> <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/MAREKR/Pod-Usage-2.04">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> 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.04.tar.gz"> Download (<span itemprop="fileSize">41.34KB</span>)</a> </li> <li> <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FMAREKR%2FPod-Usage-2.04%2Flib%2FPod%2FUsage.pm"> 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.04/view/lib/Pod/Usage.pm" >2.04 (MAREKR on 2025-03-25)</option> <option value="/release/MAREKR/Pod-Usage-2.03/view/lib/Pod/Usage.pm" >2.03 (MAREKR on 2022-05-21)</option> <option value="/release/ATOOMIC/Pod-Usage-2.01/view/lib/Pod/Usage.pm" >2.01 (ATOOMIC on 2020-10-13)</option> <option value="/release/MAREKR/Pod-Usage-2.0/view/lib/Pod/Usage.pm" >2.0 (MAREKR on 2020-10-12)</option> <option value="/release/MAREKR/Pod-Usage-1.70/view/lib/Pod/Usage.pm" >1.70 (MAREKR on 2020-03-15)</option> <option value="/release/MAREKR/Pod-Usage-1.69/view/lib/Pod/Usage.pm" >1.69 (MAREKR on 2016-05-23)</option> <option value="/release/MAREKR/Pod-Usage-1.68/view/lib/Pod/Usage.pm" >1.68 (MAREKR on 2016-01-03)</option> <option value="/release/MAREKR/Pod-Usage-1.67/view/lib/Pod/Usage.pm" >1.67 (MAREKR on 2015-02-28)</option> <option value="/release/MAREKR/Pod-Usage-1.60/view/lib/Pod/Usage.pm" >1.60 (MAREKR on 2013-02-03)</option> <optgroup label="BackPAN">' <option value="/release/MAREKR/Pod-Usage-1.66/view/lib/Pod/Usage.pm" >1.66 (MAREKR on 2015-02-22)</option> <option value="/release/MAREKR/Pod-Usage-1.65/view/lib/Pod/Usage.pm" >1.65 (MAREKR on 2015-02-12)</option> <option value="/release/MAREKR/Pod-Usage-1.64/view/lib/Pod/Usage.pm" >1.64 (MAREKR on 2014-06-30)</option> <option value="/release/MAREKR/Pod-Usage-1.63/view/lib/Pod/Usage.pm" >1.63 (MAREKR on 2013-06-02)</option> <option value="/release/MAREKR/Pod-Usage-1.62/view/lib/Pod/Usage.pm" >1.62 (MAREKR on 2013-05-19)</option> <option value="/release/MAREKR/Pod-Usage-1.61/view/lib/Pod/Usage.pm" >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.04/diff/MAREKR/Pod-Usage-2.04/lib/Pod/Usage.pm" >2.04 (MAREKR on 2025-03-25)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-2.03/lib/Pod/Usage.pm" >2.03 (MAREKR on 2022-05-21)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/ATOOMIC/Pod-Usage-2.01/lib/Pod/Usage.pm" >2.01 (ATOOMIC on 2020-10-13)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-2.0/lib/Pod/Usage.pm" >2.0 (MAREKR on 2020-10-12)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.70/lib/Pod/Usage.pm" >1.70 (MAREKR on 2020-03-15)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.69/lib/Pod/Usage.pm" >1.69 (MAREKR on 2016-05-23)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.68/lib/Pod/Usage.pm" >1.68 (MAREKR on 2016-01-03)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.67/lib/Pod/Usage.pm" >1.67 (MAREKR on 2015-02-28)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.60/lib/Pod/Usage.pm" >1.60 (MAREKR on 2013-02-03)</option> <optgroup label="BackPAN">' <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.66/lib/Pod/Usage.pm" >1.66 (MAREKR on 2015-02-22)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.65/lib/Pod/Usage.pm" >1.65 (MAREKR on 2015-02-12)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.64/lib/Pod/Usage.pm" >1.64 (MAREKR on 2014-06-30)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.63/lib/Pod/Usage.pm" >1.63 (MAREKR on 2013-06-02)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.62/lib/Pod/Usage.pm" >1.62 (MAREKR on 2013-05-19)</option> <option value="/release/MAREKR/Pod-Usage-2.04/diff/MAREKR/Pod-Usage-1.61/lib/Pod/Usage.pm" >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/Pod::Usage/requires">Reverse dependencies</a> </li> <li> <a href="http://deps.cpantesters.org/?module=Pod%3A%3AUsage">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.04/view/lib/Pod/Usage.pm">This version</a> </li> <li> <a href="/pod/Pod::Usage">Latest version</a> </li> <li> <div class="plussers"> <div class="nav-header">++ed by:</div> <div> <a class="display-all" href="/author/PAVELSR"><img src="https://www.gravatar.com/avatar/bdd3233525e2a6ca61bbc05752111c15?d=identicon&s=20" title="PAVELSR" alt="PAVELSR"></a> <a class="display-all" href="/author/SYP"><img src="https://www.gravatar.com/avatar/9b6fa62677be03c25ee1af4d95472042?d=identicon&s=20" title="SYP" alt="SYP"></a> <a class="display-all" href="/author/ARISTOTLE"><img src="https://www.gravatar.com/avatar/81da52fa1b6754867e9056c58afab74d?d=identicon&s=20" title="ARISTOTLE" alt="ARISTOTLE"></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/KUERBIS"><img src="https://www.gravatar.com/avatar/136c77354b6a6d4451c38198dd74d83c?d=identicon&s=20" title="KUERBIS" alt="KUERBIS"></a> </div>  <div> <a href="/dist/Pod-Usage/plussers">23 PAUSE users</a> </div> <div> 23 non-PAUSE users </div> </div> </li> <li> <div> <button class="contributors-show-button btn-link">and 5 contributors</button> <div id="metacpan_contributors" class="slide-out slide-out-hidden"> <div> <ul> <li class="contributor" data-cpan-author="HAARG" data-contrib-email="haarg@haarg.org" > <a href="/author/HAARG" class="cpan-author"> <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/5037faf9ba40cf736778820fe83fc2ae?d=identicon&s=20" /> Graham Knop </a> </li> <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="lilinjie@uniontech.com" > <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e?d=identicon&s=20" /> lilinjie </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> <li class="contributor" data-contrib-email="ntadic001@gmail.com" > <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e?d=identicon&s=20" /> ubinator </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.04/view/lib/Pod/Usage.pm" >2.04 (MAREKR on 2025-03-25)</option> <option value="/release/MAREKR/Pod-Usage-2.03/view/lib/Pod/Usage.pm" >2.03 (MAREKR on 2022-05-21)</option> <option value="/release/ATOOMIC/Pod-Usage-2.01/view/lib/Pod/Usage.pm" >2.01 (ATOOMIC on 2020-10-13)</option> <option value="/release/MAREKR/Pod-Usage-2.0/view/lib/Pod/Usage.pm" >2.0 (MAREKR on 2020-10-12)</option> <option value="/release/MAREKR/Pod-Usage-1.70/view/lib/Pod/Usage.pm" >1.70 (MAREKR on 2020-03-15)</option> <option value="/release/MAREKR/Pod-Usage-1.69/view/lib/Pod/Usage.pm" >1.69 (MAREKR on 2016-05-23)</option> <option value="/release/MAREKR/Pod-Usage-1.68/view/lib/Pod/Usage.pm" >1.68 (MAREKR on 2016-01-03)</option> <option value="/release/MAREKR/Pod-Usage-1.67/view/lib/Pod/Usage.pm" >1.67 (MAREKR on 2015-02-28)</option> <option value="/release/MAREKR/Pod-Usage-1.60/view/lib/Pod/Usage.pm" >1.60 (MAREKR on 2013-02-03)</option> <optgroup label="BackPAN">' <option value="/release/MAREKR/Pod-Usage-1.66/view/lib/Pod/Usage.pm" >1.66 (MAREKR on 2015-02-22)</option> <option value="/release/MAREKR/Pod-Usage-1.65/view/lib/Pod/Usage.pm" >1.65 (MAREKR on 2015-02-12)</option> <option value="/release/MAREKR/Pod-Usage-1.64/view/lib/Pod/Usage.pm" >1.64 (MAREKR on 2014-06-30)</option> <option value="/release/MAREKR/Pod-Usage-1.63/view/lib/Pod/Usage.pm" >1.63 (MAREKR on 2013-06-02)</option> <option value="/release/MAREKR/Pod-Usage-1.62/view/lib/Pod/Usage.pm" >1.62 (MAREKR on 2013-05-19)</option> <option value="/release/MAREKR/Pod-Usage-1.61/view/lib/Pod/Usage.pm" >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.04</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 
 • 628 direct dependents 
 • 20321 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.04"> <input type="hidden" name="author" value="MAREKR"> <input type="hidden" name="distribution" value="Pod-Usage"> <button type="submit" class="favorite highlight"><span>46</span> ++</button> </form> </div> <div class="show-logged-out"> <button class="fav-not-logged-in favorite highlight"><span>46</span> ++</button> </div> / <span>Pod::Usage</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="#ARGUMENTS">ARGUMENTS</a> <ul> <li><a href="#Formatting-base-class">Formatting base class</a></li> <li><a href="#Pass-through-options">Pass-through options</a></li> </ul> </li> <li><a href="#DESCRIPTION">DESCRIPTION</a> <ul> <li><a href="#Scripts">Scripts</a></li> </ul> </li> <li><a href="#EXAMPLES">EXAMPLES</a> <ul> <li><a href="#Recommended-Use">Recommended Use</a></li> </ul> </li> <li><a href="#CAVEATS">CAVEATS</a></li> <li><a href="#SUPPORT">SUPPORT</a></li> <li><a href="#AUTHOR">AUTHOR</a></li> <li><a href="#LICENSE">LICENSE</a></li> <li><a href="#ACKNOWLEDGMENTS">ACKNOWLEDGMENTS</a></li> <li><a href="#SEE-ALSO">SEE ALSO</a></li> </ul></nav> <div class="pod anchors"> <h1 id="NAME">NAME</h1> <p>Pod::Usage - extracts POD documentation and shows usage information</p> <h1 id="SYNOPSIS">SYNOPSIS</h1> <pre><code>use Pod::Usage; my $message_text = "This text precedes the usage message."; my $exit_status = 2; ## The exit status to use my $verbose_level = 0; ## The verbose level to use my $filehandle = \*STDERR; ## The filehandle to write to pod2usage($message_text); pod2usage($exit_status); pod2usage( { -message => $message_text , -exitval => $exit_status , -verbose => $verbose_level, -output => $filehandle } ); pod2usage( -msg => $message_text , -exitval => $exit_status , -verbose => $verbose_level, -output => $filehandle ); pod2usage( -verbose => 2, -noperldoc => 1 ); pod2usage( -verbose => 2, -perlcmd => $path_to_perl, -perldoc => $path_to_perldoc, -perldocopt => $perldoc_options );</code></pre> <h1 id="ARGUMENTS">ARGUMENTS</h1> <p><b>pod2usage</b> should be given either a single argument, or a list of arguments corresponding to an associative array (a "hash"). When a single argument is given, it should correspond to exactly one of the following:</p> <ul> <li><p>A string containing the text of a message to print <i>before</i> printing the usage message</p> </li> <li><p>A numeric value corresponding to the desired exit status</p> </li> <li><p>A reference to a hash</p> </li> </ul> <p>If more than one argument is given then the entire argument list is assumed to be a hash. If a hash is supplied (either as a reference or as a list) it should contain one or more elements with the following keys:</p> <dl> <dt id="-message-string"><a id="message-string"></a><code>-message</code> <i>string</i></dt> <dd> </dd> <dt id="-msg-string"><a id="msg-string"></a><code>-msg</code> <i>string</i></dt> <dd> <p>The text of a message to print immediately prior to printing the program's usage message.</p> </dd> <dt id="-exitval-value"><a id="exitval-value"></a><code>-exitval</code> <i>value</i></dt> <dd> <p>The desired exit status to pass to the <b>exit()</b> function. This should be an integer, or else the string <code>NOEXIT</code> to indicate that control should simply be returned without terminating the invoking process.</p> </dd> <dt id="-verbose-value"><a id="verbose-value"></a><code>-verbose</code> <i>value</i></dt> <dd> <p>The desired level of "verboseness" to use when printing the usage message. If the value is 0, then only the "SYNOPSIS" and/or "USAGE" sections of the pod documentation are printed. If the value is 1, then the "SYNOPSIS" and/or "USAGE" sections, along with any section entitled "OPTIONS", "ARGUMENTS", or "OPTIONS AND ARGUMENTS" is printed. If the corresponding value is 2 or more then the entire manpage is printed, using <a href="/pod/perldoc">perldoc</a> if available; otherwise <a href="/pod/Pod::Text">Pod::Text</a> is used for the formatting. For better readability, the all-capital headings are downcased, e.g. <code>SYNOPSIS</code> => <code>Synopsis</code>.</p> <p>The special verbosity level 99 requires to also specify the -sections parameter; then these sections are extracted and printed.</p> </dd> <dt id="-sections-spec"><a id="sections-spec"></a><code>-sections</code> <i>spec</i></dt> <dd> <p>There are two ways to specify the selection. Either a string (scalar) representing a selection regexp for sections to be printed when -verbose is set to 99, e.g.</p> <pre><code>"NAME|SYNOPSIS|DESCRIPTION|VERSION"</code></pre> <p>With the above regexp all content following (and including) any of the given <code>=head1</code> headings will be shown. It is possible to restrict the output to particular subsections only, e.g.:</p> <pre><code>"DESCRIPTION/Algorithm"</code></pre> <p>This will output only the <code>=head2 Algorithm</code> heading and content within the <code>=head1 DESCRIPTION</code> section. The regexp binding is stronger than the section separator, such that e.g.:</p> <pre><code>"DESCRIPTION|OPTIONS|ENVIRONMENT/Caveats"</code></pre> <p>will print any <code>=head2 Caveats</code> section (only) within any of the three <code>=head1</code> sections.</p> <p>Alternatively, an array reference of section specifications can be used:</p> <pre><code>pod2usage(-verbose => 99, -sections => [ qw(DESCRIPTION DESCRIPTION/Introduction) ] );</code></pre> <p>This will print only the content of <code>=head1 DESCRIPTION</code> and the <code>=head2 Introduction</code> sections, but no other <code>=head2</code>, and no other <code>=head1</code> either.</p> </dd> <dt id="-output-handle"><a id="output-handle"></a><code>-output</code> <i>handle</i></dt> <dd> <p>A reference to a filehandle, or the pathname of a file to which the usage message should be written. The default is <code>\*STDERR</code> unless the exit value is less than 2 (in which case the default is <code>\*STDOUT</code>).</p> </dd> <dt id="-input-handle"><a id="input-handle"></a><code>-input</code> <i>handle</i></dt> <dd> <p>A reference to a filehandle, or the pathname of a file from which the invoking script's pod documentation should be read. It defaults to the file indicated by <code>$0</code> (<code>$PROGRAM_NAME</code> for users of <i>English.pm</i>).</p> <p>If you are calling <b>pod2usage()</b> from a module and want to display that module's POD, you can use this:</p> <pre><code>use Pod::Find qw(pod_where); pod2usage( -input => pod_where({-inc => 1}, __PACKAGE__) );</code></pre> </dd> <dt id="-pathlist-string"><a id="pathlist-string"></a><code>-pathlist</code> <i>string</i></dt> <dd> <p>A list of directory paths. If the input file does not exist, then it will be searched for in the given directory list (in the order the directories appear in the list). It defaults to the list of directories implied by <code>$ENV{PATH}</code>. The list may be specified either by a reference to an array, or by a string of directory paths which use the same path separator as <code>$ENV{PATH}</code> on your system (e.g., <code>:</code> for Unix, <code>;</code> for MSWin32 and DOS).</p> </dd> <dt id="-noperldoc"><a id="noperldoc"></a><code>-noperldoc</code></dt> <dd> <p>By default, Pod::Usage will call <a href="/pod/perldoc">perldoc</a> when -verbose >= 2 is specified. This does not work well e.g. if the script was packed with <a href="/pod/PAR">PAR</a>. This option suppresses the external call to <a href="/pod/perldoc">perldoc</a> and uses the simple text formatter (<a href="/pod/Pod::Text">Pod::Text</a>) to output the POD.</p> </dd> <dt id="-perlcmd"><a id="perlcmd"></a><code>-perlcmd</code></dt> <dd> <p>By default, Pod::Usage will call <a href="/pod/perldoc">perldoc</a> when -verbose >= 2 is specified. In case of special or unusual Perl installations, this option may be used to supply the path to a <a href="/pod/perl">perl</a> executable which should run <a href="/pod/perldoc">perldoc</a>.</p> </dd> <dt id="-perldoc-path-to-perldoc"><a id="perldoc-path-to-perldoc"></a><code>-perldoc</code> <i>path-to-perldoc</i></dt> <dd> <p>By default, Pod::Usage will call <a href="/pod/perldoc">perldoc</a> when -verbose >= 2 is specified. In case <a href="/pod/perldoc">perldoc</a> is not installed where the <a href="/pod/perl">perl</a> interpreter thinks it is (see <a href="/pod/Config">Config</a>), the -perldoc option may be used to supply the correct path to <a href="/pod/perldoc">perldoc</a>.</p> </dd> <dt id="-perldocopt-string"><a id="perldocopt-string"></a><code>-perldocopt</code> <i>string</i></dt> <dd> <p>By default, Pod::Usage will call <a href="/pod/perldoc">perldoc</a> when -verbose >= 2 is specified. This option may be used to supply options to <a href="/pod/perldoc">perldoc</a>. The string may contain several, space-separated options.</p> </dd> </dl> <h2 id="Formatting-base-class"><a id="Formatting"></a>Formatting base class</h2> <p>The default text formatter is <a href="/pod/Pod::Text">Pod::Text</a>. The base class for Pod::Usage can be defined by pre-setting <code>$Pod::Usage::Formatter</code> <i>before</i> loading Pod::Usage, e.g.:</p> <pre><code>BEGIN { $Pod::Usage::Formatter = 'Pod::Text::Termcap'; } use Pod::Usage qw(pod2usage);</code></pre> <p>Pod::Usage uses <a href="/pod/Pod::Simple">Pod::Simple</a>'s _handle_element_end() method to implement the section selection, and in case of verbosity < 2 it down-cases the all-caps headings to first capital letter and rest lowercase, and adds a colon/newline at the end of the headings, for better readability. Same for verbosity = 99.</p> <h2 id="Pass-through-options"><a id="Pass"></a>Pass-through options</h2> <p>The following options are passed through to the underlying text formatter. See the manual pages of these modules for more information.</p> <pre><code>alt code indent loose margin quotes sentence stderr utf8 width</code></pre> <h1 id="DESCRIPTION">DESCRIPTION</h1> <p><b>pod2usage</b> will print a usage message for the invoking script (using its embedded pod documentation) and then exit the script with the desired exit status. The usage message printed may have any one of three levels of "verboseness": If the verbose level is 0, then only a synopsis is printed. If the verbose level is 1, then the synopsis is printed along with a description (if present) of the command line options and arguments. If the verbose level is 2, then the entire manual page is printed.</p> <p>Unless they are explicitly specified, the default values for the exit status, verbose level, and output stream to use are determined as follows:</p> <ul> <li><p>If neither the exit status nor the verbose level is specified, then the default is to use an exit status of 2 with a verbose level of 0.</p> </li> <li><p>If an exit status <i>is</i> specified but the verbose level is <i>not</i>, then the verbose level will default to 1 if the exit status is less than 2 and will default to 0 otherwise.</p> </li> <li><p>If an exit status is <i>not</i> specified but verbose level <i>is</i> given, then the exit status will default to 2 if the verbose level is 0 and will default to 1 otherwise.</p> </li> <li><p>If the exit status used is less than 2, then output is printed on <code>STDOUT</code>. Otherwise output is printed on <code>STDERR</code>.</p> </li> </ul> <p>Although the above may seem a bit confusing at first, it generally does "the right thing" in most situations. This determination of the default values to use is based upon the following typical Unix conventions:</p> <ul> <li><p>An exit status of 0 implies "success". For example, <b>diff(1)</b> exits with a status of 0 if the two files have the same contents.</p> </li> <li><p>An exit status of 1 implies possibly abnormal, but non-defective, program termination. For example, <b>grep(1)</b> exits with a status of 1 if it did <i>not</i> find a matching line for the given regular expression.</p> </li> <li><p>An exit status of 2 or more implies a fatal error. For example, <b>ls(1)</b> exits with a status of 2 if you specify an illegal (unknown) option on the command line.</p> </li> <li><p>Usage messages issued as a result of bad command-line syntax should go to <code>STDERR</code>. However, usage messages issued due to an explicit request to print usage (like specifying <b>-help</b> on the command line) should go to <code>STDOUT</code>, just in case the user wants to pipe the output to a pager (such as <b>more(1)</b>).</p> </li> <li><p>If program usage has been explicitly requested by the user, it is often desirable to exit with a status of 1 (as opposed to 0) after issuing the user-requested usage message. It is also desirable to give a more verbose description of program usage in this case.</p> </li> </ul> <p><b>pod2usage</b> does not force the above conventions upon you, but it will use them by default if you don't expressly tell it to do otherwise. The ability of <b>pod2usage()</b> to accept a single number or a string makes it convenient to use as an innocent looking error message handling function:</p> <pre><code>use strict; use Pod::Usage; use Getopt::Long; ## Parse options my %opt; GetOptions(\%opt, "help|?", "man", "flag1") || pod2usage(2); pod2usage(1) if ($opt{help}); pod2usage(-exitval => 0, -verbose => 2) if ($opt{man}); ## Check for too many filenames pod2usage("$0: Too many files given.\n") if (@ARGV > 1);</code></pre> <p>Some user's however may feel that the above "economy of expression" is not particularly readable nor consistent and may instead choose to do something more like the following:</p> <pre><code>use strict; use Pod::Usage qw(pod2usage); use Getopt::Long qw(GetOptions); ## Parse options my %opt; GetOptions(\%opt, "help|?", "man", "flag1") || pod2usage(-verbose => 0); pod2usage(-verbose => 1) if ($opt{help}); pod2usage(-verbose => 2) if ($opt{man}); ## Check for too many filenames pod2usage(-verbose => 2, -message => "$0: Too many files given.\n") if (@ARGV > 1);</code></pre> <p>As with all things in Perl, <i>there's more than one way to do it</i>, and <b>pod2usage()</b> adheres to this philosophy. If you are interested in seeing a number of different ways to invoke <b>pod2usage</b> (although by no means exhaustive), please refer to <a href="#EXAMPLES">"EXAMPLES"</a>.</p> <h2 id="Scripts">Scripts</h2> <p>The Pod::Usage distribution comes with a script pod2usage which offers a command line interface to the functionality of Pod::Usage. See <a href="/pod/distribution/Pod-Usage/scripts/pod2usage.PL">pod2usage</a>.</p> <h1 id="EXAMPLES">EXAMPLES</h1> <p>Each of the following invocations of <code>pod2usage()</code> will print just the "SYNOPSIS" section to <code>STDERR</code> and will exit with a status of 2:</p> <pre><code>pod2usage(); pod2usage(2); pod2usage(-verbose => 0); pod2usage(-exitval => 2); pod2usage({-exitval => 2, -output => \*STDERR}); pod2usage({-verbose => 0, -output => \*STDERR}); pod2usage(-exitval => 2, -verbose => 0); pod2usage(-exitval => 2, -verbose => 0, -output => \*STDERR);</code></pre> <p>Each of the following invocations of <code>pod2usage()</code> will print a message of "Syntax error." (followed by a newline) to <code>STDERR</code>, immediately followed by just the "SYNOPSIS" section (also printed to <code>STDERR</code>) and will exit with a status of 2:</p> <pre><code>pod2usage("Syntax error."); pod2usage(-message => "Syntax error.", -verbose => 0); pod2usage(-msg => "Syntax error.", -exitval => 2); pod2usage({-msg => "Syntax error.", -exitval => 2, -output => \*STDERR}); pod2usage({-msg => "Syntax error.", -verbose => 0, -output => \*STDERR}); pod2usage(-msg => "Syntax error.", -exitval => 2, -verbose => 0); pod2usage(-message => "Syntax error.", -exitval => 2, -verbose => 0, -output => \*STDERR);</code></pre> <p>Each of the following invocations of <code>pod2usage()</code> will print the "SYNOPSIS" section and any "OPTIONS" and/or "ARGUMENTS" sections to <code>STDOUT</code> and will exit with a status of 1:</p> <pre><code>pod2usage(1); pod2usage(-verbose => 1); pod2usage(-exitval => 1); pod2usage({-exitval => 1, -output => \*STDOUT}); pod2usage({-verbose => 1, -output => \*STDOUT}); pod2usage(-exitval => 1, -verbose => 1); pod2usage(-exitval => 1, -verbose => 1, -output => \*STDOUT});</code></pre> <p>Each of the following invocations of <code>pod2usage()</code> will print the entire manual page to <code>STDOUT</code> and will exit with a status of 1:</p> <pre><code>pod2usage(-verbose => 2); pod2usage({-verbose => 2, -output => \*STDOUT}); pod2usage(-exitval => 1, -verbose => 2); pod2usage({-exitval => 1, -verbose => 2, -output => \*STDOUT});</code></pre> <h2 id="Recommended-Use"><a id="Recommended"></a>Recommended Use</h2> <p>Most scripts should print some type of usage message to <code>STDERR</code> when a command line syntax error is detected. They should also provide an option (usually <code>-H</code> or <code>-help</code>) to print a (possibly more verbose) usage message to <code>STDOUT</code>. Some scripts may even wish to go so far as to provide a means of printing their complete documentation to <code>STDOUT</code> (perhaps by allowing a <code>-man</code> option). The following complete example uses <b>Pod::Usage</b> in combination with <b>Getopt::Long</b> to do all of these things:</p> <pre><code>use strict; use Getopt::Long qw(GetOptions); use Pod::Usage qw(pod2usage); my $man = 0; my $help = 0; ## Parse options and print usage if there is a syntax error, ## or if usage was explicitly requested. GetOptions('help|?' => \$help, man => \$man) or pod2usage(2); pod2usage(1) if $help; pod2usage(-verbose => 2) if $man; ## If no arguments were given, then allow STDIN to be used only ## if it's not connected to a terminal (otherwise print usage) pod2usage("$0: No files given.") if ((@ARGV == 0) && (-t STDIN)); __END__ =head1 NAME sample - Using GetOpt::Long and Pod::Usage =head1 SYNOPSIS sample [options] [file ...] Options: -help brief help message -man full documentation =head1 OPTIONS =over 4 =item B<-help> Prints a brief help message and exits. =item B<-man> Prints the manual page and exits. =back =head1 DESCRIPTION B<This program> will read the given input file(s) and do something useful with the contents thereof. =cut</code></pre> <h1 id="CAVEATS">CAVEATS</h1> <p>By default, <b>pod2usage()</b> will use <code>$0</code> as the path to the pod input file. Unfortunately, not all systems on which Perl runs will set <code>$0</code> properly (although if <code>$0</code> is not found, <b>pod2usage()</b> will search <code>$ENV{PATH}</code> or else the list specified by the <code>-pathlist</code> option). If this is the case for your system, you may need to explicitly specify the path to the pod docs for the invoking script using something similar to the following:</p> <pre><code>pod2usage(-exitval => 2, -input => "/path/to/your/pod/docs");</code></pre> <p>In the pathological case that a script is called via a relative path <i>and</i> the script itself changes the current working directory (see <a href="/pod/perlfunc#chdir">"chdir" in perlfunc</a>) <i>before</i> calling pod2usage, Pod::Usage will fail even on robust platforms. Don't do that. Or use <a href="/pod/FindBin">FindBin</a> to locate the script:</p> <pre><code>use FindBin; pod2usage(-input => $FindBin::Bin . "/" . $FindBin::Script);</code></pre> <h1 id="SUPPORT">SUPPORT</h1> <p>This module is managed in a GitHub repository, <a href="https://github.com/Dual-Life/Pod-Usage">https://github.com/Dual-Life/Pod-Usage</a> Feel free to fork and contribute, or to clone and send patches!</p> <p>Please use <a href="https://github.com/Dual-Life/Pod-Usage/issues/new">https://github.com/Dual-Life/Pod-Usage/issues/new</a> to file a bug report. The previous ticketing system, <a href="https://rt.cpan.org/Dist/Display.html?Queue=Pod-Usage">https://rt.cpan.org/Dist/Display.html?Queue=Pod-Usage</a>, is deprecated for this package.</p> <p>More general questions or discussion about POD should be sent to the <code>pod-people@perl.org</code> mail list. Send an empty email to <code>pod-people-subscribe@perl.org</code> to subscribe.</p> <h1 id="AUTHOR">AUTHOR</h1> <p>Marek Rouchal <marekr@cpan.org></p> <p>Nicolas R <nicolas@atoomic.org></p> <p>Brad Appleton <bradapp@enteract.com></p> <p>Based on code for <b>Pod::Text::pod2text()</b> written by Tom Christiansen <tchrist@mox.perl.com></p> <h1 id="LICENSE">LICENSE</h1> <p>Pod::Usage (the distribution) is licensed under the same terms as Perl.</p> <h1 id="ACKNOWLEDGMENTS">ACKNOWLEDGMENTS</h1> <p>Nicolas R (ATOOMIC) for setting up the Github repo and modernizing this package.</p> <p>rjbs for refactoring Pod::Usage to not use Pod::Parser any more.</p> <p>Steven McDougall <swmcd@world.std.com> for his help and patience with re-writing this manpage.</p> <h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1> <p><b>Pod::Usage</b> is now a standalone distribution, depending on <a href="/pod/Pod::Text">Pod::Text</a> which in turn depends on <a href="/pod/Pod::Simple">Pod::Simple</a>.</p> <p><a href="/pod/Pod::Perldoc">Pod::Perldoc</a>, <a href="/pod/Getopt::Long">Getopt::Long</a>, <a href="/pod/Pod::Find">Pod::Find</a>, <a href="/pod/FindBin">FindBin</a>, <a href="/pod/Pod::Text">Pod::Text</a>, <a href="/pod/Pod::Text::Termcap">Pod::Text::Termcap</a>, <a href="/pod/Pod::Simple">Pod::Simple</a></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>  <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>  <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>

CINXE.COM

Pod::Usage - extracts POD documentation and shows usage information - metacpan.org