POD2WIKI(1p)

📦
version 0.20 · 3 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

✨ pod2wiki — the manual page 💖

okay bestie, this is POD2WIKI(1p), from the User Contributed Perl Documentation section, and it's literally the glow-up machine that turns your Pod docs into Wiki markup. sit down, get comfy, we're doing this together 🫶

🌸 NAME 🌸

pod2wiki — a utility to convert Pod documents to Wiki format. yep that's the whole gig, that's the assignment, and she ate 💅

⭐ SYNOPSIS ⭐

pod2wiki [--style --noerrata --help --man] podfile [outfile]

    Options:
        --style      wiki style (defaults to wiki. See --help)
        --noerrata   don't generate a "POD ERRORS" section
        --help       brief help message
        --man        full documentation

look at her go. so simple. so iconic 👑

🦋 DESCRIPTION 🦋

so this program converts Pod text to Wiki text. that's it. that's the vibe.

Pod is Perl's Plain Old Documentation format. no cap, that's the actual name. if you wanna know more, go hit man perlpod or perldoc perlpod 📖

A Wiki is a user extensible web site. it uses super simple mark-up that gets converted to Html. (yes, the original says "Html", we don't fix that, we respect her 💜). for an intro to Wikis, check out <http://en.wikipedia.org/wiki/Wiki>.

💅 OPTIONS 💅

  • podfile — the input file holding the Pod you want converted. it can also be stdin, so you can pipe into her, she's flexible like that 🧚
  • outfile — the converted output file, in wiki format. if you don't specify one it defaults to stdout. she'll just talk to you directly, main character energy ✨
  • --style or -s — sets the wiki style of the output. if no style is specified, the program defaults to wiki. here's the full menu, no skips, no summarising, we list all of them 💖
  • --encoding — specify the encoding for the output filehandle:
--encoding=":utf8"

refer to binmode in perlfunc for more details. heads up bestie: this option is only available in Perl 5.8 and later. don't come for her if you're on something ancient 😭

  • --noerrata or -noe — don't generate a "POD ERRORS" section at the end of the document. equivalent to the Pod::Simple::no_errata_section() method. so if you want the clean aesthetic with no error receipts, this is your girl ✨
  • --help or -h — print a brief help message and exits. she's quick, she's brief, she leaves. respect 🙈
  • --man or -m — prints the manual page and exits. (you're reading her rn, hi, welcome 💖)

🌟 DISCLAIMER OF WARRANTY 🌟

please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki. yeah, the real legal tea lives over there, go read it, it's giving responsible 💀

🎀 AUTHOR 🎀

John McNamara — jmcnamara@cpan.org. (inventing the whole thing AND dropping the email?? icon behaviour fr fr)

(c) MMIII-MMX1V John McNamara.

All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself. slay, open source queen 🌈

okay bye bestie, go convert something pretty!! 💅✨🦋

and that's a wrap — this page came to you from perl v5.36.0, dated 2022-10-13, under the POD2WIKI(1p) name in the User Contributed Perl Documentation. love that for us 🫶💖

📦 where this page comes from