home *** CD-ROM | disk | FTP | other *** search
/ Amiga ACS 1998 #2 / amigaacscoverdisc1998-021998.iso / utilities / shareware / diskutils / backup / fbackv14 / doc / fmirr14.doc < prev   
Text File  |  1997-09-07  |  11KB  |  290 lines
  1.  
  2.   *********************************************************************
  3.                               FMirror  V1.4
  4.                             By Chris De Maeyer
  5.                              For AmigaDOS 68k
  6.   *********************************************************************
  7.  
  8.  
  9.   0. Contents
  10.     ----------
  11.  
  12.      1. Introduction
  13.         1.1. Legal
  14.         1.2. What it does...
  15.         1.3. Requirements
  16.         1.4. Contact address
  17.         1.5. Development info
  18.         1.6. Versions
  19.  
  20.      2. Using it
  21.         2.1. Command line options
  22.         2.2. Examples
  23.  
  24.      3. Appendix
  25.         3.1. Common problems
  26.         3.2. Error messages
  27.         3.3. The future
  28.  
  29.  
  30.   1. Introduction
  31.     --------------
  32.  
  33.      1.1. Legal
  34.          -------
  35.           Type  : - (E)MAILWARE
  36.           Terms : - no modifications to any file in this archive
  37.                   - add no additional files to this archive
  38.                   - use this program >30 days, then you should
  39.                     reward the author with a postcard/letter, hence the term
  40.                     mailware
  41.                   - author can not be held responsible for data loss, the program
  42.                     has been tested and the behaviour has been described below.
  43.  
  44.  
  45.      1.2. What it does
  46.          --------------
  47.           'FMirror' is a file deletion tool. It will check the files in its source
  48.           path with the destination path and delete the files in source path not
  49.           found in destination path. Comprendo !?!
  50.           
  51.           Example: when running 'FBack' create a mirror.
  52.  
  53.           You can run the program in CLI mode or GUI mode. CLI mode will perform
  54.           better speedwise. 
  55.           
  56.           In GUI mode, the window will remain open until you click the close
  57.           gadget. Unless you specify NOWAIT, then it closes when processing has
  58.           finished.
  59.  
  60.             ******************** NEW FEATURES ************************
  61.  
  62.           This version includes the batch mode, it uses the same configuration
  63.           file as "FBack".
  64.  
  65.             **********************************************************
  66.  
  67.  
  68.      1.3. Requirements
  69.          --------------
  70.           Nothing special is needed (except from a properly installed Amiga V38+).
  71.  
  72.  
  73.      1.4. Contact address
  74.          -----------------
  75.           For information/problems/gifts/bugs etc. write to the address
  76.           below, state version & add postage for reply:
  77.  
  78.                                  Visionary Software
  79.                                  tav. Chris De Maeyer
  80.  
  81.                                  Norbertijnenstraat 4
  82.                                  B-2040       BELGIUM
  83.                                  EUROPE
  84.  
  85.                                  Internet: cdemaeyer1@mmm.com
  86.                                  
  87.                                  
  88.      1.5. Development info
  89.          ------------------
  90.           Sources were written in C and compiled using SAS/C V6.58.
  91.  
  92.           All file I/O has been coded using standard system library
  93.           functions (V38+).
  94.  
  95.  
  96.      1.6. Versions
  97.          ----------
  98.           The actual version can always be determined by typing 'version
  99.           fmirror' in a CLI window.
  100.           It is recommended to always upgrade to the latest version.
  101.                     
  102.           V0.9   - first test version.
  103.  
  104.           V1.0  FIRST RELEASE
  105.                 - first public release.
  106.           
  107.           V1.2b MINOR UPDATE 
  108.                 - changed some internal values
  109.                 - changed some messages
  110.                 - included program with "FBack" archive
  111.                 - bumped version number to 1.2b.
  112.                  
  113.           V1.2c MINOR UPDATE
  114.                 - fixed pattern matching.       
  115.  
  116.           V1.3  MAJOR UPDATE
  117.                 - cleanup the code
  118.                 - added GUI option
  119.                 - added NOWAIT option.
  120.  
  121.           V1.3a MINOR UPDATE
  122.                 - bumped version with code generation SAS/C 6.58.
  123.  
  124.           V1.4  MAJOR UPDATE
  125.                 - fixed traversing directories
  126.                 - HandleIDCMP() uses Wait() now
  127.                 - FROM, TO paths are checked now
  128.                 - added batch mode.
  129.  
  130.  
  131.   2. Using it
  132.     ----------
  133.      2.1. Command line options
  134.          ----------------------
  135.           The program uses standard AmigaDOS command templates, so
  136.           typing 'FMirror ?' will list all the options available.
  137.  
  138.            Detail explanation of options:
  139.  
  140.              FROM/A       - the source path, a AmigaDOS file pattern may be
  141.                             given.
  142.                             
  143.                                 fe.   BACKUP:
  144.                                       BACKUP:Prefs/
  145.                                       BACKUP:S/#?.keyfile
  146.                                       
  147.                             As you can see, a volume needs no '/'. However, a 
  148.                             directory always needs a '/'.
  149.                             If a volume/directory is chosen, only that part will
  150.                             be checked, to include all subdirectories include the
  151.                             'ALL' switch.
  152.                             
  153.                                 fe.   FMirror BACKUP: TO SYS: ALL
  154.                                       FMirror BACKUP:data/ TO Work:data/ ALL
  155.                                                
  156.              TO/A         - the destination path.
  157.              
  158.                                 fe.  BOOT:
  159.                                      Work:Data/Pictures/
  160.                                      
  161.                             Same rules as above, a volume needs no '/'. A directory
  162.                             always needs an ending '/'. 
  163.                                      
  164.              NODELETE/S   - this does exactly what it says, when a file is not
  165.                             found it is normally deleted from the source path.
  166.                             Adding this parameter prevents this and the program will
  167.                             merely report the file.
  168.  
  169.              ALL/S        - include subdirectories.
  170.              
  171.              QUIET/S      - no output messages.
  172.  
  173.              GUI/S        - run in GUI mode, giving up to date statistics & speed !
  174.  
  175.              NOWAIT/S     - when in GUI mode, specifying this switch will close the
  176.                             window immediately after processing. Otherwise, the 
  177.                             window remains open until you click the close gadget.
  178.                             
  179.    *NEW*     CFG=CONFIG/K - this option invokes the batch mode, thus reading a config
  180.                             file for paths and options.  The paths used are the ones
  181.                             found for FBack (and in the right sequence).
  182.                             As you can see it is in fact the same config file as you
  183.                             used in FBack.
  184.  
  185.                             Syntax:
  186.                             
  187.                             ----------------- cut ------------------------
  188.  
  189.                                     [FBack]
  190.                                     NumberOfPaths = N
  191.  
  192.                                     [Paths]
  193.                                     SrcPath1 = fback source entry 1
  194.                                     DstPath1 = fback destination entry 1
  195.                                     ...
  196.                                     SrcPathN = fback source entry N
  197.                                     DstPathN = fback destination entry N
  198.  
  199.                                     [Options]
  200.                                     BOptions1 = fback options entry 1
  201.                                     MOptions1 = fmirror options entry 1
  202.                                     ...
  203.                                     BOptionsN = fback options entry N
  204.                                     MOptionsN = fmirror options entry N
  205.  
  206.                             ----------------- cut ------------------------
  207.  
  208.  
  209.                              The program opens up in GUI or CLI mode depending
  210.                              on the options in the 1st entry.
  211.  
  212.                              To start this mode use a commandline like:
  213.                              
  214.                                 fmirror "" "" cfg=myback.cfg
  215.                                 
  216.                                         or
  217.                                         
  218.                                 fmirror "" "" config=myback.cfg
  219.                                         
  220.  
  221.                              For an example see "MYBACK.CFG"
  222.                              
  223.                                 
  224.            The return code is either RETURN_OK (0) or RETURN_WARN (5) in all
  225.            other cases.
  226.            For some examples look at next section "2.2. Examples".
  227.  
  228.  
  229.            =====================================================================
  230.            
  231.            WARNING ! THE SOURCE PATH (FROM) IS THE LOCATION OF THE BACKUP FILES,
  232.                      THE DESTINATION (TO) IS THE LOCATION OF THE ORIGINAL FILES.
  233.            
  234.            REMARK  ! BATCH MODE AUTOMATICALLY SWITCHES THIS FOR YOU, SO THERE IS
  235.                      NO NEED TO ADD EXTRA PATH SPECIFICATIONS.
  236.                      
  237.            =====================================================================          
  238.  
  239.  
  240.      2.2. Examples
  241.          ----------
  242.           This section lists some examples of usage.
  243.  
  244.           - Backup changed prefs files + maintain exact mirror:
  245.  
  246.                ; Startup-sequence
  247.                ...
  248.                FBack sys:prefs/env-archive/ to work:backup/prefs/ ALL GUI
  249.                FMirror work:backup/prefs/ to sys:prefs/env-archive/ ALL GUI
  250.                ...
  251.  
  252.           - Check consistency of backup:
  253.           
  254.               1>Fmirror backup:workbench/ sys: all nodelete
  255.               
  256.  
  257.   3. Appendix
  258.     ----------
  259.      3.1. Common problems
  260.          -----------------
  261.           Q: It doesn't find its source/destination files ?
  262.           
  263.           A: Enter the correct path: see section 2.1 (FROM,TO option).
  264.           
  265.           
  266.      3.2. Error messages
  267.          ----------------
  268.  
  269.           'Source/Destination not found'
  270.  
  271.              The entered path could not be located. Correct your paths !
  272.  
  273.           'File not found'
  274.  
  275.              The file you typed could not be found.
  276.  
  277.           AmigaDOS errors are in format :
  278.  
  279.              'FBack: nnn - message'
  280.  
  281.  
  282.      3.3. The future
  283.          ------------
  284.  
  285.           - ???
  286.  
  287.           Any suggestions from you are welcome !
  288.           
  289.   *********************************************************************
  290.