App::PodLinkCheck(3)

📦
version 15 · 4 versions
, in epel 9

✨ App::PodLinkCheck 💅

okay so bestie, this is the App::PodLinkCheck manual page — a Perl module for checking your Perl pod L<> link references. yes, those links. the ones you wrote at 3am and never verified. she's here to save you. 🎀

🌸 NAME 🌸

App::PodLinkCheck — check Perl pod L<> link references, no cap 💅

✨ SYNOPSIS ✨

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

that's literally it. load it, run it, exit with whatever it hands back. iconic behavior honestly. 🦋

🫶 FUNCTIONS 🫶

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

makes you a fresh PodLinkCheck object and returns it. the key/value params are all optional, and here's the tea:

  • verbose => $integer (default 0) — prints some diagnostics while it's checking. right now verbose=>1 shows you all the links it checked, and verbose=>2 shows that plus the available targets it spotted in destination files etc. so basically: level 1 = receipts, level 2 = receipts + the whole group chat. 🍓

$exitcode = $plc->command_line

runs a PodLinkCheck just like you did it from the command line. arguments come from @ARGV, and the return value is an exit status code that's suitable to hand straight to exit — so 0 means success, bestie. ✨

$plc->check_file ($filename)

runs the checks on one single file, $filename, and prints the reports to stdout. one file, one vibe check. 🌸

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

runs checks on every file or directory you hand it and prints reports to stdout. directories get traversed recursively and every Perl file inside gets checked. a Perl file is .pm, .pl or .pod. and Emacs .#foo.pm etc lockfiles — you know, the dangling symlinks — get ignored entirely. 👑

👀 SEE ALSO 👀

  • podlinkcheck
  • App::PodLinkCheck::ParseLinks, App::PodLinkCheck::ParseSections

🌈 HOME PAGE 🌈

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

go visit her, she's lovely. 💖

💜 LICENSE 💜

Copyright 2010, 2011, 2012, 2013, 2016, 2017 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/>.

and that's the whole page, bestie 🧚 so slay, so legal, so very GPL. this one's perl v5.32.1, dated 2022-01-14 — stan a classic 💅✨🦋

📦 where this page comes from