@database MTM
@master MTM.guide
@$VER: 1.0
@font thin711.font 11
@width 76

@node "Main" "Move To Mirror"
@next "COPYRIGHTS"
@prev "AUTHOR"
 ===========================================================================

                     M O V E   T O   M I R R O R   2 . 5

                             E M A I L W A R E

                         by Kenneth "Kenny" Nilsen

                   Copyright (C) 1997 by Digital Surface

===========================================================================



     @{"  Copyright                      " link "COPYRIGHTS" 0}          Important notes


     @{"  Introduction                   " link "INTRO" 0}          What this program do


     @{"  Requirements and installation  " link "REQINSTALL" 0}          Nice stuff


     @{"  Usage                          " link "USAGE" 0}          How to use this program


     @{"  Author                         " link "AUTHOR" 0}          Address and notes



===========================================================================
@endnode

@node "COPYRIGHTS" "Copyrights"
@next "INTRO"
@prev "Main"
===========================================================================
                                 COPYRIGHT
===========================================================================


This program is EMAILWARE. You can use this program freely on a regular
basis if you send author an email with a short comment. Please take the
time to send an email as this will determine future support for this
program.

You may distribute this archive freely as long there is no changes made to
any of the files in the archive or that there is no fee taken other than a
nominal fee for media usage.

You cannot distribute the binary files seperatly without prior written
permission from author.


===========================================================================
@endnode

@node "INTRO" "Introduction"
@next "REQINSTALL"
@prev "COPYRIGHTS"
===========================================================================
                                INTRODUCTION
===========================================================================


This little program will organize your local AmiNet mirror on your HD. Most
times after downloading files from AmiNet all the files are in the same
directory. This is very messy if there are lots of files.

This program scans the messy directory, creates subdirs in the destination
dir you want the mirror, based on the Type field in the readme file. It
then moves or copies the files optionally with the readme files and the
short: field as the new filecomment. It can even do pattern matching of the
files (see @{"usage" link "USAGE" 0} for more information).

For example:

In your download dir you have the following files:

Download:

   A1200FDfix.lha 
   A1200FDfix.readme 
   DBackup232_MUI.lha 
   DBackup232_MUI.readme 
   Galaxy_2.lha 
   Galaxy_2.readme 
   Kick1000.lha 
   Kick1000.readme 
   PllbC2pV1.lha 
   PllbC2pV1.readme 


After running MoveToMirror you could have this as result:

Download:Aminet/    (this is root destination dir)

hard/
   hack/
     A1200FDfix.lha        : Make new A1200 compatible to old ones
     A1200FDfix.readme
     Kick1000.lha          : A1000 with 2.0 EPROM/ROM !
     Kick1000.readme

dev/
   asm/
     PllbC2pV1.lha         : Pllb-Chunky to Planar Sources PllbC2pV1.readme
     PllbC2pV1.readme

pix/
   anim/
     Galaxy_2.lha          : Red and Blue 3D Galaxy animation 2
     Galaxy_2.readme


As you can see the download directory will be much more organized this way
and you can have an exact copy of the Aminet.

Check out the many options with this program. If you want one that doesn't
exist drop @{"me" link "AUTHOR" 0} a note!

===========================================================================
@endnode

@node "REQINSTALL" "Requirements and installation"
@next "USAGE"
@prev "INTRO"
===========================================================================
                       REQUIREMENTS AND INSTALLATION
===========================================================================

Requires:     kickstart 2.0.


Installation:

Copy MoveToMirror to C: or any other place you want. You can rename the
file to MTM or something else if you want to of course.


===========================================================================
@endnode

@node "USAGE" "Usage"
@next "AUTHOR"
@prev "REQINSTALL"
===========================================================================
                                   USAGE
===========================================================================


In this chapter we will go through all the options. First a short overview:


 USAGE:  MTM <srcdir|pattern> <destdir> [options]

         -a = overwrite existing files
         -b = add short: as comment before move/copy
         -c = clone file attributes
         -d = delete original (move)
         -l = lowercase sub-dir names
         -n = don't use 'short:' as filecomment
         -p = use pattern matching
         -r = don't copy *.readme files
         -u = uppercase sub-dir names
         -v = verbose


NOTE1: You will need the readme file of an archive/file to use this
       program!

NOTE2: MTM is able to create one-level destination root dir. Example:
       If you have:  "Download:" and uses "Download:Aminet" as an argument
       to MTM in <destdir> MTM can create "Aminet". It is not able to
       create f.ex.: "Download:mirrors/Aminet" based on the example above.
       The sub-dirs creation uses another special routine so MTM will
       create those with no problem.


srcdir|pattern
--------------

Source  directory  is  where  you  have  all  the files you downloaded from
Aminet.  The files must have an accompaning readme file.  If you use the -p
option you should define a pattern instead.

Example:

  MoveToMirror download: Aminet:

or

  MoveToMirror download:MTM* Aminet: -p


destdir
-------

Destination  directory  is  the directory where you want to have the Aminet
dir  tree  built.  For example:  download:aminet/ this will be the root for
the  tree like for example:  download:aminet/hard/hack/ will be the dir for
files  belonging here based on the Type:  field in the readme file.  If the
type  field  doesn't  exist  MoveToMirror  can't  handle the file.  You can
manually  insert  the  type field or move the file yourself.  All  sub-dirs 
are created automatically by MTM so don't worry about them.


-a
--

When  this  option  is used MTM will not ask you if you want to overwrite a
file  if  the file already exists in the destination dir tree.


-b
--

This option allow you to add the Short: field as a comment to the original
file before it is moved or copied. The purpose is to get the filecomment
added in case there is no Type: field in the readme file and you have to
move it manually. The comment is added as long there is a valid readme file
present with the file independent on errors occuring afterwards.

Note: this option will override the -n option. It will neither use the
original filecomment for the readme file.


-c
--

When  this  option  is  used  MTM  will clone the date, protection bits and
filecomment  of  the  original  file  in your source directory.  NOTE:  the
original  file  comment  will  only  be  copied  if  the option -n is used.
Otherwise  the Short:  field of the readme file will be used as filecomment
and the orignal comment is copied to the readme file instead.


-d
--

When  this  option is used the original file(s) will be deleted if they are
succesfully  copied  to  destination dir tree.   NOTE:  if option -r (don't
copy readme files) is used the original readme files will not be deleted.


-l
--

With this option you can lowercase all the sub-dir names beeing made. This
helps you keeping a well oranized and goodlooking sub-dir tree on your
disk. Use the -u option to uppercase them instead.


-n
--

Use  this  option  if  you  don't want the Short:  field of the readme file
become  filecomment.   Use  the  -c  (clone)  option  to  copy the original
filecomment  of  the  file(s) in source directory.  If you don't use the -n
option  the  original  filecomment will be copied to the readme file (if -r
option isn't used) and the 'short:' becomes the mainfile's filecomment like
this:

With -c option:

Foo.lha    --- A nice foo archive                [from short field]
Foo.readme --- This is the original comment

With the -n and -c option:

Foo.lha    --- This is the original comment
Foo.readme ---


-p
--

This  option  will allow pattern matching of the files in source directory.
Normal usage when this option isn't used, is just the dirname of the source
dir.  When  -p is used you must supply an additional pattern to srcdir. For
example:  "MoveToMirror Download:*.jpg Download:Aminet/" will only copy the
files ending with *.jpg.  Using *.readme will have no effect.


-r
--

When  this  option  is  used  the readme files in the sourcedir will not be
copied  to  destination  dir three.  If option -d (delete original) is also
used the readme files will not be deleted from source dir.


-u
--

With this option you can uppercase all the sub-dir names beeing made. This
helps you keeping a well oranized and goodlooking sub-dir tree on your
disk. Use the -l option to lowercase them instead.


-v
--

When  this  option  is on you are in verbose mode.  That means you will get
output  on  every  important  action  in  the  console done by the program.
Useful  for "debugging" if you find files that doesn't copy correctly or if
you  will  send  a bug report to @{"author" link "AUTHOR" 0}.  All major errors will be reported
independent on this option.


===========================================================================
@endnode

@node "AUTHOR" "Author"
@next "Main"
@prev "USAGE"
===========================================================================
                                  AUTHOR
===========================================================================

MoveToMirror (MTM) is made by:

Kenneth "Kenny" Nilsen

Email: kenny@bgnett.no
  URL: http://www.bgnett.no/~kenny/


SPECIAL THANKS goes to Klaus Gessner and Herbert Breuer for putting a lots
alot of effort in locating the reason for the bug which caused failure only
on some systems -and they did! They are the only reason for the 2.3 update.

Also thanks to all you guys sending me nice letters with questions,
suggestions, wishes and bug reports. Without you this program wouldn't be
updated!

===========================================================================
@endnode
