mirtool - make peace with your mirror


mirtool is a bash script to aid in the maintenance of an ftp mirror.

mirtool processes a target directory and subdirectories, processing
the conventional ".listing" files provided by many ftp servers.

In default mode, mirtool reports any discrepancies found between the
contents of a directory and what the corresponding .listing file says
should be there, recursively descending into any subdirectories found.

mirtool checks for and reports:

(*)	missing directories, files, or symbolic links:
	a subdirectory, file, or symbolic link listed in the
	.listing file is not found in the directory.

(*)	excess directories, files, or symbolic links:
	a subdirectory, file, or symbolic link found in the
	directory is not found in the .listing file.
	excess .listing files are ignored.

(*)	unknown file types: not a file, symbolic link, or directory.

by default, mirtool will not descend symbolic links that point to 
directories.  giving the --recurse-links option causes mirtool to
follow symbolic links that point to directories.

the --no-recurse option turns off recursion.  mirtool will
then operate only on the directories named on the command line.

given the --clean option, mirtool will delete any excess directories,
files or symbolic links encountered.

given the --create option, mirtool will create a .listing file,
replacing any .listing file found, with a file generated from the
actual contents of the directory.  the name of the file to be
generated can be set with the --create-name option.

--------
DOWNLOAD
--------

mirtool can be download by HTTP at the mirtool home world, 
 http://prv8.net/mirtool/mirtool.gz
 http://prv8.net/mirtool/mirtool.README

------------
INSTALLATION
------------

(1) mv mirtool.gz to your favourite directory in PATH.
(2) gzip -d mirtool.gz
(3) done.

---------
OPERATION
---------

syntax: mirtool [ options [...] ] [ directory [...] ]
	(default)	Report any discrepancies found.
	--clean		Report any discrepancies found while deleting them. DANGEROUS!
	--confirm	Report any discrepencies found and ask if to delete.
	--makelist	Create .listing file.
	--listname name	Use given filename instead of .listing.
	--no-recurse	do not descend into directories. (default is recurse).
	--recurse-link	descend into linked directories (default is ignore).


---------------
THE SMALL PRINT
---------------

 Copyright (c) 2002,2008 by William Hunt, Portland Oregon USA, all rights
reserved.  Licensed under any version of the Gnu Public License.
 email wjh@prv8.net with bugs, fixes, comments, complaints, and suggestions.

tha-tha-tha-that's all, folks!