NAME

pod_server - start a web server that serves locally installed perl docs

SYNOPSIS

Usage:

  pod_server [OPTION]...

Run in "daemonized" mode:

  ( pod_server > /dev/null 2>&1 ) &

Use a light colored theme:

  pod_server -bg '#fff' -fg '#222' -cfg '#224' -pbg '#777' -afg '#48f' -ahfg '#248'

DESCRIPTION

This script has been provided to make it easy to start Pod::Server. It's name is a homage to gem_server from the Ruby world.

OPTIONS

-p, --port NUM

This is the port that the web server should listen on.

--font_size SIZE

This is the font size for the text

-bg, --background_color COLOR

-fg, --foreground_color COLOR

-pbg, --pre_background_color COLOR

-pfg, --pre_foreground_color COLOR

-cfg, --code_foreground_color COLOR

-afg, --a_foreground_color COLOR

-ahfg, --a_hover_foreground_color COLOR

I hope all these colors are self-explanatory. The color argument should be expressed in terms that CSS understands. For example:

  #301
  #ffffff
  rgb(128,230,255)
  blue

-s, --sidebar POSITION

When viewing POD in the optional framed mode, you may choose to put the sidebar on the 'left' or the 'right'.

-f, --first MODULE

When you enter framed mode, you get to see this POD first.

-h, --help

Display the useful help message.

AUTHOR

John BEPPU <beppu@cpan.org>