CINXE.COM
pod2man - Convert POD data to formatted *roff input - metacpan.org
<!DOCTYPE html> <html lang="en-US"> <head> <title>pod2man - Convert POD data to formatted *roff input - 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 podlators - MetaCPAN" href="/dist/podlators/releases.rss" /> <link rel="canonical" href="https://metacpan.org/dist/podlators/view/scripts/pod2man.PL" /> <meta name="description" content="Convert POD data to formatted *roff input" /> <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/podlators/view/scripts/pod2man.PL" /> <meta property="og:title" content="pod2man" /> <meta property="og:description" content="Convert POD data to formatted *roff input" /> <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 podlators was released."> <span class="relatize">14 Jul 2024 19:58:09 UTC</span> </div> </li> <li> Distribution: <a href="/dist/podlators">podlators</a> </li> <li> <a data-keyboard-shortcut="g s" href="/dist/podlators/source/scripts/pod2man.PL">Source</a> (<a href="/dist/podlators/source/scripts/pod2man.PL?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g b" href="/dist/podlators/source/scripts">Browse</a> (<a href="/dist/podlators/source/scripts?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g c" href="/dist/podlators/changes">Changes</a> </li> <li> <a rel="noopener nofollow" class="nopopup" href="https://www.eyrie.org/~eagle/software/podlators/">Homepage</a> </li> <li> <a class="nopopup" href="/dist/podlators/contribute">How to Contribute</a> </li> <li> <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/rra/podlators">Repository</a> </li> <li> <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://github.com/rra/podlators/issues">Issues</a> (2) </li> <li> <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=podlators+v6.0.2" title="Matrix">Testers</a> </li> <li> <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/RRA/podlators-v6.0.2">Kwalitee</a> </li> <li> <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on podlators 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.12.0 </li> <li class="nav-header">Activity</li> <li> <div class="activity-graph"> <img src="/dist/podlators/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/R/RR/RRA/podlators-v6.0.2.tar.gz"> Download (<span itemprop="fileSize">152.13KB</span>)</a> </li> <li> <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FRRA%2Fpodlators-v6.0.2%2Fscripts%2Fpod2man.PL"> MetaCPAN Explorer </a> </li> <li> <a href="/dist/podlators/permissions"> Permissions </a> </li> <li> <a href="/dist/podlators/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:podlators"> <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="podlators"> <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/RRA/podlators-v6.0.2/view/scripts/pod2man.PL" >v6.0.2 (RRA on 2024-07-14)</option> <option value="/release/RRA/podlators-v6.0.1/view/scripts/pod2man.PL" >v6.0.1 (RRA on 2024-07-13)</option> <option value="/release/RRA/podlators-v6.0.0/view/scripts/pod2man.PL" >v6.0.0 (RRA on 2024-07-11)</option> <option value="/release/RRA/podlators-5.01/view/scripts/pod2man.PL" >5.01 (RRA on 2022-12-25)</option> <option value="/release/RRA/podlators-4.14/view/scripts/pod2man.PL" >4.14 (RRA on 2020-01-04)</option> <optgroup label="BackPAN">' <option value="/release/RRA/podlators-5.00/view/scripts/pod2man.PL" >5.00 (RRA on 2022-11-25)</option> <option value="/release/RRA/podlators-4.13/view/scripts/pod2man.PL" >4.13 (RRA on 2019-12-26)</option> <option value="/release/RRA/podlators-4.12/view/scripts/pod2man.PL" >4.12 (RRA on 2019-06-01)</option> <option value="/release/RRA/podlators-4.11/view/scripts/pod2man.PL" >4.11 (RRA on 2018-05-07)</option> <option value="/release/RRA/podlators-4.10/view/scripts/pod2man.PL" >4.10 (RRA on 2017-12-25)</option> <option value="/release/RRA/podlators-4.09/view/scripts/pod2man.PL" >4.09 (RRA on 2016-11-05)</option> <option value="/release/RRA/podlators-4.08/view/scripts/pod2man.PL" >4.08 (RRA on 2016-09-25)</option> <option value="/release/RRA/podlators-4.07/view/scripts/pod2man.PL" >4.07 (RRA on 2016-03-21)</option> <option value="/release/RRA/podlators-4.06/view/scripts/pod2man.PL" >4.06 (RRA on 2016-02-01)</option> <option value="/release/RRA/podlators-4.05/view/scripts/pod2man.PL" >4.05 (RRA on 2016-01-16)</option> <option value="/release/RRA/podlators-4.04/view/scripts/pod2man.PL" >4.04 (RRA on 2016-01-03)</option> <option value="/release/RRA/podlators-4.03/view/scripts/pod2man.PL" >4.03 (RRA on 2015-12-06)</option> <option value="/release/RRA/podlators-4.02/view/scripts/pod2man.PL" >4.02 (RRA on 2015-12-03)</option> <option value="/release/RRA/podlators-2.5.3/view/scripts/pod2man.PL" >2.5.3 (RRA on 2013-10-06)</option> <option value="/release/RRA/podlators-2.5.2/view/scripts/pod2man.PL" >2.5.2 (RRA on 2013-09-22)</option> <option value="/release/RRA/podlators-2.5.1/view/scripts/pod2man.PL" >2.5.1 (RRA on 2013-02-28)</option> <option value="/release/RRA/podlators-2.5.0/view/scripts/pod2man.PL" >2.5.0 (RRA on 2013-01-02)</option> <option value="/release/RRA/podlators-2.4.2/view/scripts/pod2man.PL" >2.4.2 (RRA on 2012-06-01)</option> <option value="/release/RRA/podlators-2.4.1/view/scripts/pod2man.PL" >2.4.1 (RRA on 2012-05-30)</option> <option value="/release/RRA/podlators-2.4.0/view/scripts/pod2man.PL" >2.4.0 (RRA on 2010-10-11)</option> <option value="/release/RRA/podlators-2.3.1/view/scripts/pod2man.PL" >2.3.1 (RRA on 2010-02-18)</option> <option value="/release/RRA/podlators-2.3.0/view/scripts/pod2man.PL" >2.3.0 (RRA on 2009-12-29)</option> <option value="/release/RRA/podlators-2.2.2/view/scripts/pod2man.PL" >2.2.2 (RRA on 2009-01-18)</option> <option value="/release/RRA/podlators-2.2.1/view/scripts/pod2man.PL" >2.2.1 (RRA on 2008-12-20)</option> <option value="/release/RRA/podlators-2.2.0/view/scripts/pod2man.PL" >2.2.0 (RRA on 2008-10-05)</option> <option value="/release/RRA/podlators-2.1.4/view/scripts/pod2man.PL" >2.1.4 (RRA on 2008-09-22)</option> <option value="/release/RRA/podlators-2.1.3/view/scripts/pod2man.PL" >2.1.3 (RRA on 2008-09-14)</option> <option value="/release/RRA/podlators-2.1.2/view/scripts/pod2man.PL" >2.1.2 (RRA on 2008-07-21)</option> <option value="/release/RRA/podlators-2.1.1/view/scripts/pod2man.PL" >2.1.1 (RRA on 2008-07-04)</option> <option value="/release/RRA/podlators-2.1.0/view/scripts/pod2man.PL" >2.1.0 (RRA on 2008-06-02)</option> <option value="/release/RRA/podlators-2.0.6/view/scripts/pod2man.PL" >2.0.6 (RRA on 2007-11-29)</option> <option value="/release/RRA/podlators-2.0.5/view/scripts/pod2man.PL" >2.0.5 (RRA on 2006-09-16)</option> <option value="/release/RRA/podlators-2.0.4/view/scripts/pod2man.PL" >2.0.4 (RRA on 2006-02-19)</option> <option value="/release/RRA/podlators-2.0.3/view/scripts/pod2man.PL" >2.0.3 (RRA on 2006-01-28)</option> <option value="/release/RRA/podlators-2.0.2/view/scripts/pod2man.PL" >2.0.2 (RRA on 2006-01-26)</option> <option value="/release/RRA/podlators-2.0.1/view/scripts/pod2man.PL" >2.0.1 (RRA on 2006-01-21)</option> <option value="/release/RRA/podlators-2.00/view/scripts/pod2man.PL" >2.00 (RRA on 2005-11-29)</option> <option value="/release/RRA/podlators-1.27/view/scripts/pod2man.PL" >1.27 (RRA on 2003-07-09)</option> <option value="/release/RRA/podlators-1.26/view/scripts/pod2man.PL" >1.26 (RRA on 2003-03-30)</option> <option value="/release/RRA/podlators-1.25/view/scripts/pod2man.PL" >1.25 (RRA on 2003-01-05)</option> <option value="/release/RRA/podlators-1.24/view/scripts/pod2man.PL" >1.24 (RRA on 2002-08-04)</option> <option value="/release/RRA/podlators-1.23/view/scripts/pod2man.PL" >1.23 (RRA on 2002-07-15)</option> <option value="/release/RRA/podlators-1.22/view/scripts/pod2man.PL" >1.22 (RRA on 2002-06-23)</option> <option value="/release/RRA/podlators-1.21/view/scripts/pod2man.PL" >1.21 (RRA on 2002-02-17)</option> <option value="/release/RRA/podlators-1.20/view/scripts/pod2man.PL" >1.20 (RRA on 2002-01-28)</option> <option value="/release/RRA/podlators-1.19/view/scripts/pod2man.PL" >1.19 (RRA on 2002-01-02)</option> <option value="/release/RRA/podlators-1.18/view/scripts/pod2man.PL" >1.18 (RRA on 2001-12-01)</option> <option value="/release/RRA/podlators-1.17/view/scripts/pod2man.PL" >1.17 (RRA on 2001-11-28)</option> <option value="/release/RRA/podlators-1.16/view/scripts/pod2man.PL" >1.16 (RRA on 2001-11-26)</option> <option value="/release/RRA/podlators-1.15/view/scripts/pod2man.PL" >1.15 (RRA on 2001-11-26)</option> <option value="/release/RRA/podlators-1.14/view/scripts/pod2man.PL" >1.14 (RRA on 2001-11-23)</option> <option value="/release/RRA/podlators-1.13/view/scripts/pod2man.PL" >1.13 (RRA on 2001-11-15)</option> <option value="/release/RRA/podlators-1.12/view/scripts/pod2man.PL" >1.12 (RRA on 2001-11-15)</option> <option value="/release/RRA/podlators-1.11/view/scripts/pod2man.PL" >1.11 (RRA on 2001-10-20)</option> <option value="/release/RRA/podlators-1.10/view/scripts/pod2man.PL" >1.10 (RRA on 2001-07-10)</option> <option value="/release/RRA/podlators-1.09/view/scripts/pod2man.PL" >1.09 (RRA on 2001-04-09)</option> <option value="/release/RRA/podlators-1.08/view/scripts/pod2man.PL" >1.08 (RRA on 2001-02-10)</option> <option value="/release/RRA/podlators-1.07/view/scripts/pod2man.PL" >1.07 (RRA on 2001-01-16)</option> <option value="/release/RRA/podlators-1.06/view/scripts/pod2man.PL" >1.06 (RRA on 2000-12-25)</option> <option value="/release/RRA/podlators-1.05/view/scripts/pod2man.PL" >1.05 (RRA on 2000-11-19)</option> <option value="/release/RRA/podlators-1.04/view/scripts/pod2man.PL" >1.04 (RRA on 2000-10-10)</option> <option value="/release/RRA/podlators-1.03/view/scripts/pod2man.PL" >1.03 (RRA on 2000-09-03)</option> <option value="/release/RRA/podlators-1.02/view/scripts/pod2man.PL" >1.02 (RRA on 2000-04-26)</option> <option value="/release/RRA/podlators-1.01/view/scripts/pod2man.PL" >1.01 (RRA on 2000-03-31)</option> <option value="/release/RRA/podlators-1.00/view/scripts/pod2man.PL" >1.00 (RRA on 2000-03-17)</option> <option value="/release/RRA/podlators-0.08/view/scripts/pod2man.PL" >0.08 (RRA on 1999-10-07)</option> <option value="/release/RRA/podlators-0.07/view/scripts/pod2man.PL" >0.07 (RRA on 1999-09-25)</option> <option value="/release/RRA/podlators-0.06/view/scripts/pod2man.PL" >0.06 (RRA on 1999-09-21)</option> <option value="/release/RRA/podlators-0.02/view/scripts/pod2man.PL" >0.02 (RRA on 1999-07-29)</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/RRA/podlators-v6.0.2/diff/RRA/podlators-v6.0.2/scripts/pod2man.PL" >v6.0.2 (RRA on 2024-07-14)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-v6.0.1/scripts/pod2man.PL" >v6.0.1 (RRA on 2024-07-13)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-v6.0.0/scripts/pod2man.PL" >v6.0.0 (RRA on 2024-07-11)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-5.01/scripts/pod2man.PL" >5.01 (RRA on 2022-12-25)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.14/scripts/pod2man.PL" >4.14 (RRA on 2020-01-04)</option> <optgroup label="BackPAN">' <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-5.00/scripts/pod2man.PL" >5.00 (RRA on 2022-11-25)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.13/scripts/pod2man.PL" >4.13 (RRA on 2019-12-26)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.12/scripts/pod2man.PL" >4.12 (RRA on 2019-06-01)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.11/scripts/pod2man.PL" >4.11 (RRA on 2018-05-07)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.10/scripts/pod2man.PL" >4.10 (RRA on 2017-12-25)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.09/scripts/pod2man.PL" >4.09 (RRA on 2016-11-05)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.08/scripts/pod2man.PL" >4.08 (RRA on 2016-09-25)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.07/scripts/pod2man.PL" >4.07 (RRA on 2016-03-21)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.06/scripts/pod2man.PL" >4.06 (RRA on 2016-02-01)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.05/scripts/pod2man.PL" >4.05 (RRA on 2016-01-16)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.04/scripts/pod2man.PL" >4.04 (RRA on 2016-01-03)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.03/scripts/pod2man.PL" >4.03 (RRA on 2015-12-06)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-4.02/scripts/pod2man.PL" >4.02 (RRA on 2015-12-03)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.5.3/scripts/pod2man.PL" >2.5.3 (RRA on 2013-10-06)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.5.2/scripts/pod2man.PL" >2.5.2 (RRA on 2013-09-22)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.5.1/scripts/pod2man.PL" >2.5.1 (RRA on 2013-02-28)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.5.0/scripts/pod2man.PL" >2.5.0 (RRA on 2013-01-02)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.4.2/scripts/pod2man.PL" >2.4.2 (RRA on 2012-06-01)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.4.1/scripts/pod2man.PL" >2.4.1 (RRA on 2012-05-30)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.4.0/scripts/pod2man.PL" >2.4.0 (RRA on 2010-10-11)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.3.1/scripts/pod2man.PL" >2.3.1 (RRA on 2010-02-18)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.3.0/scripts/pod2man.PL" >2.3.0 (RRA on 2009-12-29)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.2.2/scripts/pod2man.PL" >2.2.2 (RRA on 2009-01-18)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.2.1/scripts/pod2man.PL" >2.2.1 (RRA on 2008-12-20)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.2.0/scripts/pod2man.PL" >2.2.0 (RRA on 2008-10-05)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.1.4/scripts/pod2man.PL" >2.1.4 (RRA on 2008-09-22)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.1.3/scripts/pod2man.PL" >2.1.3 (RRA on 2008-09-14)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.1.2/scripts/pod2man.PL" >2.1.2 (RRA on 2008-07-21)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.1.1/scripts/pod2man.PL" >2.1.1 (RRA on 2008-07-04)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.1.0/scripts/pod2man.PL" >2.1.0 (RRA on 2008-06-02)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.0.6/scripts/pod2man.PL" >2.0.6 (RRA on 2007-11-29)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.0.5/scripts/pod2man.PL" >2.0.5 (RRA on 2006-09-16)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.0.4/scripts/pod2man.PL" >2.0.4 (RRA on 2006-02-19)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.0.3/scripts/pod2man.PL" >2.0.3 (RRA on 2006-01-28)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.0.2/scripts/pod2man.PL" >2.0.2 (RRA on 2006-01-26)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.0.1/scripts/pod2man.PL" >2.0.1 (RRA on 2006-01-21)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-2.00/scripts/pod2man.PL" >2.00 (RRA on 2005-11-29)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.27/scripts/pod2man.PL" >1.27 (RRA on 2003-07-09)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.26/scripts/pod2man.PL" >1.26 (RRA on 2003-03-30)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.25/scripts/pod2man.PL" >1.25 (RRA on 2003-01-05)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.24/scripts/pod2man.PL" >1.24 (RRA on 2002-08-04)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.23/scripts/pod2man.PL" >1.23 (RRA on 2002-07-15)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.22/scripts/pod2man.PL" >1.22 (RRA on 2002-06-23)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.21/scripts/pod2man.PL" >1.21 (RRA on 2002-02-17)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.20/scripts/pod2man.PL" >1.20 (RRA on 2002-01-28)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.19/scripts/pod2man.PL" >1.19 (RRA on 2002-01-02)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.18/scripts/pod2man.PL" >1.18 (RRA on 2001-12-01)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.17/scripts/pod2man.PL" >1.17 (RRA on 2001-11-28)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.16/scripts/pod2man.PL" >1.16 (RRA on 2001-11-26)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.15/scripts/pod2man.PL" >1.15 (RRA on 2001-11-26)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.14/scripts/pod2man.PL" >1.14 (RRA on 2001-11-23)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.13/scripts/pod2man.PL" >1.13 (RRA on 2001-11-15)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.12/scripts/pod2man.PL" >1.12 (RRA on 2001-11-15)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.11/scripts/pod2man.PL" >1.11 (RRA on 2001-10-20)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.10/scripts/pod2man.PL" >1.10 (RRA on 2001-07-10)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.09/scripts/pod2man.PL" >1.09 (RRA on 2001-04-09)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.08/scripts/pod2man.PL" >1.08 (RRA on 2001-02-10)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.07/scripts/pod2man.PL" >1.07 (RRA on 2001-01-16)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.06/scripts/pod2man.PL" >1.06 (RRA on 2000-12-25)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.05/scripts/pod2man.PL" >1.05 (RRA on 2000-11-19)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.04/scripts/pod2man.PL" >1.04 (RRA on 2000-10-10)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.03/scripts/pod2man.PL" >1.03 (RRA on 2000-09-03)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.02/scripts/pod2man.PL" >1.02 (RRA on 2000-04-26)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.01/scripts/pod2man.PL" >1.01 (RRA on 2000-03-31)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-1.00/scripts/pod2man.PL" >1.00 (RRA on 2000-03-17)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-0.08/scripts/pod2man.PL" >0.08 (RRA on 1999-10-07)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-0.07/scripts/pod2man.PL" >0.07 (RRA on 1999-09-25)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-0.06/scripts/pod2man.PL" >0.06 (RRA on 1999-09-21)</option> <option value="/release/RRA/podlators-v6.0.2/diff/RRA/podlators-0.02/scripts/pod2man.PL" >0.02 (RRA on 1999-07-29)</option> </optgroup> </select> </li> <li> <ul class="dependencies"> <li class="nav-header">Dependencies</li> <li><a href="/pod/Pod::Simple" title="Pod::Simple" class="ellipsis">Pod::Simple</a></li> <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li> <li> <hr> </li> <li> <a href="/module/pod2man/requires">Reverse dependencies</a> </li> <li> <a href="http://deps.cpantesters.org/?module=pod2man">CPAN Testers List</a> </li> <li> <a href="https://cpandeps.grinnz.com/?dist=podlators">Dependency graph</a> </li> </ul> </li> <li class="nav-header">Permalinks</li> <li> <a href="/release/RRA/podlators-v6.0.2/view/scripts/pod2man.PL">This version</a> </li> <li> <a href="/dist/podlators/view/scripts/pod2man.PL">Latest version</a> </li> <li> <div class="plussers"> <div class="nav-header">++ed by:</div> <div> <a class="display-all" href="/author/KEEDI"><img src="https://www.gravatar.com/avatar/95f905a7a4ccc573c711e9d264c0fde8?d=identicon&s=20" title="KEEDI" alt="KEEDI"></a> <a class="display-all" href="/author/ADAMJS"><img src="https://www.gravatar.com/avatar/62c7b6e864d6509cff5839543c676614?d=identicon&s=20" title="ADAMJS" alt="ADAMJS"></a> <a class="display-all" href="/author/MFZZ"><img src="https://www.gravatar.com/avatar/0f2eaa76d2775840f2ca64befbb2c87c?d=identicon&s=20" title="MFZZ" alt="MFZZ"></a> <a class="display-all" href="/author/IGORTSIG"><img src="https://www.gravatar.com/avatar/2f0e9b8c5ded50fd8cd7ff18aff6b237?d=identicon&s=20" title="IGORTSIG" alt="IGORTSIG"></a> <a class="display-all" href="/author/RRWO"><img src="https://www.gravatar.com/avatar/4a5274bc5d690ee3d619f044778771a7?d=identicon&s=20" title="RRWO" alt="RRWO"></a> </div> <!-- Display counts of plussers--> <div> <a href="/dist/podlators/plussers">8 PAUSE users</a> </div> <div> 6 non-PAUSE users </div> </div> </li> <li> </li> </ul> </div> </nav> <div class="content-navigation"> <div class="breadcrumbs"> <span> <a data-keyboard-shortcut="g a" rel="author" href="/author/RRA" class="author-name">Russ Allbery</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/RRA/podlators-v6.0.2/view/scripts/pod2man.PL" >v6.0.2 (RRA on 2024-07-14)</option> <option value="/release/RRA/podlators-v6.0.1/view/scripts/pod2man.PL" >v6.0.1 (RRA on 2024-07-13)</option> <option value="/release/RRA/podlators-v6.0.0/view/scripts/pod2man.PL" >v6.0.0 (RRA on 2024-07-11)</option> <option value="/release/RRA/podlators-5.01/view/scripts/pod2man.PL" >5.01 (RRA on 2022-12-25)</option> <option value="/release/RRA/podlators-4.14/view/scripts/pod2man.PL" >4.14 (RRA on 2020-01-04)</option> <optgroup label="BackPAN">' <option value="/release/RRA/podlators-5.00/view/scripts/pod2man.PL" >5.00 (RRA on 2022-11-25)</option> <option value="/release/RRA/podlators-4.13/view/scripts/pod2man.PL" >4.13 (RRA on 2019-12-26)</option> <option value="/release/RRA/podlators-4.12/view/scripts/pod2man.PL" >4.12 (RRA on 2019-06-01)</option> <option value="/release/RRA/podlators-4.11/view/scripts/pod2man.PL" >4.11 (RRA on 2018-05-07)</option> <option value="/release/RRA/podlators-4.10/view/scripts/pod2man.PL" >4.10 (RRA on 2017-12-25)</option> <option value="/release/RRA/podlators-4.09/view/scripts/pod2man.PL" >4.09 (RRA on 2016-11-05)</option> <option value="/release/RRA/podlators-4.08/view/scripts/pod2man.PL" >4.08 (RRA on 2016-09-25)</option> <option value="/release/RRA/podlators-4.07/view/scripts/pod2man.PL" >4.07 (RRA on 2016-03-21)</option> <option value="/release/RRA/podlators-4.06/view/scripts/pod2man.PL" >4.06 (RRA on 2016-02-01)</option> <option value="/release/RRA/podlators-4.05/view/scripts/pod2man.PL" >4.05 (RRA on 2016-01-16)</option> <option value="/release/RRA/podlators-4.04/view/scripts/pod2man.PL" >4.04 (RRA on 2016-01-03)</option> <option value="/release/RRA/podlators-4.03/view/scripts/pod2man.PL" >4.03 (RRA on 2015-12-06)</option> <option value="/release/RRA/podlators-4.02/view/scripts/pod2man.PL" >4.02 (RRA on 2015-12-03)</option> <option value="/release/RRA/podlators-2.5.3/view/scripts/pod2man.PL" >2.5.3 (RRA on 2013-10-06)</option> <option value="/release/RRA/podlators-2.5.2/view/scripts/pod2man.PL" >2.5.2 (RRA on 2013-09-22)</option> <option value="/release/RRA/podlators-2.5.1/view/scripts/pod2man.PL" >2.5.1 (RRA on 2013-02-28)</option> <option value="/release/RRA/podlators-2.5.0/view/scripts/pod2man.PL" >2.5.0 (RRA on 2013-01-02)</option> <option value="/release/RRA/podlators-2.4.2/view/scripts/pod2man.PL" >2.4.2 (RRA on 2012-06-01)</option> <option value="/release/RRA/podlators-2.4.1/view/scripts/pod2man.PL" >2.4.1 (RRA on 2012-05-30)</option> <option value="/release/RRA/podlators-2.4.0/view/scripts/pod2man.PL" >2.4.0 (RRA on 2010-10-11)</option> <option value="/release/RRA/podlators-2.3.1/view/scripts/pod2man.PL" >2.3.1 (RRA on 2010-02-18)</option> <option value="/release/RRA/podlators-2.3.0/view/scripts/pod2man.PL" >2.3.0 (RRA on 2009-12-29)</option> <option value="/release/RRA/podlators-2.2.2/view/scripts/pod2man.PL" >2.2.2 (RRA on 2009-01-18)</option> <option value="/release/RRA/podlators-2.2.1/view/scripts/pod2man.PL" >2.2.1 (RRA on 2008-12-20)</option> <option value="/release/RRA/podlators-2.2.0/view/scripts/pod2man.PL" >2.2.0 (RRA on 2008-10-05)</option> <option value="/release/RRA/podlators-2.1.4/view/scripts/pod2man.PL" >2.1.4 (RRA on 2008-09-22)</option> <option value="/release/RRA/podlators-2.1.3/view/scripts/pod2man.PL" >2.1.3 (RRA on 2008-09-14)</option> <option value="/release/RRA/podlators-2.1.2/view/scripts/pod2man.PL" >2.1.2 (RRA on 2008-07-21)</option> <option value="/release/RRA/podlators-2.1.1/view/scripts/pod2man.PL" >2.1.1 (RRA on 2008-07-04)</option> <option value="/release/RRA/podlators-2.1.0/view/scripts/pod2man.PL" >2.1.0 (RRA on 2008-06-02)</option> <option value="/release/RRA/podlators-2.0.6/view/scripts/pod2man.PL" >2.0.6 (RRA on 2007-11-29)</option> <option value="/release/RRA/podlators-2.0.5/view/scripts/pod2man.PL" >2.0.5 (RRA on 2006-09-16)</option> <option value="/release/RRA/podlators-2.0.4/view/scripts/pod2man.PL" >2.0.4 (RRA on 2006-02-19)</option> <option value="/release/RRA/podlators-2.0.3/view/scripts/pod2man.PL" >2.0.3 (RRA on 2006-01-28)</option> <option value="/release/RRA/podlators-2.0.2/view/scripts/pod2man.PL" >2.0.2 (RRA on 2006-01-26)</option> <option value="/release/RRA/podlators-2.0.1/view/scripts/pod2man.PL" >2.0.1 (RRA on 2006-01-21)</option> <option value="/release/RRA/podlators-2.00/view/scripts/pod2man.PL" >2.00 (RRA on 2005-11-29)</option> <option value="/release/RRA/podlators-1.27/view/scripts/pod2man.PL" >1.27 (RRA on 2003-07-09)</option> <option value="/release/RRA/podlators-1.26/view/scripts/pod2man.PL" >1.26 (RRA on 2003-03-30)</option> <option value="/release/RRA/podlators-1.25/view/scripts/pod2man.PL" >1.25 (RRA on 2003-01-05)</option> <option value="/release/RRA/podlators-1.24/view/scripts/pod2man.PL" >1.24 (RRA on 2002-08-04)</option> <option value="/release/RRA/podlators-1.23/view/scripts/pod2man.PL" >1.23 (RRA on 2002-07-15)</option> <option value="/release/RRA/podlators-1.22/view/scripts/pod2man.PL" >1.22 (RRA on 2002-06-23)</option> <option value="/release/RRA/podlators-1.21/view/scripts/pod2man.PL" >1.21 (RRA on 2002-02-17)</option> <option value="/release/RRA/podlators-1.20/view/scripts/pod2man.PL" >1.20 (RRA on 2002-01-28)</option> <option value="/release/RRA/podlators-1.19/view/scripts/pod2man.PL" >1.19 (RRA on 2002-01-02)</option> <option value="/release/RRA/podlators-1.18/view/scripts/pod2man.PL" >1.18 (RRA on 2001-12-01)</option> <option value="/release/RRA/podlators-1.17/view/scripts/pod2man.PL" >1.17 (RRA on 2001-11-28)</option> <option value="/release/RRA/podlators-1.16/view/scripts/pod2man.PL" >1.16 (RRA on 2001-11-26)</option> <option value="/release/RRA/podlators-1.15/view/scripts/pod2man.PL" >1.15 (RRA on 2001-11-26)</option> <option value="/release/RRA/podlators-1.14/view/scripts/pod2man.PL" >1.14 (RRA on 2001-11-23)</option> <option value="/release/RRA/podlators-1.13/view/scripts/pod2man.PL" >1.13 (RRA on 2001-11-15)</option> <option value="/release/RRA/podlators-1.12/view/scripts/pod2man.PL" >1.12 (RRA on 2001-11-15)</option> <option value="/release/RRA/podlators-1.11/view/scripts/pod2man.PL" >1.11 (RRA on 2001-10-20)</option> <option value="/release/RRA/podlators-1.10/view/scripts/pod2man.PL" >1.10 (RRA on 2001-07-10)</option> <option value="/release/RRA/podlators-1.09/view/scripts/pod2man.PL" >1.09 (RRA on 2001-04-09)</option> <option value="/release/RRA/podlators-1.08/view/scripts/pod2man.PL" >1.08 (RRA on 2001-02-10)</option> <option value="/release/RRA/podlators-1.07/view/scripts/pod2man.PL" >1.07 (RRA on 2001-01-16)</option> <option value="/release/RRA/podlators-1.06/view/scripts/pod2man.PL" >1.06 (RRA on 2000-12-25)</option> <option value="/release/RRA/podlators-1.05/view/scripts/pod2man.PL" >1.05 (RRA on 2000-11-19)</option> <option value="/release/RRA/podlators-1.04/view/scripts/pod2man.PL" >1.04 (RRA on 2000-10-10)</option> <option value="/release/RRA/podlators-1.03/view/scripts/pod2man.PL" >1.03 (RRA on 2000-09-03)</option> <option value="/release/RRA/podlators-1.02/view/scripts/pod2man.PL" >1.02 (RRA on 2000-04-26)</option> <option value="/release/RRA/podlators-1.01/view/scripts/pod2man.PL" >1.01 (RRA on 2000-03-31)</option> <option value="/release/RRA/podlators-1.00/view/scripts/pod2man.PL" >1.00 (RRA on 2000-03-17)</option> <option value="/release/RRA/podlators-0.08/view/scripts/pod2man.PL" >0.08 (RRA on 1999-10-07)</option> <option value="/release/RRA/podlators-0.07/view/scripts/pod2man.PL" >0.07 (RRA on 1999-09-25)</option> <option value="/release/RRA/podlators-0.06/view/scripts/pod2man.PL" >0.06 (RRA on 1999-09-21)</option> <option value="/release/RRA/podlators-0.02/view/scripts/pod2man.PL" >0.02 (RRA on 1999-07-29)</option> </optgroup> </select> <a data-keyboard-shortcut="g d" class="release-name" href="/dist/podlators">podlators-v6.0.2</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 • 66 direct dependents • 33355 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="podlators-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="podlators-v6.0.2"> <input type="hidden" name="author" value="RRA"> <input type="hidden" name="distribution" value="podlators"> <button type="submit" class="favorite highlight"><span>14</span> ++</button> </form> </div> <div class="show-logged-out"> <button class="fav-not-logged-in favorite highlight"><span>14</span> ++</button> </div> / <span>pod2man</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="#DESCRIPTION">DESCRIPTION</a></li> <li><a href="#OPTIONS">OPTIONS</a></li> <li><a href="#EXIT-STATUS">EXIT STATUS</a></li> <li><a href="#DIAGNOSTICS">DIAGNOSTICS</a></li> <li><a href="#EXAMPLES">EXAMPLES</a></li> <li><a href="#AUTHOR">AUTHOR</a></li> <li><a href="#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></li> <li><a href="#SEE-ALSO">SEE ALSO</a></li> </ul></nav> <div class="pod anchors"> <h1 id="NAME">NAME</h1> <p>pod2man - Convert POD data to formatted *roff input</p> <h1 id="SYNOPSIS">SYNOPSIS</h1> <p>pod2man [<b>--center</b>=<i>string</i>] [<b>--date</b>=<i>string</i>] [<b>--encoding</b>=<i>encoding</i>] [<b>--errors</b>=<i>style</i>] [<b>--fixed</b>=<i>font</i>] [<b>--fixedbold</b>=<i>font</i>] [<b>--fixeditalic</b>=<i>font</i>] [<b>--fixedbolditalic</b>=<i>font</i>] [<b>--guesswork</b>=<i>rule</i>[,<i>rule</i>...]] [<b>--name</b>=<i>name</i>] [<b>--nourls</b>] [<b>--official</b>] [<b>--release</b>=<i>version</i>] [<b>--section</b>=<i>manext</i>] [<b>--quotes</b>=<i>quotes</i>] [<b>--lquote</b>=<i>quote</i>] [<b>--rquote</b>=<i>quote</i>] [<b>--stderr</b>] [<b>--utf8</b>] [<b>--verbose</b>] [<i>input</i> [<i>output</i>] ...]</p> <p>pod2man <b>--help</b></p> <h1 id="DESCRIPTION">DESCRIPTION</h1> <p><b>pod2man</b> is a wrapper script around the <a href="/pod/Pod::Man">Pod::Man</a> module, using it to generate *roff input from POD source. The resulting *roff code is suitable for display on a terminal using <a href="http://man.he.net/man1/nroff">nroff(1)</a>, normally via <a href="http://man.he.net/man1/man">man(1)</a>, or printing using <a href="http://man.he.net/man1/troff">troff(1)</a>.</p> <p>By default (on non-EBCDIC systems), <b>pod2man</b> outputs UTF-8 manual pages. Its output should work with the <b>man</b> program on systems that use <b>groff</b> (most Linux distributions) or <b>mandoc</b> (most BSD variants), but may result in mangled output on older UNIX systems. To choose a different, possibly more backward-compatible output mangling on such systems, use <code>--encoding=roff</code> (the default in earlier Pod::Man versions). See the <b>--encoding</b> option and <a href="/pod/Pod::Man#ENCODING">"ENCODING" in Pod::Man</a> for more details.</p> <p><i>input</i> is the file to read for POD source (the POD can be embedded in code). If <i>input</i> isn't given, it defaults to <code>STDIN</code>. <i>output</i>, if given, is the file to which to write the formatted output. If <i>output</i> isn't given, the formatted output is written to <code>STDOUT</code>. Several POD files can be processed in the same <b>pod2man</b> invocation (saving module load and compile times) by providing multiple pairs of <i>input</i> and <i>output</i> files on the command line.</p> <p><b>--section</b>, <b>--release</b>, <b>--center</b>, <b>--date</b>, and <b>--official</b> can be used to set the headers and footers to use. If not given, Pod::Man will assume various defaults. See below for details.</p> <p>For specific details and caveats about the translation from POD to *roff, see <a href="/pod/Pod::Man#CAVEATS">"CAVEATS" in Pod::Man</a>.</p> <h1 id="OPTIONS">OPTIONS</h1> <p>Each option is annotated with the version of podlators in which that option was added with its current meaning.</p> <dl> <dt id="-c-string,-center=string"><a id="c-string---center-string"></a><b>-c</b> <i>string</i>, <b>--center</b>=<i>string</i></dt> <dd> <p>[1.00] Sets the centered page header for the <code>.TH</code> macro to <i>string</i>. The default is <code>User Contributed Perl Documentation</code>, but also see <b>--official</b> below.</p> </dd> <dt id="-d-string,-date=string"><a id="d-string---date-string"></a><b>-d</b> <i>string</i>, <b>--date</b>=<i>string</i></dt> <dd> <p>[4.00] Set the left-hand footer string for the <code>.TH</code> macro to <i>string</i>. By default, the first of POD_MAN_DATE, SOURCE_DATE_EPOCH, the modification date of the input file, or the current date (if input comes from <code>STDIN</code>) will be used, and the date will be in UTC. See <a href="/pod/Pod::Man#CLASS-METHODS">"CLASS METHODS" in Pod::Man</a> for more details.</p> </dd> <dt id="-e-encoding,-encoding=encoding"><a id="e-encoding---encoding-encoding"></a><b>-e</b> <i>encoding</i>, <b>--encoding</b>=<i>encoding</i></dt> <dd> <p>[5.00] Specifies the encoding of the output. <i>encoding</i> must be an encoding recognized by the <a href="/pod/Encode">Encode</a> module (see <a href="/pod/Encode::Supported">Encode::Supported</a>). The default on non-EBCDIC systems is UTF-8.</p> <p>If the output contains characters that cannot be represented in this encoding, that is an error that will be reported as configured by the <b>--errors</b> option. If error handling is other than <code>die</code>, the unrepresentable character will be replaced with the Encode substitution character (normally <code>?</code>).</p> <p>If the <code>encoding</code> option is set to the special value <code>groff</code> (the default on EBCDIC systems), or if the Encode module is not available and the encoding is set to anything other than <code>roff</code> (see below), Pod::Man will translate all non-ASCII characters to <code>\[uNNNN]</code> Unicode escapes. These are not traditionally part of the *roff language, but are supported by <b>groff</b> and <b>mandoc</b> and thus by the majority of manual page processors in use today.</p> <p>If <i>encoding</i> is set to the special value <code>roff</code>, <b>pod2man</b> will do its historic transformation of (some) ISO 8859-1 characters into *roff escapes that may be adequate in troff and may be readable (if ugly) in nroff. This was the default behavior of versions of <b>pod2man</b> before 5.00. With this encoding, all other non-ASCII characters will be replaced with <code>X</code>. It may be required for very old troff and nroff implementations that do not support UTF-8, but its representation of any non-ASCII character is very poor and often specific to European languages. Its use is discouraged.</p> <p>WARNING: The input encoding of the POD source is independent from the output encoding, and setting this option does not affect the interpretation of the POD input. Unless your POD source is US-ASCII, its encoding should be declared with the <code>=encoding</code> command in the source. If this is not done, Pod::Simple will will attempt to guess the encoding and may be successful if it's Latin-1 or UTF-8, but it will produce warnings. See <a href="http://man.he.net/man1/perlpod">perlpod(1)</a> for more information.</p> </dd> <dt id="-errors=style"><a id="errors-style"></a><b>--errors</b>=<i>style</i></dt> <dd> <p>[2.5.0] Set the error handling style. <code>die</code> says to throw an exception on any POD formatting error. <code>stderr</code> says to report errors on standard error, but not to throw an exception. <code>pod</code> says to include a POD ERRORS section in the resulting documentation summarizing the errors. <code>none</code> ignores POD errors entirely, as much as possible.</p> <p>The default is <code>die</code>.</p> </dd> <dt id="-fixed=font"><a id="fixed-font"></a><b>--fixed</b>=<i>font</i></dt> <dd> <p>[1.0] The fixed-width font to use for verbatim text and code. Defaults to <code>CW</code>. Some systems may want <code>CR</code> instead. Only matters for <b>troff</b> output.</p> </dd> <dt id="-fixedbold=font"><a id="fixedbold-font"></a><b>--fixedbold</b>=<i>font</i></dt> <dd> <p>[1.0] Bold version of the fixed-width font. Defaults to <code>CB</code>. Only matters for <b>troff</b> output.</p> </dd> <dt id="-fixeditalic=font"><a id="fixeditalic-font"></a><b>--fixeditalic</b>=<i>font</i></dt> <dd> <p>[1.0] Italic version of the fixed-width font (something of a misnomer, since most fixed-width fonts only have an oblique version, not an italic version). Defaults to <code>CI</code>. Only matters for <b>troff</b> output.</p> </dd> <dt id="-fixedbolditalic=font"><a id="fixedbolditalic-font"></a><b>--fixedbolditalic</b>=<i>font</i></dt> <dd> <p>[1.0] Bold italic (in theory, probably oblique in practice) version of the fixed-width font. Pod::Man doesn't assume you have this, and defaults to <code>CB</code>. Some systems (such as Solaris) have this font available as <code>CX</code>. Only matters for <b>troff</b> output.</p> </dd> <dt id="-guesswork=rule[,rule...]"><a id="guesswork-rule-rule"></a><b>--guesswork</b>=<i>rule</i>[,<i>rule</i>...]</dt> <dd> <p>[5.00] By default, <b>pod2man</b> applies some default formatting rules based on guesswork and regular expressions that are intended to make writing Perl documentation easier and require less explicit markup. These rules may not always be appropriate, particularly for documentation that isn't about Perl. This option allows turning all or some of it off.</p> <p>The special rule <code>all</code> enables all guesswork. This is also the default for backward compatibility reasons. The special rule <code>none</code> disables all guesswork. Otherwise, the value of this option should be a comma-separated list of one or more of the following keywords:</p> <dl> <dt id="functions">functions</dt> <dd> <p>Convert function references like <code>foo()</code> to bold even if they have no markup. The function name accepts valid Perl characters for function names (including <code>:</code>), and the trailing parentheses must be present and empty.</p> </dd> <dt id="manref">manref</dt> <dd> <p>Make the first part (before the parentheses) of man page references like <code>foo(1)</code> bold even if they have no markup. The section must be a single number optionally followed by lowercase letters.</p> </dd> <dt id="quoting">quoting</dt> <dd> <p>If no guesswork is enabled, any text enclosed in C<> is surrounded by double quotes in nroff (terminal) output unless the contents are already quoted. When this guesswork is enabled, quote marks will also be suppressed for Perl variables, function names, function calls, numbers, and hex constants.</p> </dd> <dt id="variables">variables</dt> <dd> <p>Convert Perl variable names to a fixed-width font even if they have no markup. This transformation will only be apparent in troff output, or some other output format (unlike nroff terminal output) that supports fixed-width fonts.</p> </dd> </dl> <p>Any unknown guesswork name is silently ignored (for potential future compatibility), so be careful about spelling.</p> </dd> <dt id="-h,-help"><a id="h---help"></a><b>-h</b>, <b>--help</b></dt> <dd> <p>[1.00] Print out usage information.</p> </dd> <dt id="-l,-lax"><a id="l---lax"></a><b>-l</b>, <b>--lax</b></dt> <dd> <p>[1.00] No longer used. <b>pod2man</b> used to check its input for validity as a manual page, but this should now be done by <a href="http://man.he.net/man1/podchecker">podchecker(1)</a> instead. Accepted for backward compatibility; this option no longer does anything.</p> </dd> <dt id="-language=language"><a id="language-language"></a><b>--language</b>=<i>language</i></dt> <dd> <p>[5.00] Add commands telling <b>groff</b> that the input file is in the given language. The value of this setting must be a language abbreviation for which <b>groff</b> provides supplemental configuration, such as <code>ja</code> (for Japanese) or <code>zh</code> (for Chinese).</p> <p>This adds:</p> <pre><code>.mso <language>.tmac .hla <language></code></pre> <p>to the start of the file, which configure correct line breaking for the specified language. Without these commands, groff may not know how to add proper line breaks for Chinese and Japanese text if the man page is installed into the normal man page directory, such as <i>/usr/share/man</i>.</p> <p>On many systems, this will be done automatically if the man page is installed into a language-specific man page directory, such as <i>/usr/share/man/zh_CN</i>. In that case, this option is not required.</p> <p>Unfortunately, the commands added with this option are specific to <b>groff</b> and will not work with other <b>troff</b> and <b>nroff</b> implementations.</p> </dd> <dt id="-lquote=quote"><a id="lquote-quote"></a><b>--lquote</b>=<i>quote</i></dt> <dd> </dd> <dt id="-rquote=quote"><a id="rquote-quote"></a><b>--rquote</b>=<i>quote</i></dt> <dd> <p>[4.08] Sets the quote marks used to surround C<> text. <b>--lquote</b> sets the left quote mark and <b>--rquote</b> sets the right quote mark. Either may also be set to the special value <code>none</code>, in which case no quote mark is added on that side of C<> text (but the font is still changed for troff output).</p> <p>Also see the <b>--quotes</b> option, which can be used to set both quotes at once. If both <b>--quotes</b> and one of the other options is set, <b>--lquote</b> or <b>--rquote</b> overrides <b>--quotes</b>.</p> </dd> <dt id="-n-name,-name=name"><a id="n-name---name-name"></a><b>-n</b> <i>name</i>, <b>--name</b>=<i>name</i></dt> <dd> <p>[4.08] Set the name of the manual page for the <code>.TH</code> macro to <i>name</i>. Without this option, the manual name is set to the uppercased base name of the file being converted unless the manual section is 3, in which case the path is parsed to see if it is a Perl module path. If it is, a path like <code>.../lib/Pod/Man.pm</code> is converted into a name like <code>Pod::Man</code>. This option, if given, overrides any automatic determination of the name.</p> <p>Although one does not have to follow this convention, be aware that the convention for UNIX manual pages is for the title to be in all-uppercase, even if the command isn't. (Perl modules traditionally use mixed case for the manual page title, however.)</p> <p>This option is probably not useful when converting multiple POD files at once.</p> <p>When converting POD source from standard input, the name will be set to <code>STDIN</code> if this option is not provided. Providing this option is strongly recommended to set a meaningful manual page name.</p> </dd> <dt id="-nourls"><a id="nourls"></a><b>--nourls</b></dt> <dd> <p>[2.5.0] Normally, L<> formatting codes with a URL but anchor text are formatted to show both the anchor text and the URL. In other words:</p> <pre><code>L<foo|http://example.com/></code></pre> <p>is formatted as:</p> <pre><code>foo <http://example.com/></code></pre> <p>This flag, if given, suppresses the URL when anchor text is given, so this example would be formatted as just <code>foo</code>. This can produce less cluttered output in cases where the URLs are not particularly important.</p> </dd> <dt id="-o,-official"><a id="o---official"></a><b>-o</b>, <b>--official</b></dt> <dd> <p>[1.00] Set the default header to indicate that this page is part of the standard Perl release, if <b>--center</b> is not also given.</p> </dd> <dt id="-q-quotes,-quotes=quotes"><a id="q-quotes---quotes-quotes"></a><b>-q</b> <i>quotes</i>, <b>--quotes</b>=<i>quotes</i></dt> <dd> <p>[4.00] Sets the quote marks used to surround C<> text to <i>quotes</i>. If <i>quotes</i> is a single character, it is used as both the left and right quote. Otherwise, it is split in half, and the first half of the string is used as the left quote and the second is used as the right quote.</p> <p><i>quotes</i> may also be set to the special value <code>none</code>, in which case no quote marks are added around C<> text (but the font is still changed for troff output).</p> <p>Also see the <b>--lquote</b> and <b>--rquote</b> options, which can be used to set the left and right quotes independently. If both <b>--quotes</b> and one of the other options is set, <b>--lquote</b> or <b>--rquote</b> overrides <b>--quotes</b>.</p> </dd> <dt id="-r-version,-release=version"><a id="r-version---release-version"></a><b>-r</b> <i>version</i>, <b>--release</b>=<i>version</i></dt> <dd> <p>[1.00] Set the centered footer for the <code>.TH</code> macro to <i>version</i>. By default, this is set to the version of Perl you run <b>pod2man</b> under. Setting this to the empty string will cause some *roff implementations to use the system default value.</p> <p>Note that some system <code>an</code> macro sets assume that the centered footer will be a modification date and will prepend something like <code>Last modified: </code>. If this is the case for your target system, you may want to set <b>--release</b> to the last modified date and <b>--date</b> to the version number.</p> </dd> <dt id="-s-string,-section=string"><a id="s-string---section-string"></a><b>-s</b> <i>string</i>, <b>--section</b>=<i>string</i></dt> <dd> <p>[1.00] Set the section for the <code>.TH</code> macro. The standard section numbering convention is to use 1 for user commands, 2 for system calls, 3 for functions, 4 for devices, 5 for file formats, 6 for games, 7 for miscellaneous information, and 8 for administrator commands. There is a lot of variation here, however; some systems (like Solaris) use 4 for file formats, 5 for miscellaneous information, and 7 for devices. Still others use 1m instead of 8, or some mix of both. About the only section numbers that are reliably consistent are 1, 2, and 3.</p> <p>By default, section 1 will be used unless the file ends in <code>.pm</code>, in which case section 3 will be selected.</p> </dd> <dt id="-stderr"><a id="stderr"></a><b>--stderr</b></dt> <dd> <p>[2.1.3] By default, <b>pod2man</b> dies if any errors are detected in the POD input. If <b>--stderr</b> is given and no <b>--errors</b> flag is present, errors are sent to standard error, but <b>pod2man</b> does not abort. This is equivalent to <code>--errors=stderr</code> and is supported for backward compatibility.</p> </dd> <dt id="-u,-utf8"><a id="u---utf8"></a><b>-u</b>, <b>--utf8</b></dt> <dd> <p>[2.1.0] This option used to tell <b>pod2man</b> to produce UTF-8 output. Since this is now the default as of version 5.00, it is ignored and does nothing.</p> </dd> <dt id="-v,-verbose"><a id="v---verbose"></a><b>-v</b>, <b>--verbose</b></dt> <dd> <p>[1.11] Print out the name of each output file as it is being generated.</p> </dd> </dl> <h1 id="EXIT-STATUS"><a id="EXIT"></a>EXIT STATUS</h1> <p>As long as all documents processed result in some output, even if that output includes errata (a <code>POD ERRORS</code> section generated with <code>--errors=pod</code>), <b>pod2man</b> will exit with status 0. If any of the documents being processed do not result in an output document, <b>pod2man</b> will exit with status 1. If there are syntax errors in a POD document being processed and the error handling style is set to the default of <code>die</code>, <b>pod2man</b> will abort immediately with exit status 255.</p> <h1 id="DIAGNOSTICS">DIAGNOSTICS</h1> <p>If <b>pod2man</b> fails with errors, see <a href="/pod/Pod::Man">Pod::Man</a> and <a href="/pod/Pod::Simple">Pod::Simple</a> for information about what those errors might mean.</p> <h1 id="EXAMPLES">EXAMPLES</h1> <pre><code>pod2man program > program.1 pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3 pod2man --section=7 note.pod > note.7</code></pre> <p>If you would like to print out a lot of man page continuously, you probably want to set the C and D registers to set contiguous page numbering and even/odd paging, at least on some versions of man(7).</p> <pre><code>troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...</code></pre> <p>To get index entries on <code>STDERR</code>, turn on the F register, as in:</p> <pre><code>troff -man -rF1 perl.1</code></pre> <p>The indexing merely outputs messages via <code>.tm</code> for each major page, section, subsection, item, and any <code>X<></code> directives.</p> <h1 id="AUTHOR">AUTHOR</h1> <p>Russ Allbery <rra@cpan.org>, based on the original <b>pod2man</b> by Larry Wall and Tom Christiansen.</p> <h1 id="COPYRIGHT-AND-LICENSE"><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1> <p>Copyright 1999-2001, 2004, 2006, 2008, 2010, 2012-2019, 2022-2024 Russ Allbery <rra@cpan.org></p> <p>This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.</p> <h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1> <p><a href="/pod/Pod::Man">Pod::Man</a>, <a href="/pod/Pod::Simple">Pod::Simple</a>, <a href="http://man.he.net/man1/man">man(1)</a>, <a href="http://man.he.net/man1/nroff">nroff(1)</a>, <a href="http://man.he.net/man1/perlpod">perlpod(1)</a>, <a href="http://man.he.net/man1/podchecker">podchecker(1)</a>, <a href="http://man.he.net/man1/perlpodstyle">perlpodstyle(1)</a>, <a href="http://man.he.net/man1/troff">troff(1)</a></p> <p>The man page documenting the <code>an</code> macro set is usually either <a href="http://man.he.net/man7/man">man(7)</a> or <a href="http://man.he.net/man5/man">man(5)</a> depending on the system.</p> <p>The current version of this script is always available from its web site at <a href="https://www.eyrie.org/~eagle/software/podlators/">https://www.eyrie.org/~eagle/software/podlators/</a>. It is also part of the Perl core distribution as of 5.6.0.</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::Man, 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::Man</code></pre> <p><a href="/pod/CPAN">CPAN shell</a></p> <pre><code>perl -MCPAN -e shell install Pod::Man</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>