POD2MARKDOWN(1)

💖 POD2MARKDOWN 💖

okay bestie, so this one is a little command-line icon called pod2markdown, and yes it lives in the User Contributed Perl Documentation section, and yes it's about to make your whole documentation workflow cute ✨

---

🌸 NAME 🌸

pod2markdown — Convert POD text to Markdown. that's it, that's the whole job description, and it does it slayfully 💅

---

🎀 VERSION 🎀

version 3.400 — that's the one, that's the number, don't @ me 🫶

---

✨ SYNOPSIS ✨

four ways to run this thing, pick your fighter:

# 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 that. no notes. a full little pipeline moment 💜

---

🦋 DESCRIPTION 🦋

okay so here's the tea: this program uses Pod::Markdown to convert POD into Markdown sources. lowkey iconic, highkey useful.

UTF-8 is the default output encoding if no encoding options are specified (see "OPTIONS"). that's the vibe check it passes by default, no cap 🌈

it accepts two optional arguments:

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

two optional args, both with defaults, very low-maintenance main character energy honestly 👑

---

💅 OPTIONS 💅

buckle up, there's a list, and we're doing the whole list:

• --html-encode-chars — a list of characters to encode as HTML entities. pass a regexp character class, or pass 1 to mean 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 for encodings ✨
• --local-module-url-prefix — alters the perldoc urls that are 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 are 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 are created from L<> codes. 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 🎀
• --utf8 (-u) — alias for -e UTF-8. tiny shortcut, big slay 💖

---

⭐ SEE ALSO ⭐

this program is strongly based on "pod2mdwn" from Module::Build::IkiWiki. giving credit where credit is due, as one should 🫶

---

👑 AUTHORS 👑

the whole crew, respect the roster:

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

---

💀 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. free software, free to remix, we love to see it 🌸

---

and that's the whole page bestie, go forth and convert some POD 💅✨

perl v5.42.0 · 2024-03-08 — that's the version of perl and the date this whole thing was dated, mwah, bye 🧚‍♀️💜