Kevin Ryde > podlinkcheck > App::PodLinkCheck

Download:
podlinkcheck-12.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 12   Source  

NAME ^

App::PodLinkCheck -- check Perl pod L<> link references

SYNOPSIS ^

 use App::PodLinkCheck;
 exit App::PodLinkCheck->command_line;

FUNCTIONS ^

$plc = App::PodLinkCheck->new (key => value, ...)

Create and return a PodLinkCheck object. The optional key/value parameters are

verbose => $integer (default 0)

Print some diagnostics about checking. Currently verbose=>1 shows all the links checked, or verbose=>2 shows that plus available targets detected in destination files etc.

$exitcode = $plc->command_line

Run a PodLinkCheck as from the command line. Arguments are taken from @ARGV and the return is an exit status code suitable for exit, being 0 for success.

$plc->check_file ($filename)

Run checks on a single file $filename.

$plc->check_tree ($file_or_dir, ...)

Run checks on all the files or directories given. Directories are traversed recursively, checking all Perl files. A Perl file is .pm, .pl or .pod. Emacs .#foo.pm etc dangling symlink lockfiles are ignored.

SEE ALSO ^

podlinkcheck

HOME PAGE ^

http://user42.tuxfamily.org/podlinkcheck/index.html

LICENSE ^

Copyright 2010, 2011, 2012, 2013 Kevin Ryde

PodLinkCheck is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

PodLinkCheck is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PodLinkCheck. If not, see <http://www.gnu.org/licenses/>.

syntax highlighting: