POD::Walker - Walks a directory and runs any Perl files through the specified POD converter.
Version 0.0.0
use POD::Walker; my $returned=POD::Walker->run({in=>"/input/path", out=>"/output/path", format=>"html" }); if($returned->{error}){ print "Error: ".$returned->{error}."\n"; }
Process a directory try and ignore any hidden directories or files.
The returned value is a hash. See the section "RETURN HASH" for more information.
This copies any "Changes" files.
This defaults to "1".
The directory to start in.
The output type. This can be any of the ones listed below.
html latex man text
If one is not specified, 'html' will be used.
This copies any "MANIFEST" files.
This copies any "README" files.
This is the directory to output to.
This is a internal function.
This integer represents if there is a error or note.
This is set to true if there was an error is set to a integet greater than or equal to "1".
No arguements passed.
No in directory specified.
The input directory does not exist or is not a directory.
The input directory is not readable.
The specified outpbut directory does not exist, is is not a directory, or could not be created.
The output directory is not readable.
The output directory is not writable.
Failed to open the input directory.
This contains a list of files or directories that could not be processed.
Zane C. Bowers, <vvelox at vvelox.net>
<vvelox at vvelox.net>
Please report any bugs or feature requests to bug-pod-walker at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POD-Walker. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-pod-walker at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc POD::Walker
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=POD-Walker
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/POD-Walker
CPAN Ratings
http://cpanratings.perl.org/d/POD-Walker
Search CPAN
http://search.cpan.org/dist/POD-Walker/
Copyright 2010 Zane C. Bowers, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install POD::Walker, copy and paste the appropriate command in to your terminal.
cpanm
cpanm POD::Walker
CPAN shell
perl -MCPAN -e shell install POD::Walker
For more information on module installation, please visit the detailed CPAN module installation guide.