LinuxCommandLibrary

pod2man

Convert Perl POD documentation to man pages

TLDR

Convert POD to man page

$ pod2man [file.pod] > [file.1]
copy
Specify section
$ pod2man --section=[1] [file.pod] > [file.1]
copy
Set name and release
$ pod2man --name="[NAME]" --release="[1.0]" [file.pod] > [file.1]
copy

SYNOPSIS

pod2man [options] [file]

DESCRIPTION

pod2man converts Perl POD (Plain Old Documentation) into Unix manual page format (nroff/troff). The output can be installed as system man pages or viewed with the man command.
The --section option sets the man page section number, --name overrides the page name, and --release adds version information. The --center option sets the centered header text. Part of the standard Perl distribution, commonly used in Perl module build systems.

PARAMETERS

FILE

Input POD file.
--section N
Man page section.
--name NAME
Man page name.
--release VERSION
Release version string.
--center TEXT
Center header text.
--date DATE
Date for footer.

CAVEATS

Perl-specific format. Standard Perl utility.

HISTORY

pod2man was created for generating man pages from Perl documentation.

SEE ALSO

pod2html(1), pod2text(1), man(1)

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard

> TERMINAL_GEAR

Curated for the Linux community