*********************************************************************
                              FMirror  V1.2b
                            By Chris De Maeyer
                               For AmigaDOS
  *********************************************************************


  0. Contents
    ----------

     1. Introduction
        1.1. Legal
        1.2. What it does...
        1.3. Requirements
        1.4. Contact address
        1.5. Development info
        1.6. Versions

     2. Using it
        2.1. Command line options
        2.2. Examples

     3. Appendix
        3.1. Common problems
        3.2. Error messages
        3.3. The future


  1. Introduction
    --------------

     1.1. Legal
         -------
          Type  : - MAILWARE
          Terms : - no modifications to any file in this archive
                  - add no additional files to this archive
                  - use this program >30 days, then you should
                    reward the author with a postcard/letter, hence the term
                    mailware
                  - author can not be held responsible for data loss, the program
                    has been tested and the behaviour has been described below.


     1.2. What it does
         --------------
          'FMirror' is a file deletion tool. It will check the files in its source
          path with the destination path and delete the files in source path not
          found in destination path. Comprendo !?!
          
          Example: when running 'FBack' create an exact mirror.

     1.3. Requirements
         --------------
          Nothing special is needed (except from a properly installed Amiga).


     1.4. Contact address
         -----------------
          For information/problems/gifts/bugs etc. write to the address
          below, state version & add postage for reply:

                                 Visionary Software
                                 tav. Chris De Maeyer

                                 Norbertijnenstraat 4
                                 B-2040       BELGIUM
                                 EUROPE

                                 Internet: cdemaeyer1@mmm.com
                                 
                                 
     1.5. Development info
         ------------------
          Sources were written in C and compiled using SAS/C V6.57.

          All file I/O has been coded using standard system library
          functions (V37+).


     1.6. Versions
         ----------
          V0.9   - first test version.

          V1.0   - first public release.
          
          V1.2b  - changed some internal values
                 - changed some messages
                 - included program with "FBack" archive
                 - bumped version number to 1.2b.
                 
  2. Using it
    ----------
     2.1. Command line options
         ----------------------
          The program uses standard AmigaDOS command templates, so
          typing 'FMirror ?' will list all the options available.

           Detail explanation of options:

             FROM/A       - the source path, a AmigaDOS file pattern may be
                            given.
                            
                                fe.   BACKUP:
                                      BACKUP:Prefs/
                                      BACKUP:S/#?.keyfile
                                      
                            As you can see, a volume needs no '/'. However, a 
                            directory always needs a '/'.
                            If a volume/directory is chosen, only that part will
                            be checked, to include all subdirectories include the
                            'ALL' switch.
                            
                                fe.   FMirror BACKUP: TO SYS: ALL
                                      FMirror BACKUP:data/ TO Work:data/ ALL
                                               
             TO/A         - the destination path.
             
                                fe.  BOOT:
                                     Work:Data/Pictures/
                                     
                            Same rules as above, a volume needs no '/'. A directory
                            always needs an ending '/'. 
                                     
             NODELETE/S   - this does exactly what it says, when a file is not
                            found it is normally deleted from the source path.
                            Adding this parameter prevents this and the program will
                            merely report the file.

             ALL/S        - include subdirectories.
             
             QUIET/S      - no output messages.



           The return code is either RETURN_OK (0) or RETURN_WARN (5) in all
           other cases.
           For some examples look at next section "2.2. Examples".


           =====================================================================
           
           WARNING ! THE SOURCE PATH (FROM) IS THE LOCATION OF THE BACKUP FILES,
                     THE DESTINATION (TO) IS THE LOCATION OF THE ORIGINAL FILES.
           
           =====================================================================          


     2.2. Examples
         ----------
          This section lists some examples of usage.

          - Backup changed prefs files + maintain exact mirror:

               ; Startup-sequence
               ...
               FBack sys:prefs/env-archive/ to work:backup/prefs/ ALL QUIET
               FMirror work:backup/prefs/ to sys:prefs/env-archive/ ALL QUIET
               ...

          - Check consistency of backup:
          
              1>Fmirror backup:workbench/ sys: all nodelete
              

  3. Appendix
    ----------
     3.1. Common problems
         -----------------
          Q: It doesn't find its source/destination files ?
          
          A: Enter the correct path: see section 2.1 (FROM,TO option).
          
          ---
          
          Q: I get a stack error ?
          
          A: Report this to me right away + add documentation in which
              situation it occurred.
              
          
     3.2. Error messages
         ----------------

          'Source/Destination not found'

             The entered path could not be located. Correct your paths !

          'File not found'

             The file you typed could not be found.

          AmigaDOS errors are in format :

             'FBack: nnn - message'


     3.3. The future
         ------------

          - add statistics GUI

          Any suggestions from you are welcome !
          
  *********************************************************************