-c

Sets the centered page header for the ".TH" macro to string. The default is "User Contributed PerlDocumentation", but also see --official below.

-d

Set the left-hand footer string for the ".TH" macro to string. By default, the modification date of theinput file will be used, or the current date if input comes from "STDIN", and will be based on UTC (sothat the output will be reproducible regardless of local time zone).

--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".

--fixed

The fixed-width font to use for verbatim text and code. Defaults to "CW". Some systems may want "CR"instead. Only matters for troff(1) output.

--fixedbold

Bold version of the fixed-width font. Defaults to "CB". Only matters for troff(1) output.

--fixeditalic

Italic version of the fixed-width font (actually, something of a misnomer, since most fixed-width fontsonly have an oblique version, not an italic version). Defaults to "CI". Only matters for troff(1)output.

--fixedbolditalic

Bold italic (probably actually oblique) version of the fixed-width font. Pod::Man doesn't assume you havethis, and defaults to "CB". Some systems (such as Solaris) have this font available as "CX". Onlymatters for troff(1) output.

-h

Print out usage information.

-l

No longer used. pod2man used to check its input for validity as a manual page, but this should now bedone by podchecker(1) instead. Accepted for backward compatibility; this option no longer does anything.

--rquote

Sets the quote marks used to surround C<> text. --lquote sets the left quote mark and --rquote sets theright quote mark. Either may also be set to the special value "none", in which case no quote mark isadded on that side of C<> text (but the font is still changed for troff output).Also see the --quotes option, which can be used to set both quotes at once. If both --quotes and one ofthe other options is set, --lquote or --rquote overrides --quotes.

-n

Set the name of the manual page for the ".TH" macro to name. Without this option, the manual name is setto the uppercased base name of the file being converted unless the manual section is 3, in which case thepath is parsed to see if it is a Perl module path. If it is, a path like ".../lib/Pod/Man.pm" isconverted into a name like "Pod::Man". This option, if given, overrides any automatic determination ofthe name.Although one does not have to follow this convention, be aware that the convention for UNIX man pages forcommands is for the man page title to be in all-uppercase, even if the command isn't.This option is probably not useful when converting multiple POD files at once.When converting POD source from standard input, the name will be set to "STDIN" if this option is notprovided. Providing this option is strongly recommended to set a meaningful manual page name.

--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

Set the default header to indicate that this page is part of the standard Perl release, if --center is notalso given.

-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(but the font is still changed for troff output).Also see the --lquote and --rquote options, which can be used to set the left and right quotesindependently. If both --quotes and one of the other options is set, --lquote or --rquote overrides

-r

Set the centered footer for the ".TH" macro to version. By default, this is set to the version of Perlyou run pod2man under. Setting this to the empty string will cause some *roff implementations to use thesystem default value.Note that some system "an" macro sets assume that the centered footer will be a modification date and willprepend something like "Last modified: ". If this is the case for your target system, you may want to set

--release

to the last modified date and --date to the version number.

-s

Set the section for the ".TH" macro. The standard section numbering convention is to use 1 for usercommands, 2 for system calls, 3 for functions, 4 for devices, 5 for file formats, 6 for games, 7 formiscellaneous 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 reliablyconsistent are 1, 2, and 3.By default, section 1 will be used unless the file ends in ".pm", in which case section 3 will beselected.

--stderr

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

-u

By default, pod2man produces the most conservative possible *roff output to try to ensure that it willwork with as many different *roff implementations as possible. Many *roff implementations cannot handlenon-ASCII characters, so this means all non-ASCII characters are converted either to a *roff escapesequence that tries to create a properly accented character (at least for troff output) or to "X".This option says to instead output literal UTF-8 characters. If your *roff implementation can handle it,this is the best output format to use and avoids corruption of documents containing non-ASCII characters.However, be warned that *roff source with literal UTF-8 characters is not supported by manyimplementations and may even result in segfaults and other bad behavior.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 pod2man failure. Use the "=encoding"command to declare the encoding. See perlpod(1) for more information.

-v

Print out the name of each output file as it is being generated.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"), pod2man will exit with status 0. If any of the documents beingprocessed do not result in an output document, pod2man will exit with status 1. If there are syntax errors ina POD document being processed and the error handling style is set to the default of "die", pod2man will abortimmediately with exit status 255.DIAGNOSTICSIf pod2man fails with errors, see Pod::Man and Pod::Simple for information about what those errors might mean.EXAMPLESpod2man program > program.1pod2man SomeModule.pm /usr/perl/man/man3/SomeModule.3pod2man --section=7 note.pod > note.7If you would like to print out a lot of man page continuously, you probably want to set the C and D registersto set contiguous page numbering and even/odd paging, at least on some versions of man(7).troff -man -rC1 -rD1 perl.1 perldata.1 perlsyn.1 ...To get index entries on "STDERR", turn on the F register, as in:troff -man -rF1 perl.1The indexing merely outputs messages via ".tm" for each major page, section, subsection, item, and any "X<>"directives. See Pod::Man for more details.BUGSLots of this documentation is duplicated from Pod::Man.