pod2pandoc - convert Pod to Pandoc document model
pod2pandoc [OPTIONS] {INPUT} [ [ -- ] PANDOC_ARGUMENTS ] pod2pandoc Module.pm -o Module.pdf pod2pandoc script.pl -t markdown pod2pandoc Module::Name -o Module-Name.html pod2pandoc lib/ wiki/ --ext .md --wiki --index Home -t markdown_github pod2pandoc lib/ docs/ --standalone
pod2pandoc converts "Plain Old Documentation" format (aka Pod, see perlpod) to the Pandoc document model for further processing to other document formats (HTML, Markdown, LaTeX, PDF, EPUB, docx, ODT, man...).
By default or with input - a document is read from STDIN. Multiple input files are combined to one document and listed in document metadata field file. The result is printed in JSON format or passed to Pandoc if additional options such as -t or -o are given.
-
file
-t
-o
To process a whole directory of .pm and/or .pod files, specify an input directory as first input and an optional output directory as second.
.pm
.pod
Print out usage information and exit.
Parse and include data sections. Use * for all.
*
Base URL to Perl modules. Default: https://metacpan.org/pod/. A false value such as 0 or "" will disable linking to external modules.
https://metacpan.org/pod/
0
""
Output file extension when processing a directory. Default: html.
html
Index file (e.g. index.html) name when processing a directory. Can be disabled with 0.
index.html
Include NAME section which is removed by default.
NAME
Create wikilinks when processing a directory.
Only process when input file is newer then output file.
Read default metadata from given file.
Don't emit warnings and status information.
Additional options are passed through to pandoc executable.
This script is part of Pod::Pandoc and implemented in App::pod2pandoc. Together with Pandoc document converter it can be used as customizable replacement for specialized Pod converter scripts such as pod2html, pod2projdocs, pod2man, pod2readme, pod2usage, pod2latex, pod2markdown, pod2text, and pod2projdocs.
To install Pod::Pandoc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Pandoc
CPAN shell
perl -MCPAN -e shell install Pod::Pandoc
For more information on module installation, please visit the detailed CPAN module installation guide.