__ ____ ____ __ \ \ / /\ \ / /\ \ / / _ _ \ \ /\ / / \ \ /\ / / \ \ /\ / / (_|_) \ V V / \ V V / \ V V / _ _ \_/\_/ \_/\_/ \_/\_/ (_|_) _ _ _ ____ _ | | (_)_ __ | | _| _ \ ___ | |_ | | | | '_ \| |/ / |_) / _ \| __| | |___| | | | | <| _ < (_) | |_ |_____|_|_| |_|_|\_\_| \_\___/ \__| This is the README for WWW::LinkRot version 0.02. WWW::LinkRot is a "module" for the Perl computer programming language, a library of computer code to install on a computer. This document contains four sections: 1. About - what the module does 2. Documentation - how to learn more about the module 3. Installation - how to install this module on a computer 4. Help - what to do if you get stuck ----------------------------------------------------------------------------- 1. ABOUT WWW::LinkRot - check web page link rot Scan HTML files for links, try to access the links, and make a report. The HTML files need to be in UTF-8 encoding. This module is intended for people who run web sites to run, for example, periodic checks over a large number of HTML files to find all of the external links in those files, then given that list of links, test each link to make sure that it is actually valid. The reading function is "get_links" which works on a list containing file names such as might be created by a module like "Trav::Dir" or "File::Find". It looks for any "https?://" links in the files and makes a list. The list of links may then be checked for validity using "check_links" which runs the "get" method of "LWP::UserAgent" on them and stores the status. This outputs a JSON file containing the link, the status, the location, and the files which contain the link. The function "html_report" generates an HTML representation of the JSON file. The function "replace" is a batch editing function which inputs a list of links and a list of files, then substitutes the redirected links (the ones with status 301 or 302) with their replacement. ----------------------------------------------------------------------------- 2. DOCUMENTATION You can read the documentation for the module online at the following website: * http://metacpan.org/release/WWW-LinkRot (This link goes to the latest version of the module.) After installing the module, you can read the documentation on your computer using perldoc WWW::LinkRot ----------------------------------------------------------------------------- 3. INSTALLATION This module requires Perl version 5.6.1 or later. To install the module from CPAN, use cpan WWW::LinkRot If you have the App::cpanminus installer, you may prefer cpanm WWW::LinkRot To install the module from the source file, WWW-LinkRot-0.02.tar.gz, follow this sequence of commands: tar xfz WWW-LinkRot-0.02.tar.gz cd WWW-LinkRot-0.02 perl Makefile.PL make make install If you want to test the module before installing it, use "make test" after "make" and before "make install". ----------------------------------------------------------------------------- 4. HELP To get help with the module, you can email the author, Ben Bullock, at <bkb@cpan.org>. If you think there is a problem in the module, you can report a bug at <https://github.com/benkasminbullock/www-linkrot/issues>, or if you want to alter the source code of WWW::LinkRot, try the public repository on github at <https://github.com/benkasminbullock/www-linkrot>. ----------------------------------------------------------------------------- This README was written on Fri Apr 23 08:30:32 2021. -----------------------------------------------------------------------------