LinuxCommandLibrary
GitHubF-DroidGoogle Play Store

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 is a front-end for Pod::Man, converting Perl POD (Plain Old Documentation) into Unix manual page format (*roff). The output can be displayed with nroff via man, or printed with troff.If no input file is given, it reads from STDIN. If no output file is given, it writes to STDOUT. The default center header is "User Contributed Perl Documentation". Part of the standard Perl distribution, commonly used in 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 left-hand footer (default: input file modification date).
--utf8
Assume UTF-8 encoding for input.
--stderr
Print errors to stderr.
--fixed FONT
Fixed-width font for verbatim text.

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), nroff(1)

Copied to clipboard
Kai