packages icon
This directory contains the following files:

  README           - This file
  README.old       - Original README from Adam
  Changes	   - Progress of cmirror
  cmirror          - Configurable mirror script
  cmirror-1.9.lsm  - The Linux Source Map file for these scripts
  ftpmirror        - Example script to mirror multiple directories
  examples         - Some example parameter files

What is it?
  cmirror is a script written by Adam Radulovic to mirror a single directory
  from an FTP site to a local directory.  I (Kevin Sartorelli) have since
  taken over maintenance of the script due to Adams other commitments.

Getting Started
  Read the file README.old as it is Adams original introduction to cmirror.

  Next, decide whether you want to mirror a single directory, or a number of
  directories.  For instance, I mirror about 30 directories from various
  sites.  If you are only going to mirror one or two directories you can
  edit the cmirror script directly (make sure you define NO_PARAM to be 
  anything - put something between the quotes).  If you want to mirror a 
  number of directories I suggest you leave NO_PARAM with empty quotes and
  use parameter files.

  A parameter file is just a separate file with the configuration 
  information required for a single directory.  In my case I have a file 
  called .cmirror in each directory that is mirrored (see the directory 
  'examples' for some of my live config files (renamed)).

  Read the comments at the top of the cmirror script as these explain what 
  the various variables are for.

  Make sure you have read README.old and the comments at the top of the 
  cmirror script before you start sending email saying something doesn't 
  work.  If you still have problems once you have read these, please send 
  me some mail stating what your problem is and I'll see if I can help.

Suggestions

  The file ftpmirror is a simple script that searches for all .cmirror files
  and uses these files to mirror the directories they are in.  This can be 
  run from cron to mirror all directories whenever you like.

Working Directory

  The working directory (IFL variable) is used to store/use several files:
	
	crntfiles.*     = Files located in the IN_DIR
	files.*  	= Files located in the HOST_DIR
	rmaction.*	= Removed files list
	mvaction.*	= Moved files list

  If DEBUG is defined the above files will be left in the directory, as
  well as the debug file itself which will contain the raw directory listing
  from the remote host.  If you have DEBUG defined please keep an eye on
  these files as there ends up with a lot of them.
  If DEBUG isn't defined the above files will be deleted when cmirror ends.

Copyright / Warranty

  See the file README.old.

-- Kevin
        kevin@topnz.ac.nz (work)  kevin@sartorelli.gen.nz (home)