NAME

Perldoc::Server - local Perl documentation server

SYNOPSIS

perldoc-server [options]

Options:
--perl /path/to/perl   Show documentation for this Perl installation
--port 1234            Set server port number
--help                 Display help

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 the --perl command-line option, e.g.

perldoc-server --perl /usr/bin/perl

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>

Perldoc::Server was developed at the 2009 QA Hackathon http://qa-hackathon.org supported by Birmingham Perl Mongers http://birmingham.pm.org

COPYRIGHT and 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.