pod2markdown - Convert POD text to Markdown
version 3.400
# parse STDIN, print to STDOUT $ pod2markdown < POD_File > Markdown_File # parse file, print to STDOUT $ pod2markdown input.pod # parse file, print to file $ pod2markdown input.pod output.mkdn # parse STDIN, print to file $ pod2markdown - output.mkdn
This program uses Pod::Markdown to convert POD into Markdown sources.
UTF-8 is the default output encoding if no encoding options are specified (see "OPTIONS").
It accepts two optional arguments:
input pod file (defaults to STDIN)
STDIN
output markdown file (defaults to STDOUT)
STDOUT
A list of characters to encode as HTML entities. Pass a regexp character class, or 1 to mean control chars, high-bit chars, and <&>"'.
1
<&>"'
See "html_encode_chars" in Pod::Markdown for more information.
Use the same =encoding as the input pod for the output file.
=encoding
Alters the perldoc urls that are created from L<> codes when the module is a "local" module ("Local::*" or "Foo_Corp::*" (see perlmodlib)).
L<>
"Local::*"
"Foo_Corp::*"
The default is to use perldoc_url_prefix.
perldoc_url_prefix
See "local_module_url_prefix" in Pod::Markdown for more information.
Alters the man page urls that are created from L<> codes.
The default is http://man.he.net/man.
http://man.he.net/man
See "man_url_prefix" in Pod::Markdown for more information.
Alters the perldoc urls that are created from L<> codes. Can be:
metacpan (shortcut for https://metacpan.org/pod/)
metacpan
https://metacpan.org/pod/
sco (shortcut for http://search.cpan.org/perldoc?)
sco
http://search.cpan.org/perldoc?
any url
The default is metacpan.
See "perldoc_url_prefix" in Pod::Markdown for more information.
Specify the encoding for the output file.
Alias for -e UTF-8.
-e UTF-8
This program is strongly based on pod2mdwn from Module::Build::IkiWiki.
pod2mdwn
Marcel Gruenauer <marcel@cpan.org>
Victor Moral <victor@taquiones.net>
Ryan C. Thompson <rct at thompsonclan d0t org>
Aristotle Pagaltzis <pagaltzis@gmx.de>
Randy Stauner <rwstauner@cpan.org>
This software is copyright (c) 2011 by Randy Stauner.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Pod::Markdown, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Markdown
CPAN shell
perl -MCPAN -e shell install Pod::Markdown
For more information on module installation, please visit the detailed CPAN module installation guide.