DragonFly On-Line Manual Pages

PODTOHTML(1)          User Contributed Perl Documentation         PODTOHTML(1)

NAME
       podtohtml - (DEPRECATED) convert POD documentation to HTML

SYNOPSIS
               THIS IS A DEPRECATED PROGRAM. See Pod::Simple::HTML instead.

               podtohtml [-bhqvIS] [-i index] [-d outdirectory] [-s sfx] <pods or directories of pods...>

DESCRIPTION
       THIS IS A DEPRECATED PROGRAM.

       "podtohtml" converts POD documentation to HTML. It is based on the
       generic Pod::Parser. It works by making two passes over the selected
       pods, the fisrt pass uses Pod::Links to pre-scan for L<> links and
       "=head1 NAME" sections, and then a second to build a tree of
       HTML::Elements for each POD and calling the "as_HTML" method on the
       resulting tree.

       The Generated HTML uses relative links.

OPTIONS
       The following command line options affect the behaviour:

       -b  Create broken links

       -d outdirectory
           The directory into which the HTML is written.

       -q  Run as quietly as possible

       -v  Verbose - print messages about files being processed.

       -s suffix
           Set the suffix for generated files. Default is '.html' for HTML
           files and '.ps' for PostScript files.

       -i index
           Build an index file in index.

       -I  Search perl's @INC for pods. Heuristics implemented in Pod::Find
           attempt to restrict search to files related to the version of perl
           executing the script.

       -S  Search directory that is specified in "Config" as install location
           of scripts for pods.

       -p  Generate PostScript rather than HTML. This is done using
           HTML::FormatPS and font sizes etc. are not yet specifiable.

       -D  Print Data::Dumper dump of generated tree rather than generating
           HTML (for debugging).

EXAMPLES
   Build HTML for all installed modules and associated scripts :
          podtohtml -I -S -d "/home/WWW/perl" -i "/home/WWW/perl/index.html"

       That takes rather a long time (22 minutes on my 60MHz SPARCStation10).

   Build HTML for unistalled Tk extension:
          podtohtml -d "/home/WWW/Tk8" -i /home/WWW/TkIndex.html ~/Tk8/pod

BUGS
       THIS IS A DEPRECATED PROGRAM. THESE BUGS WILL NOT BE FIXED.

       o   Active links are only built for pods processed in the same
           invocation.

       o   Large documents are not split.

       o   HTML::FormatPS's style does not suit Nick's taste.

       o   The index file needs more structure.

SEE ALSO
       Pod::Simple::HTML

AUTHOR
       Nick Ing-Simmons <nick@ni-s.u-net.com>

perl v5.20.2                      2008-07-27                      PODTOHTML(1)