|Keep It Simple, Stupid|
How To View POD Embedded in a Perl Script?by ParsonGeorge (Initiate)
|on Apr 04, 2014 at 01:00 UTC||Need Help??|
ParsonGeorge has asked for the
wisdom of the Perl Monks concerning the following question:
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:
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.