LinuxCommandLibrary

podchecker

Validate Perl POD documentation syntax

TLDR

Check POD syntax

$ podchecker [file.pod]
copy
Check multiple files
$ podchecker [*.pod]
copy
Warnings only
$ podchecker -warnings [file.pod]
copy

SYNOPSIS

podchecker [options] [files]

DESCRIPTION

podchecker validates the syntax of Perl POD (Plain Old Documentation) files, reporting errors such as unknown formatting codes, mismatched begin/end blocks, and malformed headings.
It checks for both hard errors that would cause incorrect rendering and warnings about questionable constructs. Use -warnings to control the level of warning output. Part of the standard Perl distribution.

PARAMETERS

FILES

POD files to check.
-warnings
Show warnings.
-nowarnings
Suppress warnings.

CAVEATS

Perl-specific format. Standard Perl utility.

HISTORY

podchecker was created for validating POD documentation syntax.

SEE ALSO

pod2man(1), pod2html(1), perldoc(1)

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard

> TERMINAL_GEAR

Curated for the Linux community