I'm new to Perl and am trying to figure out how to use POD.

First, some important "stuff": OS: Windows 7 on my desktop and Ubuntu 1204 on my laptop (I use both somewhat interchangeably). Perl: Strawberry 5.18 on Windows, 5.14 on Linux. IDE: Padre and Eclipse/Epic (both loaded on each platform, and I alternate between them).

I've created just a tiny POD sample:

#!/usr/bin/perl
print "Hello, World!\n";

=head1 NAME
    My::Module - An example module
=cut

[download]

When I run the program, "Hello, World!" prints properly; the POD stuff is ignored (as I expect). However, how can I view the documentation?

I've tried running perldoc in a terminal with the name of the script as an argument: perldoc hello.pl -- but that doesn't seem to work.

I created a separate .POD file with some documentation and this did work: perldoc hello.pod. However, is there some way to view the documentation that's embedded in a script? Ideally, I'd like to embed the POD documentation at the bottom of a script and then click something or enter something to view that documentation from within either IDE.

Thanks, in advance, for any help you can offer.

In reply to How To View POD Embedded in a Perl Script? by ParsonGeorge

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.