There's something to be said about what the user expects. On posix, I expect all cli stuff to roughly do the following when something goes wrong..
  1. If an internal error occurred, I don't see the manual or usage examples, I see what the error message is, the thing really dies out.
  2. If there's a usage error, or a missing argument or I see the -h or --help flag, I expect to see the brief usage statement.. such as: 
    command-name [OPTIONS].. OTHERARGS..
Brief one sentence description of command usefulness.
   -h          help
   -v          version
   -o          other command flag
   -a string   this one takes an arg
For more info, try 'man command-name'

    [download]
    And that's it, period.. no manual info this far. Just a brief warning maybe, and usage. Maybe not even usage if you don't want to - unless they ask for -h(elp), but an error.

    See the 'locate' command for example of this, try 'locate', and you get warning, try 'locate -h' and you get brief usage, try 'man locate' and you get the whole enchillada.

  3. If the user specifially request the manual- then I show the manual, all of it- that pertains to that command.

In reply to Re^2: Parsing Pod::Text by leocharre
in thread Parsing Pod::Text by neo1491

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.