Pod::Compiler ------------- This is an evaluation distribution of a POD compiler that turns POD documents into an object tree that can be conveniently processed by any backends. Main areas of application are converters to complex output formats like HTML, LaTeX or FrameMaker. Example applications are included: podlint is a tool to beautify existing POD documentation and to please podchecker. CONTENTS This package contains Pod::Compiler - the workhorse module Pod::node - a package for POD hyperlink nodes/destinations podchecker2 - a script that checks syntax of POD documents podlint - a script that beautifies existing POD documents AUTHOR Marek Rouchal, reusing (huge) parts of many existing POD converters. COPY/REUSE POLICY ================= This package is free software; you can redistribute it and/or modify it under the terms of the Artistic License distributed with Perl version 5.000 or (at your option) any later version. Please refer to the Artistic License that came with your Perl distribution for more details. If your version of Perl was not distributed under the terms of the Artistic License, than you may distribute this package under the same terms as Perl itself. The Artistic License should have been included in your distribution of Perl. It resides in the file named "Artistic" at the top-level of the Perl source tree (where Perl was downloaded/unpacked -- ask your system administrator if you dont know where this is). Alternatively, the current version of the Artistic License distributed with Perl can be viewed on-line on the World-Wide Web (WWW) from the following URL: http://www.perl.com/perl/misc/Artistic.html The latest version of Perl can be obtained on the World-Wide web (WWW) from the following URL: http://www.perl.com/CPAN/src/latest.tar.gz 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). Please refer to the Artistic License that came with your Perl distribution for more details. REQUIREMENTS * Perl version 5.005 or higher * File::Spec (File-Spec-0.82 or higher) (already bundled in Perl 5.6.0) * Pod::Parser (PodParser-1.17 or higher) * Pod::Find (PodParser-1.17 or higher) BUILDING & INSTALLING Build this package using the standard mechanism: perl Makefile.PL make make test make install BUGS Please send all bug reports to Marek Rouchal TODO Please see the file named "TODO" which should have been included in the distribution. HISTORY Please see the file named "Changes" which should have been included in the distribution. MORE INFO See the online documentation in Pod::Compiler ("perldoc Pod::Compiler" after installation).