Provided by: libpod-simple-perl_3.19-1_all
Pod::Simple::HTMLBatch - convert several Pod files to several HTML files
perl -MPod::Simple::HTMLBatch -e 'Pod::Simple::HTMLBatch::go' in out
This module is used for running batch-conversions of a lot of HTML documents This class is NOT a subclass of Pod::Simple::HTML (nor of bad old Pod::Html) -- although it uses Pod::Simple::HTML for doing the conversion of each document. The normal use of this class is like so: use Pod::Simple::HTMLBatch; my $batchconv = Pod::Simple::HTMLBatch->new; $batchconv->some_option( some_value ); $batchconv->some_other_option( some_other_value ); $batchconv->batch_convert( \@search_dirs, $output_dir ); FROM THE COMMAND LINE Note that this class also provides (but does not export) the function Pod::Simple::HTMLBatch::go. This is basically just a shortcut for "Pod::Simple::HTMLBatch->batch_convert(@ARGV)". It's meant to be handy for calling from the command line. However, the shortcut requires that you specify exactly two command-line arguments, "indirs" and "outdir". Example: % mkdir out_html % perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go @INC out_html (to convert the pod from Perl's @INC files under the directory ./out_html) (Note that the command line there contains a literal atsign-I-N-C. This is handled as a special case by batch_convert, in order to save you having to enter the odd-looking "" as the first command-line parameter when you mean "just use whatever's in @INC".) Example: % mkdir ../seekrut % chmod og-rx ../seekrut % perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go . ../htmlversion (to convert the pod under the current dir into HTML files under the directory ./seekrut) Example: % perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go happydocs . (to convert all pod from happydocs into the current directory)
NOTES ON CUSTOMIZATION
If you want to do some kind of big pod-to-HTML version with some particular kind of option that you don't see how to achieve using this module, email me ("email@example.com") and I'll probably have a good idea how to do it. For reasons of concision and energetic laziness, some methods and options in this module (and the dozen modules it depends on) are undocumented; but one of those undocumented bits might be just what you're looking for.
Pod::Simple, Pod::Simple::HTMLBatch, perlpod, perlpodspec
Questions or discussion about POD and Pod::Simple should be sent to the firstname.lastname@example.org mail list. Send an empty email to email@example.com to subscribe. This module is managed in an open GitHub repository, http://github.com/theory/pod-simple/ <http://github.com/theory/pod-simple/>. Feel free to fork and contribute, or to clone git://github.com/theory/pod-simple.git <git://github.com/theory/pod-simple.git> and send patches! Patches against Pod::Simple are welcome. Please send bug reports to <firstname.lastname@example.org>.
COPYRIGHT AND DISCLAIMERS
Copyright (c) 2002 Sean M. Burke. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.
Pod::Simple was created by Sean M. Burke <email@example.com>. But don't bother him, he's retired. Pod::Simple is maintained by: · Allison Randal "firstname.lastname@example.org" · Hans Dieter Pearcey "email@example.com" · David E. Wheeler "firstname.lastname@example.org"