1App::PodLinkCheck(3)  User Contributed Perl Documentation App::PodLinkCheck(3)
2
3
4

NAME

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

SYNOPSIS

9        use App::PodLinkCheck;
10        exit App::PodLinkCheck->command_line;
11

FUNCTIONS

13       "$plc = App::PodLinkCheck->new (key => value, ...)"
14           Create and return a PodLinkCheck object.  The optional key/value
15           parameters are
16
17           "verbose => $integer" (default 0)
18               Print some diagnostics about checking.  Currently "verbose=>1"
19               shows all the links checked, or "verbose=>2" shows that and
20               also available targets detected in destination files etc.
21
22       "$exitcode = $plc->command_line"
23           Run a PodLinkCheck as from the command line.  Arguments are taken
24           from @ARGV and the return is an exit status code suitable for
25           "exit", so 0 for success.
26
27       "$plc->check_file ($filename)"
28           Run checks on a single file $filename and print reports to stdout.
29
30       "$plc->check_tree ($file_or_dir, ...)"
31           Run checks on all the files or directories given and print reports
32           to stdout.  Directories are traversed recursively, checking all
33           Perl files.  A Perl file is .pm, .pl or .pod.  Emacs .#foo.pm etc
34           lockfiles (dangling symlinks) are ignored.
35

SEE ALSO

37       podlinkcheck
38
39       App::PodLinkCheck::ParseLinks, App::PodLinkCheck::ParseSections
40

HOME PAGE

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

LICENSE

45       Copyright 2010, 2011, 2012, 2013, 2016, 2017 Kevin Ryde
46
47       PodLinkCheck is free software; you can redistribute it and/or modify it
48       under the terms of the GNU General Public License as published by the
49       Free Software Foundation; either version 3, or (at your option) any
50       later version.
51
52       PodLinkCheck is distributed in the hope that it will be useful, but
53       WITHOUT ANY WARRANTY; without even the implied warranty of
54       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
55       General Public License for more details.
56
57       You should have received a copy of the GNU General Public License along
58       with PodLinkCheck.  If not, see <http://www.gnu.org/licenses/>.
59
60
61
62perl v5.36.0                      2023-01-20              App::PodLinkCheck(3)
Impressum