POD2MARKDOWN(1p)

💖 NAME 💖

okay so bestie, meet pod2markdown — it converts POD text to Markdown. that's it, that's the whole job, and it does it flawlessly 💅

---

✨ VERSION ✨

version 3.400 🎀

---

🌸 SYNOPSIS 🌸

# 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

like look at her go. four whole ways to serve and every one of them is a slay 👑

---

🦋 DESCRIPTION 🦋

this program uses Pod::Markdown to convert POD into Markdown sources. no cap.

UTF-8 is the default output encoding if you don't specify any encoding options (peep "OPTIONS" if you wanna change that).

she accepts two optional arguments, and honestly? optional is her love language:

• input pod file — defaults to STDIN
• output markdown file — defaults to STDOUT

---

🎀 OPTIONS 🎀

• --html-encode-chars — a list of characters to encode as HTML entities. you pass it a regexp character class, or you pass 1 and it means control chars, high-bit chars, and "<&>'".

see "html_encode_chars" in Pod::Markdown for more information.

• --match-encoding (-m) — use the same =encoding as the input pod for the output file. matching outfits but make it encodings 🫶
• --local-module-url-prefix — alters the perldoc urls that get created from L<> codes when the module is a "local" module (Local::* or Foo_Corp::* (see perlmodlib)).

the default is to use perldoc_url_prefix.

see "local_module_url_prefix" in Pod::Markdown for more information.

• --man-url-prefix — alters the man page urls that get created from L<> codes.

the default is http://man.he.net/man.

see "man_url_prefix" in Pod::Markdown for more information.

• --perldoc-url-prefix — alters the perldoc urls that get created from L<> codes. it can be:
  • "metacpan" (shortcut for https://metacpan.org/pod/)
  • "sco" (shortcut for http://search.cpan.org/perldoc?)
  • any url

the default is "metacpan".

see "perldoc_url_prefix" in Pod::Markdown for more information.

• --output-encoding (-e) — specify the encoding for the output file. your output, your rules, periodt ✨
• --utf8 (-u) — alias for -e UTF-8. short, sweet, iconic.

---

🌈 SEE ALSO 🌈

this program is strongly based on "pod2mdwn" from Module::Build::IkiWiki. giving credit where credit is due, always 💜

---

👑 AUTHORS 👑

• 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>

five whole legends on the credits. main character energy from every single one 🧚

---

💀 COPYRIGHT AND LICENSE 💀

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.

fr fr read that license, bestie — free software, same terms as Perl 5 itself, don't be weird about it 🙈

---

okay that's the whole page!! this is the POD2MARKDOWN(1p) manual from perl v5.36.0, dated 2023-11-02, living under User Contributed Perl Documentation. go convert something gorgeous with her 💖✨🎀