CONTENTS

• NAME
• SYNOPSIS
• DESCRIPTION
  • FROM THE COMMAND LINE
• MAIN METHODS
  • ACCESSOR METHODS
• NOTES ON CUSTOMIZATION
• SEE ALSO
• SUPPORT
• COPYRIGHT AND DISCLAIMERS
• AUTHOR

#NAME

Pod::Simple::HTMLBatch - convert several Pod files to several HTML files

#SYNOPSIS

perl -MPod::Simple::HTMLBatch -e 'Pod::Simple::HTMLBatch::go' in out

#DESCRIPTION

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 . ../seekrut
    (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)

#MAIN METHODS

#$batchconv = Pod::Simple::HTMLBatch->new;

This TODO

#