John Beppu > Pod-Server > Pod::Server

Download:
Pod-Server-1.14.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.14   Source  

NAME ^

Pod::Server - a web server for locally installed perl documentation

SYNOPSIS ^

Usage for the pod_server script:

  pod_server [OPTION]...

Examples:

  pod_server --help

  pod_server -bg '#301'

Then, in your browser, visit:

  http://localhost:8088/

How to start up a Continuity-based server manually (via code):

  use Pod::Server 'On::Continuity';
  Pod::Server->init;
  Pod::Server->continue(port => 8088);

How to embed Pod::Server into a Catalyst app:

  use Pod::Server 'On::Catalyst';
  Pod::Server->init;
  Pod::Server->relocate('/pod');
  $Pod::Simple::HTML::Perldoc_URL_Prefix = '/pod/';
  sub pod : Local { Pod::Server->catalyze($_[1]) }

DESCRIPTION ^

In the Ruby world, there is a utility called gem_server which starts up a little web server that serves documentation for all the locally installed RubyGems. When I was coding in Ruby, I found it really useful to know what gems I had installed and how to use their various APIs.

"Why didn't Perl have anything like this?"

Well, apparently it did. If I had searched through CPAN, I might have found Pod::Webserver which does the same thing this module does. After more searching, I might have discovered Pod::POM::Web. And then just recently, Pod::Browser was uploaded to CPAN. (It's getting kinda crowded here.)

However, I didn't know any of this at the time, so I ended up writing this module. At first, its only purpose was to serve as an example Squatting app, but it felt useful enough to spin off into its own perl module distribution.

I have no regrets about duplicating effort or reinventing the wheel, because Pod::Server has a lot of nice little features that aid usability and readability. It is also quite configurable. To see all the options run any of the following:

  pod_server -h

  squatting Pod::Server --show-config

  squatting Pod::Server --show-config | perltidy -i 4

API ^

Home

get

Rescan

get

Frames

get

Source

get

Pod

get

SEE ALSO ^

Squatting, Continuity, Pod::Webserver, Pod::POM::Web, Pod::Browser

Pod::Server Source Code

The source code is available at:

http://github.com/beppu/pod-server/tree/master

AUTHOR ^

John BEPPU <beppu@cpan.org>

COPYRIGHT ^

Copyright (c) 2008 John BEPPU <beppu@cpan.org>.

The "MIT" License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

syntax highlighting: