NAME

POD::Walker - Walks a directory and runs any Perl files through the specified POD converter.

VERSION

Version 0.0.0

SYNOPSIS

    use POD::Walker;
    my $returned=POD::Walker->run({in=>"/input/path", out=>"/output/path", format=>"html" });
    if($returned->{error}){
        print "Error: ".$returned->{error}."\n";
    }

FUNCTION

run

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.

args hash ref

changesCopy

This copies any "Changes" files.

This defaults to "1".

in

The directory to start in.

format

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.

manifestCopy

This copies any "MANIFEST" files.

This defaults to "1".

readmeCopy

This copies any "README" files.

This defaults to "1".

out

This is the directory to output to.

process

This is a internal function.

RETURN HASH

error

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".

error codes

1

No arguements passed.

2

No in directory specified.

3

No in directory specified.

4

The input directory does not exist or is not a directory.

5

The input directory is not readable.

6

The specified outpbut directory does not exist, is is not a directory, or could not be created.

7

The output directory is not readable.

8

The output directory is not writable.

9

Failed to open the input directory.

errored

This contains a list of files or directories that could not be processed.

AUTHOR

Zane C. Bowers, <vvelox at vvelox.net>

BUGS

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.

SUPPORT

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/

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

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.

cpanm POD::Walker

perl -MCPAN -e shell
install POD::Walker