The Pod::Usage module provides pod2usage, which parses the POD documentation in your program and generates a usage message from it.

I have those lines in place to handle two different use cases. First, if you call this program (no, it's not a complete program, just a snippet of some production code) with a -h or --help, it will print a usage message and exit. This is standard across the code I've written at this job.

Second, there are required fields that are being checked. If there is no value for any of those fields (@services, $operation, etc.) then we present a usage message and exit. pod2usage causes the program to exit, so it's an effective check of whether continuing is actually feasible.

This implies that I keep up the POD on my programs. I consider POD necessary in production code, so that's a non-issue. Not that I've never violated that rule...

If you call pod2usage with a higher -verbose value, it prints out more information. This allows me to provide more or less detail based on how many -h flags were handed into my program. A single one means a simple usage message, multiples produce something like a manpage.

In reply to Re^3: How to use getopt and $#argv together? by mpeever
in thread How to use getopt and $#argv together? by iphone

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.