POD2PROJDOCS(1p)

👑 NAME 👑

okay bestie, meet pod2projdocs (that's the manual page pod2projdocs(1p), from the User Contributed Perl Documentation corner of the universe) — she generates CPAN like project documents from pod. no cap. 💅

---

✨ SYNOPSIS ✨

pod2projdocs [options]

 Options:
    -help         display this help and exist
    -out          directory path that you want to generate documents into
    -lib          your project's library-root-directory path
    -title        your project's title
    -desc         your project's description
    -noindex      don't create index for all generated pages
    -forcegen     generate documents each time, ignoring last modified timestamp
    -nosourcecode suppress inclusion of the original source code in the generated output
    -lang         set this language as xml:lang (default 'en')
    -except       the files matches this regex won't be parsed

so the way that works 🫶 — you can set each option with their first character. like, -o instead of -out? yes queen, same energy, shorter typing. the abbreviation slay is real.

and pookie, you can generate documents from multiple library directories. not one, not two — as many as you want:

pod2projdocs -o /path/to/outputdir -l /path/to/lib1 -l /path/to/lib2

---

🌸 OPTIONS 🌸

• -help — shows you this help and then dips out (the OG wording is "display this help and exist", and honestly? she does exist. we love her 💖)
• -out — the directory path that you want to generate documents into. that's the destination, bestie.
• -lib — your project's library-root-directory path. where the source lives.
• -title — your project's title. give her a name, main character energy only.
• -desc — your project's description.
• -noindex — don't create index for all generated pages. skipping the index, lowkey rebellious. 🙈
• -forcegen — generate documents each time, ignoring last modified timestamp. no vibe check on the mtime, we're regenerating periodt.
• -nosourcecode — suppress inclusion of the original source code in the generated output. the source stays backstage. 🎀
• -lang — set this language as xml:lang (default 'en'). 🌈
• -except — the files matches this regex won't be parsed. yes, a regex. yes, she's powerful. 👑

---

💜 DESCRIPTION 💜

generates CPAN like project documents from pod. that's the whole vibe. it's giving documentation glow-up. ✨

---

🦋 SEE ALSO 🦋

• Pod::ProjectDocs — the module behind all this magic, go say hi 🫶

---

💖 AUTHORS 💖

• Lyo Kato <lyo.kato@gmail.com>
• Martin Gruner <https://github.com/mgruner> (current maintainer) 👑

---

🌟 COPYRIGHT AND LICENSE 🌟

© 2005 by Lyo Kato

© 2018 by Martin Gruner

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.5 or, at your option, any later version of Perl 5 you may have available.

fr fr, that's the license — free software, same terms as Perl itself, 5.8.5 or whatever later Perl 5 you've got. respect the paperwork bestie, it's iconic. 💅

---

and that's the whole page, pookie 🎀 this was pod2projdocs(1p) from perl v5.32.1, dated 2021-02-21 — go generate some gorgeous CPAN-coded docs, you ate that. mwah 💖✨