README.pod

NAME

Pod::Perl5

VERSION

0.09

DESCRIPTION

This is a Perl 6 module for parsing Perl 5 pod. The grammar for this module lives at Pod::Perl5::Grammar. The parser can parse inline pod and standalone *.pod files and supports all pod syntax. It also comes with a pod-to-html action class for the grammar Pod::Perl5::ToHTML.

SYNOPSIS

use Pod::Perl5;

my $match_from_string = Pod::Perl5::parse-string($pod);
my $match_from_file   = Pod::Perl5::parse-file('/some.pod');

my $html_from_string = Pod::Perl5::string-to-html($pod);
my $html_from_file   = Pod::Perl5::file-to-html('/some.pod');

INSTALL

Requires panda and Perl 6:

$ panda install Pod::Perl5

TESTING

The parser has a decent test suite. You'll need Perl 5 and Perl 6 installed to run it with prove

$ prove --exec perl6 -r

Or run individual test files with perl6:

$ perl6 t/01_basic.t

AUTHOR

David Farrell (C) 2015

LICENSE

FreeBSD, see LICENSE file

SEE ALSO

• perlpod documentation

• PerlTricks article on this module

• Pegex - a Perl 5 module that uses grammars and action classes like Perl 6