NAME
pod2pandoc - convert Pod to Pandoc document model
SYNOPSIS
pod2pandoc [OPTIONS] {INPUT} [ [ -- ] PANDOCOPTIONS ]
pod2pandoc [OPTIONS] {INPUT} | pandoc -f json [ PANDOCOPTIONS ]
pod2pandoc Module.pm -o Module.pdf
pod2pandoc script.pl -t markdown
pod2pandoc Module::Name -o ModuleName.html
DESCRIPTION
pod2pandoc
converts POD format documentation (perlpod) to the Pandoc document model so it can be processed to other formats (HTML, Markdown, LaTeX, PDF, EPUB, docx, ODT, man, ICML...). By default or with input -
a document is read from STDIN. Multiple input files are combined to one document. The result is printed in JSON format or passed to Pandoc if additional options such as -t
or -o
are given.
The document metadata field pod2pandoc
is set to a list of input files.
OPTIONS
- --help|-h|-?
-
Print out usage information and exit
- --man
-
Print the full manual page and exit
- --data-sections
-
Parse and include data sections in pandoc input formats (e.g. markdown).
- --podurl URL
-
Set base URL to link Perl modules (
https://metacpan.org/pod/
by default). - ...
-
All other options are passed through to pandoc.
SEE ALSO
Conversion is based on Pod::Simple::Pandoc which uses Pandoc::Element.
This script together with Pandoc can be used as customizable replacement for specialized Pod converter scripts such as pod2html, pod2man, pod2readme, pod2usage, pod2latex, pod2markdown, and pod2text.