Rechercher une page de manuel
podtohtml
Langue: en
Version: 2007-03-18 (mandriva - 01/05/08)
Section: 1 (Commandes utilisateur)
NAME
podtohtml - convert POD documentation to HTMLSYNOPSIS
podtohtml [-bhqvIS] [-i index] [-d outdirectory] [-s sfx] <pods or directories of pods...>
DESCRIPTION
"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
- * Active links are only built for pods processed in the same invocation.
- * Large documents are not split.
- * HTML::FormatPS's style does not suit Nick's taste.
- * The index file needs more structure.
SEE ALSO
Pod::Parser Pod::Links Pod::HTML_Elements HTML::Element HTML::FormatPSAUTHOR
Nick Ing-Simmons <nick@ni-s.u-net.com>Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre