pod_html_doc -- Create local HTML-Doku from pod
HTML-Doc for this script in the working dir
pod_html_doc --file pod_html_doc
HTML-Doc for IO::File IO::Handle IO::Seekable IO::Dir in html-out/
pod_html_doc --outdir=html-out/ IO::File IO::Handle IO::Seekable IO::Dir
HTML-Doc for Pod::Simple::HTML in html-out/
pod_html_doc --outdir=html-out/ --module=Pod::Simple::HTML
This converter create local documentations from POD Files and Modules with POD-Documentations. All Files for an Module will beconverted.
Set destination directory for the HTML files. Default directory is the current.
Set source directory for the pod files. Default directory is the current.
Set one or more directories where modules can be found. This works also for Modulnames linked in the POD
Set one or more modules which POD should be converted
If the Modulname is a Filename the name will be searched in @INC. This can be supressed by using "--strict"
Correct Modulnames are even searched in @INC
you can add path names to @INC with "--inc"
Set one or more files which POD should be converted
The searchpath for relative filepaths is set with "--basedir"
If the filename looks like a path to an Module the Name will be converted. The only Searchpath is set with "--basedir" This can be supressed by using "--strict"
so remember:
--env and --modules
--file and --basedir
Please use --file not for modules and --module not for normal files. The script tries to solve that, but it's not bullet prove.
Set the character encoding in HTML document. UTF-8 is set as default. If available the enviroment variable MM_CHARSET or HTML_CHARSET will be used.
Set CSS-file This file must not exists only the filename will be inclued in the HTML.
Create Page Index This behavior is disabled by default
print a short helptext
At every already existing file ask if it may be replaced. Default is "Yes".
Explans neearly everything.
all errors are ignored. If a file could not be created or any other error occured the script will not stop
don't convert Files to Modules.
Set anchors for list entries. That's a hack! =item 1 and =item * Name don't get an link-anchor. This option search for <li> Name in the html and set the anchor. But it's a regexp hack, and can produce wrong link-anchors.
Convert all Files related to IO::File:
pod_html_doc --outdir=html-out/ IO::File IO::Handle IO::Seekable IO::Dir
more komplex creation, with css-file index.pod and an own module. In each file an Index is created.
Creates index.html and OWN_Module.html in html-out/
pod_html_doc --outdir=html-out/ --basedir=LIBS/ --file=OWN/index.pod --env=LIBS/ --module=OWN::Module --style=pod.css --index
ToPeG
Version 1.1
Copyright (c) ToPeG. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms and conditions as Perl itself.
This means that you can, at your option, redistribute it and/or modify it under either the terms the GNU Public License (GPL) version 2 or later, or under the Perl Artistic License.
See http://dev.perl.org/licenses/
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Use of this software in any way or in any form, source or binary, is not allowed in any country which prohibits disclaimers of any implied warranties of merchantability or fitness for a particular purpose or any disclaimers of a similar nature.
IN NO EVENT SHALL I BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION (INCLUDING, BUT NOT LIMITED TO, LOST PROFITS) EVEN IF I HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE