|$perl_bin = new Pod::Tree::PerlBin $perl_dir, $HTML_dir, $perl_map, %options||
Creates and returns a new Pod::Tree::PerlBin object.
$HTML_dir is the directory where HTML files will be written.
$perl_map maps program names to URLs.
%options are passed through to Pod::Tree::HTML.
The $perl_dir argument is included for consistency with the other Pod::Tree::Perl* modules, but is currently unused.
Scans all the directories in @path for program PODs.
Only text (-T) files are considered.
The search does not recurse through subdirectories.
Each POD that is located is entered into $perl_map.
|$perl_bin->index||Generates a top-level index of all the program PODs, and writes it to HTML_dir/bin.html.|
|$perl_bin->translate||Translates each program POD found by scan to HTML. The HTML pages are written to HTML_dir.|
Returns a hash reference of the form
Pod::Tree::PerlTop uses this to build a top-level index of all the Perl PODs.
Pod::Tree::PerlBin expects the second paragraph of the POD to have the form
name - description
and enters name into $perl_map. To link to a program POD from another POD, write
5.005 File::Find HTML::Stream Pod::Tree Pod::Tree::HTML Pod::Tree::PerlUtil
Steven McDougall, email@example.com
Copyright (c) 2000 by Steven McDougall. This module is free software; you can redistribute it and/or modify it under the same terms as Perl.
|perl v5.20.3||POD::TREE::PERLBIN (3)||2015-05-25|