Perl in a Nutshell

Name

pod2man

Synopsis

pod2man [options] inputfile

Description

Translates pod directives in file inputfile to Unix manpage format. Converts pod-tagged text to nroff source that can be viewed by the man command, or troff for typesetting.

Options

--center=string

Sets centered header to string. Defaults to “User Contributed Perl Documentation” unless -\-official flag is set, in which case it defaults to “Perl Programmers Reference Guide.”

--date=string

Sets left-hand footer string to date.

--fixed=font

Specifies the fixed-width font to use for code examples.

--lax

If set, ignores missing sections.

--official

If set, uses default header as shown for -\-center above.

--release=rel

Sets centered footer. Defaults to current Perl release.

--section=manext

Sets manpage section for nroff .TH macro. Default is 3 (functions) if filename ends in .pm, otherwise 1 (user commands).