From 9117a7a55b5e5aa2f9132d69f7d33ad3e7069349 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sat, 22 May 2010 14:43:30 +0200 Subject: Add documentation --- bin/comirror-setup | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) (limited to 'bin/comirror-setup') diff --git a/bin/comirror-setup b/bin/comirror-setup index b38cfe4..05661bf 100755 --- a/bin/comirror-setup +++ b/bin/comirror-setup @@ -98,3 +98,55 @@ line_to_file($image_re, 'image_re'); print "\nimage_re: ${image_re}\n\n"; say "\"next\" link text: ${next_link}"; say "If this is correct, type 'comirror' to start mirroring"; + +__END__ + +=head1 NAME + +B - Set up a directory to be used by B + +=head1 SYNOPSIS + +B I + +=head1 DESCRIPTION + +B takes three URL argumets: The very first page of the web +comic, the second page, and the last but one page. + +Based on these arguments, it tries to set up the current working directory so +that you only need to call B to mirror the webcomic you were +pointing to. It does this by comparing the last two URLs to determine a +correct image_re and then creating last_uri with the first URL so that +B will start at the right point and download the right images. + +=head1 OPTIONS + +B takes no options yet. + +=head1 EXIT STATUS + +Non-zero on grave errors, zero otherwise. + +=head1 CONFIGURATION + +B is not configurable. + +=head1 DEPENDENCIES + +This script requires the perl module WWW::Mechanize. + +=head1 BUGS AND LIMITATIONS + +As with B itself: This script has no brain. +So far, this script is very dumb and fragile. It's recommended to take a +quick glance at the image_re before actually calling comirror to make sure you +get what you want. + +=head1 AUTHOR + +Copyright (C) @@year@@ by Daniel Friesel Ederf@chaosdorf.deE + +=head1 LICENSE + + 0. You just DO WHAT THE FUCK YOU WANT TO. -- cgit v1.2.3