NAME

Apache::Pod::HTML - base class for converting Pod files to prettier forms

VERSION

Version 0.03

$Header: /home/cvs/apache-pod/lib/Apache/Pod/HTML.pm,v 1.12 2004/05/10 20:51:44 andy Exp $

SYNOPSIS

A simple mod_perl handler to easily convert Pod to HTML or other forms. You can also emulate perldoc.

CONFIGURATION

Pod-to-HTML conversion

Add the following lines to your httpd.conf.

<Files *.pod>
    SetHandler perl-script
    PerlHandler Apache::Pod::HTML
</Files>

All *.pod files will magically be converted to HTML.

perldoc emulation

The following configuration should go in your httpd.conf

<Location /perldoc>
    SetHandler  perl-script
    PerlHandler Apache::Pod::HTML
    PerlSetVar  STYLESHEET auto
</Location>

You can then get documentation for a module Foo::Bar at the URL http://your.server.com/perldoc/Foo::Bar

Note that you can also get the standard Perl documentation with URLs like http://your.server.com/perldoc/perlfunc or just http://your.server.com/perldoc for the main Perl docs.

Finally, you can search for a particular Perl keyword with http://your.server.com/perldoc/f/keyword The 'f' is used by analogy with the -f flag to perldoc.

Specifying 'auto' for the stylesheet will cause the built-in CSS stylesheet to be used. If you prefer, you can replace the word 'auto' with the URL of your own custom stylesheet file.

AUTHOR

Andy Lester <andy@petdance.com>, adapted from Apache::Perldoc by Rich Bowen <rbowen@ApacheAdmin.com>

LICENSE

This package is licensed under the same terms as Perl itself.