README.pod6

=begin pod

=TITLE Pod::To::BigPage

=SUBTITLE Convert a bunch of Pod 6 files to (X)HTML

Module and script for converting documentation written in Pod 6 to a single file publishable in the web.

=begin SYNOPSIS

From the command line:

     pod2onepage -v --source-path=../../perl6-doc/doc \
                 --exclude=404.pod6,/.git,/precompiled > tmp/html.xhtml

or, if you want to produce HTML

    pod2onepage -v --source-path=. --html\
                 --exclude=404.pod6,/.git,/precompiled > tmp/pod2onepage.html

It can be used also as a library.

=begin code
use Pod::To::BigPage;
=begin pod
=head1 This is the head
=head2 More stuff here

And just your average text.
=end pod

setup();
compose-before-content($=pod); # Produces XHTML
compose-before-content($=pod,''); # Produces HTML
=end code

=end SYNOPSIS

=head2 X<Options|Options>

=item C<-v --verbose>

  verbose output

=item C<--source-path>

  Where to look for files ending in `.pod6`.

=item C<--exclude>

  Comma separated list of strings the processed files or paths shall not end with.

=item C<--no-cache>

  Don't use precompilation to cache `pod6` files.


=item C<--precomp-path>

  Sets the path where precompiled `pod6` files are created. Defaults to environment
  variable `TEMP`, `TMP` or `/tmp`.

=item C<--html>

  Generate HTML instead of the default XHTML.
  
  
=end pod