NAME

pod2cpanhtml - A utility to convert Pod to search.cpan.org style HTML.

SYNOPSIS

pod2cpanhtml [--help --man --noerrata] podfile [outfile]

    Options:
        --help       brief help message.
        --man        full documentation.
        --noerrata   don't generate a "POD ERRORS" section.

DESCRIPTION

This program is used for converting Pod documents to http://search.cpan.org/ style HTML.

Pod is Perl's Plain Old Documentation format, see perlpod.

The pod2cpanhtml utility produces HTML output similar to search.cpan.org by using the same conversion module, Pod::Simple::HTML and the same CSS, http://search.cpan.org/s/style.css.

It should be noted, however, that this utility isn't the actual program used to create the HTML for seach.cpan.org; that program isn't currently in the public domain. As such the HTML may not be identical but in most cases it will be quite close and visually it should be the same.

OPTIONS

podfile

The input file that contains the Pod file to be converted.

outfile

The converted output file in HTML format. Defaults to stdout if not specified.

--help or -h

Print a brief help message and exits.

--man or -m

Prints the manual page and exits.

--noerrata or -noe

Don't generate a "POD ERRORS" section at the end of the document. Equivalent to the Pod::Simple::no_errata_section() method.

AUTHOR

John McNamara jmcnamara@cpan.org

COPYRIGHT

© MMIX, John McNamara.

All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.