pod2text - Convert POD data to formatted ASCII text

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>pod2text - Convert POD data to formatted ASCII text - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/pod2text"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.41.2</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/pod2text">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/pod2text">5.40.1</a> <a class="dropdown-item" href="/5.40.0/pod2text">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/pod2text">5.38.3</a> <a class="dropdown-item" href="/5.38.2/pod2text">5.38.2</a> <a class="dropdown-item" href="/5.38.1/pod2text">5.38.1</a> <a class="dropdown-item" href="/5.38.0/pod2text">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/pod2text">5.36.3</a> <a class="dropdown-item" href="/5.36.2/pod2text">5.36.2</a> <a class="dropdown-item" href="/5.36.1/pod2text">5.36.1</a> <a class="dropdown-item" href="/5.36.0/pod2text">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/pod2text">5.34.3</a> <a class="dropdown-item" href="/5.34.2/pod2text">5.34.2</a> <a class="dropdown-item" href="/5.34.1/pod2text">5.34.1</a> <a class="dropdown-item" href="/5.34.0/pod2text">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/pod2text">5.32.1</a> <a class="dropdown-item" href="/5.32.0/pod2text">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/pod2text">5.30.3</a> <a class="dropdown-item" href="/5.30.2/pod2text">5.30.2</a> <a class="dropdown-item" href="/5.30.1/pod2text">5.30.1</a> <a class="dropdown-item" href="/5.30.0/pod2text">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/pod2text">5.28.3</a> <a class="dropdown-item" href="/5.28.2/pod2text">5.28.2</a> <a class="dropdown-item" href="/5.28.1/pod2text">5.28.1</a> <a class="dropdown-item" href="/5.28.0/pod2text">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/pod2text">5.26.3</a> <a class="dropdown-item" href="/5.26.2/pod2text">5.26.2</a> <a class="dropdown-item" href="/5.26.1/pod2text">5.26.1</a> <a class="dropdown-item" href="/5.26.0/pod2text">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/pod2text">5.24.4</a> <a class="dropdown-item" href="/5.24.3/pod2text">5.24.3</a> <a class="dropdown-item" href="/5.24.2/pod2text">5.24.2</a> <a class="dropdown-item" href="/5.24.1/pod2text">5.24.1</a> <a class="dropdown-item" href="/5.24.0/pod2text">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/pod2text">5.22.4</a> <a class="dropdown-item" href="/5.22.3/pod2text">5.22.3</a> <a class="dropdown-item" href="/5.22.2/pod2text">5.22.2</a> <a class="dropdown-item" href="/5.22.1/pod2text">5.22.1</a> <a class="dropdown-item" href="/5.22.0/pod2text">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/pod2text">5.20.3</a> <a class="dropdown-item" href="/5.20.2/pod2text">5.20.2</a> <a class="dropdown-item" href="/5.20.1/pod2text">5.20.1</a> <a class="dropdown-item" href="/5.20.0/pod2text">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/pod2text">5.18.4</a> <a class="dropdown-item" href="/5.18.3/pod2text">5.18.3</a> <a class="dropdown-item" href="/5.18.2/pod2text">5.18.2</a> <a class="dropdown-item" href="/5.18.1/pod2text">5.18.1</a> <a class="dropdown-item" href="/5.18.0/pod2text">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/pod2text">5.16.3</a> <a class="dropdown-item" href="/5.16.2/pod2text">5.16.2</a> <a class="dropdown-item" href="/5.16.1/pod2text">5.16.1</a> <a class="dropdown-item" href="/5.16.0/pod2text">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/pod2text">5.14.4</a> <a class="dropdown-item" href="/5.14.3/pod2text">5.14.3</a> <a class="dropdown-item" href="/5.14.2/pod2text">5.14.2</a> <a class="dropdown-item" href="/5.14.1/pod2text">5.14.1</a> <a class="dropdown-item" href="/5.14.0/pod2text">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/pod2text">5.12.5</a> <a class="dropdown-item" href="/5.12.4/pod2text">5.12.4</a> <a class="dropdown-item" href="/5.12.3/pod2text">5.12.3</a> <a class="dropdown-item" href="/5.12.2/pod2text">5.12.2</a> <a class="dropdown-item" href="/5.12.1/pod2text">5.12.1</a> <a class="dropdown-item" href="/5.12.0/pod2text">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/pod2text">5.10.1</a> <a class="dropdown-item" href="/5.10.0/pod2text">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/pod2text">5.8.9</a> <a class="dropdown-item" href="/5.8.8/pod2text">5.8.8</a> <a class="dropdown-item" href="/5.8.7/pod2text">5.8.7</a> <a class="dropdown-item" href="/5.8.6/pod2text">5.8.6</a> <a class="dropdown-item" href="/5.8.5/pod2text">5.8.5</a> <a class="dropdown-item" href="/5.8.4/pod2text">5.8.4</a> <a class="dropdown-item" href="/5.8.3/pod2text">5.8.3</a> <a class="dropdown-item" href="/5.8.2/pod2text">5.8.2</a> <a class="dropdown-item" href="/5.8.1/pod2text">5.8.1</a> <a class="dropdown-item" href="/5.8.0/pod2text">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/pod2text">5.6.2</a> <a class="dropdown-item" href="/5.6.1/pod2text">5.6.1</a> <a class="dropdown-item" href="/5.6.0/pod2text">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/pod2text">5.005_04</a> <a class="dropdown-item" href="/5.005_03/pod2text">5.005_03</a> <a class="dropdown-item" href="/5.005_02/pod2text">5.005_02</a> <a class="dropdown-item" href="/5.005_01/pod2text">5.005_01</a> <a class="dropdown-item" href="/5.005/pod2text">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/pod2text">blead</a> <a class="dropdown-item" href="/5.41.9/pod2text">5.41.9</a> <a class="dropdown-item" href="/5.41.8/pod2text">5.41.8</a> <a class="dropdown-item" href="/5.41.7/pod2text">5.41.7</a> <a class="dropdown-item" href="/5.41.6/pod2text">5.41.6</a> <a class="dropdown-item" href="/5.41.5/pod2text">5.41.5</a> <a class="dropdown-item" href="/5.41.4/pod2text">5.41.4</a> <a class="dropdown-item" href="/5.41.3/pod2text">5.41.3</a> <a class="dropdown-item active" href="/5.41.2/pod2text">5.41.2</a> <a class="dropdown-item" href="/5.41.1/pod2text">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/pod2text">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/pod2text">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/pod2text">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/pod2text">5.39.10</a> <a class="dropdown-item" href="/5.39.9/pod2text">5.39.9</a> <a class="dropdown-item" href="/5.39.8/pod2text">5.39.8</a> <a class="dropdown-item" href="/5.39.7/pod2text">5.39.7</a> <a class="dropdown-item" href="/5.39.6/pod2text">5.39.6</a> <a class="dropdown-item" href="/5.39.5/pod2text">5.39.5</a> <a class="dropdown-item" href="/5.39.4/pod2text">5.39.4</a> <a class="dropdown-item" href="/5.39.3/pod2text">5.39.3</a> <a class="dropdown-item" href="/5.39.2/pod2text">5.39.2</a> <a class="dropdown-item" href="/5.39.1/pod2text">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/pod2text">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.41.2/perl">Perl</a> <a class="dropdown-item" href="/5.41.2/perlintro">Intro</a> <a class="dropdown-item" href="/5.41.2/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.41.2/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.41.2/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.41.2/perlop">Operators</a> <a class="dropdown-item" href="/5.41.2/functions">Functions</a> <a class="dropdown-item" href="/5.41.2/variables">Variables</a> <a class="dropdown-item" href="/5.41.2/modules">Modules</a> <a class="dropdown-item" href="/5.41.2/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.41.2/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.41.2/perlcommunity">Community</a> <a class="dropdown-item" href="/5.41.2/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.41.2/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.41.2/pod2text">pod2text</a> <div id="more"> (<a href="/5.41.2/pod2text.txt">source</a>, <a href="https://metacpan.org/pod/pod2text">CPAN</a>) </div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.41.2. This is a development version of Perl. </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#OPTIONS">OPTIONS</a> </li> <li> <a class="text-decoration-none" href="#EXIT-STATUS">EXIT STATUS</a> </li> <li> <a class="text-decoration-none" href="#DIAGNOSTICS">DIAGNOSTICS</a> </li> <li> <a class="text-decoration-none" href="#ENVIRONMENT">ENVIRONMENT</a> </li> <li> <a class="text-decoration-none" href="#AUTHOR">AUTHOR</a> </li> <li> <a class="text-decoration-none" href="#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a> </li> <li> <a class="text-decoration-none" href="#SEE-ALSO">SEE ALSO</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>pod2text - Convert POD data to formatted ASCII text</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <p>pod2text [<b>-aclostu</b>] [<b>--code</b>] <span style="white-space: nowrap;">[<b>-e</b> <i>encoding</i>]</span> [<b>--errors</b>=<i>style</i>] [<b>--guesswork</b>=<i>rule</i>[,<i>rule</i>...]] <span style="white-space: nowrap;">[<b>-i</b> <i>indent</i>]</span> <span style="white-space: nowrap;">[<b>-q</b> <i>quotes</i>]</span> [<b>--nourls</b>] [<b>--stderr</b>] <span style="white-space: nowrap;">[<b>-w</b> <i>width</i>]</span> [<i>input</i> [<i>output</i> ...]]</p> <p>pod2text <b>-h</b></p> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p><b>pod2text</b> is a wrapper script around the <a href="/5.41.2/Pod::Text">Pod::Text</a> and its subclasses. It uses them to generate formatted text from POD source. It can optionally use either termcap sequences or ANSI color escape sequences to format the text.</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>pod2text</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>By default, the output encoding is the same as the encoding of the input file, or UTF-8 if that encoding is not set (except on EBCDIC systems). See the <b>-e</b> option to explicitly set the output encoding and <a href="/5.41.2/Pod::Text#Encoding">"Encoding" in Pod::Text</a> for more discussion.</p> <h1 id="OPTIONS"><a class="permalink" href="#OPTIONS">#</a>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="-a,-alt"><a class="permalink" href="#-a,-alt">#</a><a id="a---alt"></a><b>-a</b>, <b>--alt</b></dt> <dd> <p>[1.00] Use an alternate output format that, among other things, uses a different heading style and marks <code>=item</code> entries with a colon in the left margin.</p> </dd> <dt id="-code"><a class="permalink" href="#-code">#</a><a id="code"></a><b>--code</b></dt> <dd> <p>[1.11] Include any non-POD text from the input file in the output as well. Useful for viewing code documented with POD blocks with the POD rendered and the code left intact.</p> </dd> <dt id="-c,-color"><a class="permalink" href="#-c,-color">#</a><a id="c---color"></a><b>-c</b>, <b>--color</b></dt> <dd> <p>[1.00] Format the output with ANSI color escape sequences. Using this option requires that Term::ANSIColor be installed on your system.</p> </dd> <dt id="-e-encoding,-encoding=encoding"><a class="permalink" href="#-e-encoding,-encoding=encoding">#</a><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="/5.41.2/Encode">Encode</a> module (see <a href="/5.41.2/Encode::Supported">Encode::Supported</a>). If the output contains characters that cannot be represented in this encoding, that is an error that will be reported as configured by the <code>errors</code> 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>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, as near to the top of the file as possible. 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 class="permalink" href="#-errors=style">#</a><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="-guesswork=rule[,rule...]"><a class="permalink" href="#-guesswork=rule%5B,rule...%5D">#</a><a id="guesswork-rule-rule"></a><b>--guesswork</b>=<i>rule</i>[,<i>rule</i>...]</dt> <dd> <p>[5.01] By default, <b>pod2text</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="quoting"><a class="permalink" href="#quoting">#</a>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> </dl> <p>Any unknown guesswork name is silently ignored (for potential future compatibility), so be careful about spelling.</p> </dd> <dt id="-i-indent,-indent=indent"><a class="permalink" href="#-i-indent,-indent=indent">#</a><a id="i-indent---indent-indent"></a><b>-i</b> <i>indent</i>, <b>--indent=</b><i>indent</i></dt> <dd> <p>[1.00] Set the number of spaces to indent regular text, and the default indentation for <code>=over</code> blocks. Defaults to 4 spaces if this option isn't given.</p> </dd> <dt id="-h,-help"><a class="permalink" href="#-h,-help">#</a><a id="h---help"></a><b>-h</b>, <b>--help</b></dt> <dd> <p>[1.00] Print out usage information and exit.</p> </dd> <dt id="-l,-loose"><a class="permalink" href="#-l,-loose">#</a><a id="l---loose"></a><b>-l</b>, <b>--loose</b></dt> <dd> <p>[1.00] Print a blank line after a <code>=head1</code> heading. Normally, no blank line is printed after <code>=head1</code>, although one is still printed after <code>=head2</code>, because this is the expected formatting for manual pages; if you're formatting arbitrary text documents, using this option is recommended.</p> </dd> <dt id="-m-width,-left-margin=width,-margin=width"><a class="permalink" href="#-m-width,-left-margin=width,-margin=width">#</a><a id="m-width---left-margin-width---margin-width"></a><b>-m</b> <i>width</i>, <b>--left-margin</b>=<i>width</i>, <b>--margin</b>=<i>width</i></dt> <dd> <p>[1.24] The width of the left margin in spaces. Defaults to 0. This is the margin for all text, including headings, not the amount by which regular text is indented; for the latter, see <b>-i</b> option.</p> </dd> <dt id="-nourls"><a class="permalink" href="#-nourls">#</a><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 class="plaintext">L<foo|http://example.com/></code></pre> <p>is formatted as:</p> <pre><code class="plaintext">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,-overstrike"><a class="permalink" href="#-o,-overstrike">#</a><a id="o---overstrike"></a><b>-o</b>, <b>--overstrike</b></dt> <dd> <p>[1.06] Format the output with overstrike printing. Bold text is rendered as character, backspace, character. Italics and file names are rendered as underscore, backspace, character. Many pagers, such as <b>less</b>, know how to convert this to bold or underlined text.</p> </dd> <dt id="-q-quotes,-quotes=quotes"><a class="permalink" href="#-q-quotes,-quotes=quotes">#</a><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.</p> </dd> <dt id="-s,-sentence"><a class="permalink" href="#-s,-sentence">#</a><a id="s---sentence"></a><b>-s</b>, <b>--sentence</b></dt> <dd> <p>[1.00] Assume each sentence ends with two spaces and try to preserve that spacing. Without this option, all consecutive whitespace in non-verbatim paragraphs is compressed into a single space.</p> </dd> <dt id="-stderr"><a class="permalink" href="#-stderr">#</a><a id="stderr"></a><b>--stderr</b></dt> <dd> <p>[2.1.3] By default, <b>pod2text</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>pod2text</b> does not abort. This is equivalent to <code>--errors=stderr</code> and is supported for backward compatibility.</p> </dd> <dt id="-t,-termcap"><a class="permalink" href="#-t,-termcap">#</a><a id="t---termcap"></a><b>-t</b>, <b>--termcap</b></dt> <dd> <p>[1.00] Try to determine the width of the screen and the bold and underline sequences for the terminal from termcap, and use that information in formatting the output. Output will be wrapped at two columns less than the width of your terminal device. Using this option requires that your system have a termcap file somewhere where Term::Cap can find it and requires that your system support termios. With this option, the output of <b>pod2text</b> will contain terminal control sequences for your current terminal type.</p> </dd> <dt id="-u,-utf8"><a class="permalink" href="#-u,-utf8">#</a><a id="u---utf8"></a><b>-u</b>, <b>--utf8</b></dt> <dd> <p>[2.2.0] Set the output encoding to UTF-8. This is equivalent to <code>--encoding=UTF-8</code> and is supported for backward compatibility.</p> </dd> <dt id="-w,-width=width,-width"><a class="permalink" href="#-w,-width=width,-width">#</a><a id="w---width-width--width"></a><b>-w</b>, <b>--width=</b><i>width</i>, <b>-</b><i>width</i></dt> <dd> <p>[1.00] The column at which to wrap text on the right-hand side. Defaults to 76, unless <b>-t</b> is given, in which case it's two columns less than the width of your terminal device.</p> </dd> </dl> <h1 id="EXIT-STATUS"><a class="permalink" href="#EXIT-STATUS">#</a><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>pod2text</b> will exit with status 0. If any of the documents being processed do not result in an output document, <b>pod2text</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>pod2text</b> will abort immediately with exit status 255.</p> <h1 id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">#</a>DIAGNOSTICS</h1> <p>If <b>pod2text</b> fails with errors, see <a href="/5.41.2/Pod::Text">Pod::Text</a> and <a href="/5.41.2/Pod::Simple">Pod::Simple</a> for information about what those errors might mean. Internally, it can also produce the following diagnostics:</p> <dl> <dt id="-c-(-color)-requires-Term::ANSIColor-be-installed"><a class="permalink" href="#-c-(-color)-requires-Term::ANSIColor-be-installed">#</a><a id="c---color-requires-Term::ANSIColor-be-installed"></a>-c (--color) requires Term::ANSIColor be installed</dt> <dd> <p>(F) <b>-c</b> or <b>--color</b> were given, but Term::ANSIColor could not be loaded.</p> </dd> <dt id="Unknown-option:-%s"><a class="permalink" href="#Unknown-option:-%25s">#</a><a id="Unknown"></a><a id="Unknown-option:-s"></a>Unknown option: %s</dt> <dd> <p>(F) An unknown command line option was given.</p> </dd> </dl> <p>In addition, other <a href="/5.41.2/Getopt::Long">Getopt::Long</a> error messages may result from invalid command-line options.</p> <h1 id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">#</a>ENVIRONMENT</h1> <dl> <dt id="COLUMNS"><a class="permalink" href="#COLUMNS">#</a>COLUMNS</dt> <dd> <p>If <b>-t</b> is given, <b>pod2text</b> will take the current width of your screen from this environment variable, if available. It overrides terminal width information in TERMCAP.</p> </dd> <dt id="TERMCAP"><a class="permalink" href="#TERMCAP">#</a>TERMCAP</dt> <dd> <p>If <b>-t</b> is given, <b>pod2text</b> will use the contents of this environment variable if available to determine the correct formatting sequences for your current terminal device.</p> </dd> </dl> <h1 id="AUTHOR"><a class="permalink" href="#AUTHOR">#</a>AUTHOR</h1> <p>Russ Allbery <rra@cpan.org>.</p> <h1 id="COPYRIGHT-AND-LICENSE"><a class="permalink" href="#COPYRIGHT-AND-LICENSE">#</a><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 class="permalink" href="#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1> <p><a href="/5.41.2/Encode::Supported">Encode::Supported</a>, <a href="/5.41.2/Pod::Text">Pod::Text</a>, <a href="/5.41.2/Pod::Text::Color">Pod::Text::Color</a>, <a href="/5.41.2/Pod::Text::Overstrike">Pod::Text::Overstrike</a>, <a href="/5.41.2/Pod::Text::Termcap">Pod::Text::Termcap</a>, <a href="/5.41.2/Pod::Simple">Pod::Simple</a>, <a href="http://man.he.net/man1/perlpod">perlpod(1)</a></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="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

pod2text - Convert POD data to formatted ASCII text - Perldoc Browser