
  *********************************************************************
                              FMirror  V1.8
                            By Chris De Maeyer
                             For AmigaDOS 68k
  *********************************************************************


  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 (only use email for bug reports)
          
          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 a mirror.

          You can run the program in CLI mode or GUI mode. CLI mode will perform
          better speedwise. 
          
          In GUI mode, the window will remain open until you click the close
          gadget. Unless you specify NOWAIT, then it closes when processing has
          finished.

          Includes the batch mode, it uses the same configuration file as "FBack".
          CLI mode can be interrupted, empty directories on the backup are removed.

          New features:

                - bugfixes                

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


     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 :ceppe@pandora.be 
                  Alternate:ceppe@geocities.com
                  Homepage :http://www.geocities.com/siliconvalley/peaks/8452
                            http://users.pandora.be/ceppe
                                 
                                 
     1.5. Development info
         ------------------
          Sources were written in C and compiled using SAS/C V6.58.

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


     1.6. Versions
         ----------
          The actual version can always be determined by typing 'version
          fmirror' in a CLI window.
          It is recommended to always upgrade to the latest version.
                    
          V0.9  - first test version.

          V1.0  FIRST RELEASE
                - first public release.
          
          V1.2b MINOR UPDATE 
                - changed some internal values
                - changed some messages
                - included program with "FBack" archive
                - bumped version number to 1.2b.
                 
          V1.2c MINOR UPDATE
                - fixed pattern matching.       

          V1.3  MAJOR UPDATE
                - cleanup the code
                - added GUI option
                - added NOWAIT option.

          V1.3a MINOR UPDATE
                - bumped version with code generation SAS/C 6.58.

          V1.4  MAJOR UPDATE
                - fixed traversing directories
                - HandleIDCMP() uses Wait() now
                - FROM, TO paths are checked now
                - added batch mode.

          V1.4b MINOR UPDATE
                - bumped version
                - enhanced for more files
                
          V1.4c MINOR UPDATE
                - bugfix file arrays
                - in CLI mode CTRL_C will abort
                - empty directories on backup are removed
                
          V1.5  MINOR UPDATE
                - reformat strings
                - language support
                - compiled 68020/60 version
                - bumped version in sync with FBack                            

          V1.6  MINOR UPDATE
                - changed config file tags
                - bumped to higher version (in sync with FBack)
                
          V1.7  MINOR UPDATE
                - fixed memory allocation for larger scans
                
          V1.8  MINOR UPDATE
                - changed output strings (USER)      
                      
                
  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.

             GUI/S        - run in GUI mode, giving up to date statistics & speed !

             NOWAIT/S     - when in GUI mode, specifying this switch will close the
                            window immediately after processing. Otherwise, the 
                            window remains open until you click the close gadget.
                            
             CFG=CONFIG/K - this option invokes the batch mode, thus reading a config
                            file for paths and options.  The paths used are the ones
                            found for FBack (and in the right sequence).
                            As you can see it is in fact the same config file as you
                            used in FBack.

                            Syntax:
                            
                            ----------------- cut ------------------------

                                    [FBack]
                                    NumberOfPaths = N

                                    [Paths]
                                    OrgPath1 = fback origine entry 1
                                    BckPath1 = fback backup entry 1
                                    ...
                                    OrgPathN = fback origine entry N
                                    BckPathN = fback backup entry N

                                    [Options]
                                    BOptions1 = fback options entry 1
                                    MOptions1 = fmirror options entry 1
                                    ...
                                    BOptionsN = fback options entry N
                                    MOptionsN = fmirror options entry N

                            ----------------- cut ------------------------


                             The program opens up in GUI or CLI mode depending
                             on the options in the 1st entry.

                             To start this mode use a commandline like:
                             
                                fmirror "" "" cfg=myback.cfg
                                
                                        or
                                        
                                fmirror "" "" config=myback.cfg
                                        

                             For an example see "MYBACK.CFG"
                             
                                
           The return code is either RETURN_OK (0) or RETURN_WARN (5) in all
           other cases.
           
           When running in CLI mode the program can be aborted by pressing CTRL_C.
           
           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.
           
           REMARK  ! BATCH MODE AUTOMATICALLY SWITCHES THIS FOR YOU, SO THERE IS
                NO NEED TO ADD EXTRA PATH SPECIFICATIONS OR TO TURN THEM AROUND.
                     
           =====================================================================          


     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 GUI
               FMirror work:backup/prefs/ to sys:prefs/env-archive/ ALL GUI
               ...

          - 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).
          
          
     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
         ------------

          - ???

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