| Current File : //usr/share/doc/perl-Pod-Usage/README |
Pod::Usage
----------
The Perl5 module "Pod::Usage" which provides the function "pod2usage()"
to print usage messages for a Perl script based on its embedded pod
documentation. Pod::Usage is a subclass of Pod::PlainText. Please see
the POD documentation for this module (embedded in the file "Usage.pm")
for more details. The pod2usage() function is probably the most
generally useful function in this entire distribution since it is
useful to just about any Perl5 script that is invoked from the
command-line.
See the POD documentation for more details.
This separate distribution was created to allow refactoring of Pod::Usage
to use Pod::Simple instead of Pod::Parser, such that Pod::Parser can be
discontinued from the Perl Core in the near future.
AUTHORS/CONTRIBUTORS
====================
Marek Rouchal <[email protected]>
Brad Appleton <[email protected]> http://www.enteract.com/~bradapp/
rjbs for driving the transition to Pod::Simple
LICENSE
=======
Pod-Usage is free software; you can redistribute it and/or modify it
under the same terms as the Perl 5 interpreter. Please refer to
http://dev.perl.org/licenses/ for more details.
DISCLAIMER
===========
This software is distributed in the hope that it will be useful, but
is provided "AS IS" WITHOUT WARRANTY OF ANY KIND, either expressed or
implied, INCLUDING, without limitation, the implied warranties of
MERCHANTABILITY and FITNESS FOR A PARTICULAR PURPOSE.
The ENTIRE RISK as to the quality and performance of the software
IS WITH YOU (the holder of the software). Should the software prove
defective, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION.
IN NO EVENT WILL ANY COPYRIGHT HOLDER OR ANY OTHER PARTY WHO MAY CREATE,
MODIFY, OR DISTRIBUTE THE SOFTWARE BE LIABLE OR RESPONSIBLE TO YOU OR TO
ANY OTHER ENTITY FOR ANY KIND OF DAMAGES (no matter how awful - not even
if they arise from known or unknown flaws in the software).
REQUIREMENTS
============
* Perl version 5.005 or later
* Pod::Simple from CPAN (already bundled in recent Perl 5 releases)
BUILDING & INSTALLING
=====================
Please see the perl "ExtUtils::MakeMaker" manpage for how to build and
install using the Makefile.PL template. In a nutshell, simply typing:
perl Makefile.PL
should build a Makefile with the usual targets like "all", "clean",
"test", and "install".
BUGS
====
Please use the CPAN bug tracking to report bugs:
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-Usage