-a

Use an alternate output format that, among other things, uses a different heading style and marks "=item"entries with a colon in the left margin.

--code

Include any non-POD text from the input file in the output as well. Useful for viewing code documentedwith POD blocks with the POD rendered and the code left intact.

-c

Format the output with ANSI color escape sequences. Using this option requires that Term::ANSIColor beinstalled on your system.

--errors

Set the error handling style. "die" says to throw an exception on any POD formatting error. "stderr"says to report errors on standard error, but not to throw an exception. "pod" says to include a PODERRORS section in the resulting documentation summarizing the errors. "none" ignores POD errors entirely,as much as possible.The default is "die".

-i

Set the number of spaces to indent regular text, and the default indentation for "=over" blocks. Defaultsto 4 spaces if this option isn't given.

-h

Print out usage information and exit.

-l

Print a blank line after a "=head1" heading. Normally, no blank line is printed after "=head1", althoughone is still printed after "=head2", because this is the expected formatting for manual pages; if you'reformatting arbitrary text documents, using this option is recommended.

-m

The width of the left margin in spaces. Defaults to 0. This is the margin for all text, includingheadings, not the amount by which regular text is indented; for the latter, see -i option.

--nourls

Normally, L<> formatting codes with a URL but anchor text are formatted to show both the anchor text andthe URL. In other words:L<foo|http://example.com/>is formatted as:foo <http://example.com/>This flag, if given, suppresses the URL when anchor text is given, so this example would be formatted asjust "foo". This can produce less cluttered output in cases where the URLs are not particularlyimportant.

-o

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 less, knowhow to convert this to bold or underlined text.

-q

Sets the quote marks used to surround C<> text to quotes. If quotes is a single character, it is used asboth the left and right quote. Otherwise, it is split in half, and the first half of the string is usedas the left quote and the second is used as the right quote.quotes may also be set to the special value "none", in which case no quote marks are added around C<>text.

-s

Assume each sentence ends with two spaces and try to preserve that spacing. Without this option, allconsecutive whitespace in non-verbatim paragraphs is compressed into a single space.

--stderr

By default, pod2text dies if any errors are detected in the POD input. If --stderr is given and no

-t

Try to determine the width of the screen and the bold and underline sequences for the terminal fromtermcap, and use that information in formatting the output. Output will be wrapped at two columns lessthan the width of your terminal device. Using this option requires that your system have a termcap filesomewhere where Term::Cap can find it and requires that your system support termios. With this option,the output of pod2text will contain terminal control sequences for your current terminal type.

-u

By default, pod2text tries to use the same output encoding as its input encoding (to be backward-compatible with older versions). This option says to instead force the output encoding to UTF-8.Be aware that, when using this option, the input encoding of your POD source should be properly declaredunless it's US-ASCII. Pod::Simple will attempt to guess the encoding and may be successful if it'sLatin-1 or UTF-8, but it will warn, which by default results in a pod2text failure. Use the "=encoding"command to declare the encoding. See perlpod(1) for more information.

-w

The column at which to wrap text on the right-hand side. Defaults to 76, unless -t is given, in whichcase it's two columns less than the width of your terminal device.EXIT STATUSAs long as all documents processed result in some output, even if that output includes errata (a "POD ERRORS"section generated with "--errors=pod"), pod2text will exit with status 0. If any of the documents beingprocessed do not result in an output document, pod2text will exit with status 1. If there are syntax errorsin a POD document being processed and the error handling style is set to the default of "die", pod2text willabort immediately with exit status 255.DIAGNOSTICSIf pod2text fails with errors, see Pod::Text and Pod::Simple for information about what those errors mightmean. Internally, it can also produce the following diagnostics: