/ 
Apache-mod_perl_guide-1.23
/ Pod::HTML-n-PDF::Builder

NAME

Pod::HTML-n-PDF::Builder -- builds HTML, PS and PDF from multiple POD files

SYNOPSYS

./bin/build.pl -<options>

Options:

  -h    this help
  -v    verbose
  -t    create tar.gz
  -p    generate PS file
  -d    generate PDF file
  -f    force a complete rebuild
  -a    print available hypertext anchors
  -l    do hypertext links validation
  -m    executed from Makefile (forces rebuild,
				no PS/PDF file,
				no tgz archive!)

DESCRIPTION

This code knows to do three things with your POD files.

  1. Generate HTMLs

  2. Generate a special version of HTMLs and convert them into a single PostScript file

  3. Generate a special version of HTMLs and convert them into a single PostScript file and then into a PDF file.

You can customise the look and feel of the PS and therefore the PDF by tweaking the ./bin/html2ps file. You might need to read the html2ps manual to do some complex changes.

Be careful that if your documentation that you want to put in one PS or PDF file is very big and you tell html2ps to put the TOC at the beginning you will need lots of memory because it won't write a single byte to the disk before it gets all the HTML markup converted to PS.

When you want to use your own files in this convertor, make sure you list them in ./bin/build.pl using the order you want them to show up in the PS or PDF format.

EXTENSION

Note that this tool uses Guide::Pod2Html and Guide::Pod2HtmlPS which understand an extended POD symantics. It's described in docs/extended_pod.pod

PREREQUISITES

All these are not required if all you want is to generate only the html version.

  • html2ps

    from http://www.tdb.uu.se/~jan/html2ps.html

    Needed to generate the PS and PDF versions

  • ps2pdf

    Needed to generate the PDF version

  • Storable

    Perl module available from CPAN (http://cpan.org/)

    Allows source modification control, so if you modify only one file you will not have to rebuild everything to get the updated HTML files.

SUPPORT

Notice that this tool relies on two tools (ps2pdf and html2ps) which I don't support. So if you have any problem first make sure that it's not a problem of these tools.

BUGS

Huh?

AUTHOR

Stas Bekman <stas@stason.org>

SEE ALSO

perl(1), Pod::HTML, html2ps, ps2pod(1), Storable(3)

COPYRIGHT

This program is distributed under the Artistic License.