Fellow Monks,

I'm working on framework mobule that will be used by a small suite of commandline utilities, each with their own respective (perldoc) manual pages.

Rather than coding the POD for all of the commandline switches by hand (and keeping the switches up-to-date with what I accept with Getopt::Long, I'd really like to generate the POD dynamically, and have that apply to the manual page as output by perldoc. However—and here's the rub—when these utilities are released to CPAN, I want the generated POD to appear there as well (otherwise someone will have to download and install the utilities just to see their documentation, which would not be acceptable).

Here's what I already know:

The part I don't have a good solution for is getting the generated POD on CPAN/MetaCPAN. The best I've come up with is this: I could augment the utilities' release process to generate the POD so it's zipped up in the distribution tarball as if it was hand-coded, but (a) that effort would negate some of the savings of auto-generated POD, and (b) I don't want to impose that effort on others who may want to use my framework module for their own utilities. I'd like it to just work.

I'm hoping there's a simple solution, here—or something already inherent in how CPAN unpacks distributions that might help—but I haven't been able to find anything.


In reply to Generated POD and CPAN/MetaCPAN by wanna_code_perl

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.