Dear brethren,
I am interested in using POD to document my perl programs. In fact, I've already done so in the past.
The thing is, however, that I turn most of my programs into executables, since they are meant to be used on systems that do not have and by people who are unfamiliar with perl.
To my knowledge, you cannot use perldoc to display the POD within these programs. Is this true or is it just a figment of my imagination?
Until now I've just used
print or
die to display a program's documentation, but this system is far less versatile than POD, nor does it allow for the use of inline documentation.
I'm probably just missing something here.
Any thoughts? How do you document perl executables?
Thanks in advance.
May Larry be with you!
my $name = Perl::scribe->new();
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.