On Tue, Apr 2, 2013 at 10:27 PM, David Christensen <
dpchr...@holgerdanske.com> wrote:
> beginners:
>
> I would like to create static HTML trees of Perl documentation, similar to
> perldoc.perl.com:
>
> 1. Is there a canonical system path (directory) for such? Is there a
> canonical per-user path for such? For development?
>
2. Is there a corresponding canonical environment variable for the path?
>
No to all of these. Technically, Perl does have some config variables that
"should" point to a directory for the HTML version of the docs[1] but in
most cases, unless you're installing Perl yourself and choose to manually
set them, they'll be empty, even in systems that install the HTML docs[2].
>
> 3. Is pod2html the canonical tool for creating the HTML files? If not,
> what tool?
>
> 4. Is there a canonical tool for populating the entire HTML tree from all
> installed Perl modules/POD?
>
>
If you want Perl's documentation, the distribution comes with a installhtml
script that will do exactly what you want[3]. Otherwise, yes, pod2html is
the usual way of of going from pod to HTML.
[1] Namely, these: $ perl -MConfig -E "say join q{, }, grep /html/, keys
%Config"
html1dir, html1direxp, html3dir, html3direxp, installhtml1dir,
installhtml3dir, installhtmldir, installhtmlhelpdir, installsitehtml1dir,
installsitehtml3dir, installvendorhtml1dir, installvendorhtml3dir,
sitehtml1dir, sitehtml1direxp, sitehtml3dir, sitehtml3direxp,
vendorhtml1dir, vendorhtml1direxp, vendorhtml3dir, vendorhtml3direxp
[2] Windows
[3] See 'installhtml --help' in INSTALL, and the script itself, for details
