PODTOC(1)

💖 PODTOC(1) 💖

okay bestie, welcome to the PODTOC(1) page from User Contributed Perl Documentation — this is the tea on podtoc, and it’s lowkey iconic. ✨

🌸 NAME 🌸

• podtoc — show outline of pods 💅

🦋 DESCRIPTION 🦋

okay so podtoc shows the structure of one or more pod documents. That’s the whole main-character job: literally give you the outline vibe for your POD docs. no cap. 🫶

🎀 EXAMPLES 🎀

here’s the example, bestie — keep it exactly as it is:

$ podtoc `pmpath CGI`
 NAME
 SYNOPSIS
 ABSTRACT
 DESCRIPTION
     PROGRAMMING STYLE
     CALLING CGI.PM ROUTINES
     *  1. Use another name for the argument, if one is available.  For
        example, -value is an alias for -values.
     *  2. Change the capitalization, e.g. -Values
(etc)

🌈 SEE ALSO 🌈

go peek at pod2man(1), perlpod(1). — those are the SEE ALSO besties, fr fr. 🌟

👑 AUTHORS and COPYRIGHTS 👑

shoutout time, periodt:

• Copyright (C) 1999 Tom Christiansen.
• Copyright (C) 2006-2014 Mark Leighton Fisher.

⭐ LICENSE ⭐

okay so legally, here’s the exact tea:

This is free software; you can redistribute it and/or modify it under the terms of either: (a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or (b) the Perl "Artistic License". (This is the Perl 5 licensing scheme.)

Please note this is a change from the original pmtools-1.00 (still available on CPAN), as pmtools-1.00 were licensed only under the Perl "Artistic License".

---

signing off from this PODTOC(1) page — it’s perl v5.32.1 and dated 2022-01-21. bye bestie, slay your POD outlines 💅✨