08 Nov 2007 20:43:25 UTC
- Distribution: Pod-Help
- Module version: 1.00
- Source (raw)
- Browse (raw)
- How to Contribute
- Testers (1719 / 9 / 2)
- KwaliteeBus factor: 0
- 52.63% Coverage
- License: perl_5
- Activity24 month
- Download (3.31KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionJACOB Michael Jacob
Pod::Help - Perl module to automate POD display
use Pod::Help qw(-h --help); -or- use Pod::Help; ... Pod::Help->help() if (...); -or- use Pod::Help; ... Pod::Help->help('ACME::PodLib::FooPod');
Pod::Help allows your script or program to automaticlly display its POD when the user gives a certain command line parameter.
Note: 'script or program'! I mean it, Pod::Help is not intended to be used by other modules.
There are three different ways to use Pod::Help:
- fully automatic
For fully automatic mode just use() Pod::Help and give it the command line parameters it should be triggered by as parameters:
use Pod::Help qw(-h --help);
That's it, nothing more to do.
- manually triggered
If you don't want Pod::Help to fiddle with your @ARGV, you may trigger the POD display manually. Use() Pod::Help without (or with an empty) parameter list and it will do nothing on its own. You may then call Pod::Help->help() at any time.
use Pod::Help; ... Pod::Help->help() if (...);
- POD from different file
If you have the POD in a different file you must use the manual mode. Then give the module name of the file containing your POD to the help() method.
use Pod::Help; ... Pod::Help->help('ACME::PodLib::FooPod');
If the POD is in a file that cannot be found that way, give '-F' and the file name and path to help().
use Pod::Help; ... Pod::Help->help('-F', $installdir.'/docs/scripts/podhelp/foo.pod');
You may give any parameters to help() that perldoc would accept, too.
Original version; created by h2xs 1.23 with options
-A -C -X -b 5.6.0 -n Pod::Help --use-new-tests --skip-exporter -v 0.99
Updated packaging for newer standards. No changes to the coding.
Michael Jacob, <firstname.lastname@example.org>
Copyright (C) 2004, 2007 by Michael Jacob
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available.