NAME

Perldoc::Server - local Perl documentation server

SYNOPSIS

script/perldoc_server_server.pl

DESCRIPTION

Perldoc::Server is a Catalyst application to serve local Perl documentation in the same style as http://perldoc.perl.org.

In addition to keeping the same look and feel of http://perldoc.perl.org, Perldoc::Server offer the following features:

• View source of any installed module

• Improved syntax highlighting

  • Line numbering

  • use and require statements linked to modules

• Sidebar shows links to your 10 most viewed documentation pages

CONFIGURATION

By default, Perldoc::Server will show documentation for the Perl installation used to run the server.

However, it is also possible to serve documentation for a different Perl installation using a configuration file perldoc_server.conf as follows (example shown for Perl 5.8.9):

perl /Users/jj/perl/perl-5.8.9/bin/perl
perl_version 5.8.9
search_path /Users/jj/perl/perl-5.8.9/lib/5.8.9/darwin-2level
search_path /Users/jj/perl/perl-5.8.9/lib/5.8.9
search_path /Users/jj/perl/perl-5.8.9/lib/site_perl/5.8.9/darwin-2level
search_path /Users/jj/perl/perl-5.8.9/lib/site_perl/5.8.9

SEE ALSO

http://perldoc.perl.org

http://perl.jonallen.info/projects/perldoc

Penny's Arcade Open Source - http://www.pennysarcade.co.uk/opensource

AUTHOR

Jon Allen (JJ) <jj@jonallen.info>

LICENSE

Copyright (C) 2009 Penny's Arcade Limited - http://www.pennysarcade.co.uk

This library is free software, you can redistribute it and/or modify it under the same terms as Perl itself.