POD2WIKI(1)

📦
version 0.20 · 2 versions
, in fedora 43

💖 POD2WIKI(1) 💖

User Contributed Perl Documentation ✨ like bestie, this is the pod2wiki page from the Perl docs, and I'm about to make it make sense 🫶

✨ NAME ✨

pod2wiki</purl> — a whole utility that converts Pod documents into Wiki format. it's giving translator but make it documentation 💅

🌸 SYNOPSIS 🌸

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

the options, laid out:

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

🦋 DESCRIPTION 🦋

okay so this program exists for one (1) job: turning Pod text into Wiki text. that's it. that's the whole personality 🎀

Pod is Perl's Plain Old Documentation format, bestie. if you wanna know more, go read man perlpod or run perldoc perlpod.

A Wiki is a user-extensible web site — you know, the kind where everyone can just edit stuff. it runs on very simple mark-up that gets converted to Html. want an intro to Wikis? it's literally right here: <http://en.wikipedia.org/wiki/Wiki> 👑

💅 OPTIONS 💅

  • podfile — the input file holding the Pod that's getting converted. it can also be stdin, no biggie ✨
  • outfile — the converted output file, in wiki format. if you don't specify it, it defaults to stdout 🫶
  • --style or -s — sets the wiki style of the output. if no style is given, the program just defaults to wiki. the available options are, and I'm obsessed with how many there are:
  • --encoding — specifies the encoding for the output filehandle, like this:
--encoding=":utf8"

heads up: check "binmode" in perlfunc for the details. also this option only exists in Perl 5.8 and later, so if you're on something ancient, no encoding for you 😭

  • --noerrata or -noe — don't generate a "POD ERRORS" section at the end of the document. it's equivalent to the Pod::Simple::no_errata_section() method, iykyk ✨
  • --help or -h — prints a brief help message and then exits. quick lil vibe check 🌈
  • --man or -m — prints the manual page and exits. hi, that's me, I'm the manual page 🫶

💀 DISCLAIMER OF WARRANTY 💀

bestie. please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki. it's not a vibe I'm allowed to paraphrase, so go read it fr fr 🙈

👑 AUTHOR 👑

John McNamara — jmcnamara@cpan.org 💜

(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. periodt ✨

and that's the whole page, bestie 🎀 this was perl v5.42.0, dated 2025-07-25, and you just read POD2WIKI(1) — slay 💖

📦 where this page comes from