I have a perl script (generatePODs.pl) to generate POD files for a set of other perl scripts. In the script, I do something like the following:
print DOCFILE <<"DOCS";
=pod
=head1 NAME
$programName
...
DOCS
However, when do a perldoc on my script itself
perldoc generatePODs.pl
perldoc picks up the POD inside the heredocs and puts it before the POD for the generation script.
GENERATEPODS(1) User Contributed Perl Documentation GENERAT
+EPODS(1)
NAME
$programName
......
NAME
generatePODs.pl
DESCRIPTION
This program generates PODs
I looked at the perldoc and pod2man man pages and it was not clear to me as to how to make perldoc ignore the POD embedded inside the heredoc. How can I do that?
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: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.