Blame README

Packit 792b68

Packit 792b68
 WHAT IS THIS?
Packit 792b68
 =============
Packit 792b68
 This software distribution contains the following packages for using
Packit 792b68
 Perl5 "pod" (Plain Old Documentation).  See the "perlpod" and "perlsyn"
Packit 792b68
 manual pages from your Perl5 distribution for more information about pod.
Packit 792b68

Packit 792b68
 DISCLAIMER
Packit 792b68
 ----------
Packit 792b68
 This package is considered to be legacy - it has been superseded by 
Packit 792b68
 Pod::Simple which brings more robustness, unicode and various other
Packit 792b68
 benefits. If you are building anything new, please consider using
Packit 792b68
 Pod::Simple, not this package.
Packit 792b68

Packit 792b68
 Pod::Parser
Packit 792b68
 -----------
Packit 792b68
   The Perl5 module "Pod::Parser", which provides a base class for
Packit 792b68
   parsing and selecting sections of POD documentation from an input
Packit 792b68
   stream.  Please see the POD documentation for this module (embedded
Packit 792b68
   in the file "Parser.pm") for more details.
Packit 792b68

Packit 792b68
 Pod::Select
Packit 792b68
 -----------
Packit 792b68
   The Perl5 module "Pod::Select", which provides a subclass of
Packit 792b68
   Pod::Parser and an exported function named "podselect()" to dump
Packit 792b68
   selected sections of raw pod documentation from an input stream.
Packit 792b68
   Please see the POD documentation for this module (embedded in the
Packit 792b68
   file "Select.pm") and Pod::Parser for more details.
Packit 792b68

Packit 792b68
 Pod::PlainText
Packit 792b68
 --------------
Packit 792b68
   A replacement for the Perl5 module "Pod::Text" and the corresponding
Packit 792b68
   "pod2text()" function. It is derived from the Pod::Parser class.
Packit 792b68
   Please see the POD documentation for this module and Pod::Parser for
Packit 792b68
   more details (embedded in the file "PlainText.pm").
Packit 792b68

Packit 792b68
   *NOTE*: As of perl 5.00_58, Pod::PlainText has been re-written by
Packit 792b68
   Russ Allbery, and has been renamed to Pod::Text in the core Perl
Packit 792b68
   distribution (replacing the previous implementation of Pod::Text).
Packit 792b68
   The Pod::PlainText module is still provided with Pod::Parser on CPAN
Packit 792b68
   solely for backward compatibility. Once Perl 5.6 becomes the latest
Packit 792b68
   stable version of Perl, then Pod::PlainText will be removed from the
Packit 792b68
   Pod-Parser distribution!!
Packit 792b68

Packit 792b68
 Pod::InputObjects
Packit 792b68
 -----------------
Packit 792b68
   Some input objects needed by Pod::Parser, and for advanced users of
Packit 792b68
   Pod::Parser that need more about a command besides its name and text.
Packit 792b68

Packit 792b68
 Pod::ParseUtils
Packit 792b68
 ---------------
Packit 792b68
   A module with several object-oriented helpers for POD parsing and
Packit 792b68
   processing. Probably the most important is Pod::Hyperlink for
Packit 792b68
   parsing and expanding POD hyperlinks L<...>.
Packit 792b68

Packit 792b68

Packit 792b68
 AUTHORS/CONTRIBUTORS
Packit 792b68
 ====================
Packit 792b68
 Marek Rouchal  <marekr@cpan.org>
Packit 792b68
 Brad Appleton  <bradapp@enteract.com>  http://www.enteract.com/~bradapp/
Packit 792b68
 Russ Allbery   <rra@standford.edu>
Packit 792b68

Packit 792b68

Packit 792b68
 ACKNOWLEDGEMENTS
Packit 792b68
 ================
Packit 792b68
 * Kenneth Albanowski for his extensive assistance with the design and
Packit 792b68
   interface of Pod::Parser.
Packit 792b68

Packit 792b68
 * Steven McDougall for his help and patience with re-writing the manpage
Packit 792b68
   for Pod::Usage and Pod::Parser.
Packit 792b68

Packit 792b68
 * Achim Bonnet for helping me get the regression test-suite into a form
Packit 792b68
   that works with 'make test' generated by MakeMaker
Packit 792b68

Packit 792b68
 * Nick Ing-Simmons, for his considerable time and effort spent trying to
Packit 792b68
   make pre-release versions of Pod::Parser work with code and giving me
Packit 792b68
   feedback on the implementation and design.
Packit 792b68

Packit 792b68
 * Russ Allbery for re-writing Pod::PlainText from scratch and getting it
Packit 792b68
   to replace Pod::Text in the core for perl 5.00_58!
Packit 792b68

Packit 792b68
 COPY/REUSE POLICY
Packit 792b68
 =================
Packit 792b68
 Except where explicitly stated otherwise within the contents of a file,
Packit 792b68
 this distribution and all the files in it are Copyright (C) 1996-1999
Packit 792b68
 by Brad Appleton.  All rights reserved.
Packit 792b68

Packit 792b68
 Pod-Parser is free software; you can redistribute it and/or modify it
Packit 792b68
 under the terms of the Artistic License distributed with Perl version
Packit 792b68
 5.000 or (at your option) any later version. Please refer to the
Packit 792b68
 Artistic License that came with your Perl distribution for more
Packit 792b68
 details. If your version of Perl was not distributed under the
Packit 792b68
 terms of the Artistic License, than you may distribute Pod-Parser
Packit 792b68
 under the same terms as Perl itself.
Packit 792b68

Packit 792b68
 The Artistic License should have been included in your distribution of
Packit 792b68
 Perl. It resides in the file named "Artistic" at the top-level of the
Packit 792b68
 Perl source tree (where Perl was downloaded/unpacked -- ask your
Packit 792b68
 system administrator if you dont know where this is).  Alternatively,
Packit 792b68
 the current version of the Artistic License distributed with Perl can
Packit 792b68
 be viewed on-line on the World-Wide Web (WWW) from the following URL:
Packit 792b68

Packit 792b68
      http://www.perl.com/perl/misc/Artistic.html
Packit 792b68

Packit 792b68
 The latest version of Perl can be obtained on the World-Wide web (WWW)
Packit 792b68
 from the following URL:
Packit 792b68

Packit 792b68
      http://www.perl.com/CPAN/src/latest.tar.gz
Packit 792b68

Packit 792b68

Packit 792b68
 DISCLAIMER pt 2
Packit 792b68
 ===============
Packit 792b68
 This software is distributed in the hope that it will be useful, but
Packit 792b68
 is provided "AS IS" WITHOUT WARRANTY OF ANY KIND, either expressed or
Packit 792b68
 implied, INCLUDING, without limitation, the implied warranties of
Packit 792b68
 MERCHANTABILITY and FITNESS FOR A PARTICULAR PURPOSE.
Packit 792b68

Packit 792b68
 The ENTIRE RISK as to the quality and performance of the software
Packit 792b68
 IS WITH YOU (the holder of the software).  Should the software prove
Packit 792b68
 defective, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
Packit 792b68
 CORRECTION.
Packit 792b68

Packit 792b68
 IN NO EVENT WILL ANY COPYRIGHT HOLDER OR ANY OTHER PARTY WHO MAY CREATE,
Packit 792b68
 MODIFY, OR DISTRIBUTE THE SOFTWARE BE LIABLE OR RESPONSIBLE TO YOU OR TO
Packit 792b68
 ANY OTHER ENTITY FOR ANY KIND OF DAMAGES (no matter how awful - not even
Packit 792b68
 if they arise from known or unknown flaws in the software).
Packit 792b68

Packit 792b68
 Please refer to the Artistic License that came with your Perl
Packit 792b68
 distribution for more details.
Packit 792b68

Packit 792b68

Packit 792b68
 CONTENTS
Packit 792b68
 ========
Packit 792b68
 Please see the file named "MANIFEST" which should have been included
Packit 792b68
 in the Pod-Parser distribution.
Packit 792b68

Packit 792b68

Packit 792b68
 REQUIREMENTS
Packit 792b68
 ============
Packit 792b68
 * Perl version 5.005 or later
Packit 792b68

Packit 792b68
 * File::Spec from CPAN (already bundled in Perl 5.005)
Packit 792b68
   at least version 0.82, previous ones lack some functions needed here
Packit 792b68

Packit 792b68

Packit 792b68
 BUILDING & INSTALLING
Packit 792b68
 =====================
Packit 792b68
 Please see the perl "ExtUtils::MakeMaker" manpage for how to build and
Packit 792b68
 install using the Makefile.PL template.  In a nutshell, simply typing:
Packit 792b68

Packit 792b68
      perl Makefile.PL
Packit 792b68

Packit 792b68
 should build a Makefile with the usual targets like "all", "clean",
Packit 792b68
 "test", and "install".
Packit 792b68

Packit 792b68

Packit 792b68
 BUGS
Packit 792b68
 ====
Packit 792b68
 Please use the CPAN bug tracking to report bugs:
Packit 792b68
 http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-Parser
Packit 792b68

Packit 792b68
 TO DO
Packit 792b68
 =====
Packit 792b68
 Please see the file named "TODO" which should have been included
Packit 792b68
 in the Pod-Parser distribution.
Packit 792b68

Packit 792b68
 HISTORY
Packit 792b68
 =======
Packit 792b68
 Please see the file named "CHANGES" which should have been included
Packit 792b68
 in the Pod-Parser distribution.
Packit 792b68