home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / sonstiges / tools / fback-dist / doc / fmirr15.doc < prev   
Encoding:
Text File  |  1998-10-06  |  11.1 KB  |  311 lines
  1.  
  2.   *********************************************************************
  3.                               FMirror  V1.5
  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  : - MAILWARE (only use email for bug reports)
  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.           Includes the batch mode, it uses the same configuration file as "FBack".
  61.           CLI mode can be interrupted, empty directories on the backup are removed.
  62.  
  63.           New features:
  64.  
  65.                 - reformat strings          
  66.                 - language support
  67.                 - versions for 68020/60                
  68.  
  69.      1.3. Requirements
  70.          --------------
  71.           Nothing special is needed (except from a properly installed Amiga V38+).
  72.  
  73.  
  74.      1.4. Contact address
  75.          -----------------
  76.           For information/problems/gifts/bugs etc. write to the address
  77.           below, state version & add postage for reply:
  78.  
  79.                   Visionary Software
  80.                   tav. Chris De Maeyer
  81.  
  82.                   Norbertijnenstraat 4
  83.                   B-2040       BELGIUM
  84.                   EUROPE
  85.  
  86.                   Internet :cdemaeyer1@mmm.com
  87.                   Alternate:ceppe@geocities.com
  88.                   Homepage :http://www.geocities.com/siliconvalley/peaks/8452
  89.                             http://www.crosswinds.com/antwerp/~visionary 
  90.                                  
  91.                                  
  92.      1.5. Development info
  93.          ------------------
  94.           Sources were written in C and compiled using SAS/C V6.58.
  95.  
  96.           All file I/O has been coded using standard system library
  97.           functions (V38+).
  98.  
  99.  
  100.      1.6. Versions
  101.          ----------
  102.           The actual version can always be determined by typing 'version
  103.           fmirror' in a CLI window.
  104.           It is recommended to always upgrade to the latest version.
  105.                     
  106.           V0.9  - first test version.
  107.  
  108.           V1.0  FIRST RELEASE
  109.                 - first public release.
  110.           
  111.           V1.2b MINOR UPDATE 
  112.                 - changed some internal values
  113.                 - changed some messages
  114.                 - included program with "FBack" archive
  115.                 - bumped version number to 1.2b.
  116.                  
  117.           V1.2c MINOR UPDATE
  118.                 - fixed pattern matching.       
  119.  
  120.           V1.3  MAJOR UPDATE
  121.                 - cleanup the code
  122.                 - added GUI option
  123.                 - added NOWAIT option.
  124.  
  125.           V1.3a MINOR UPDATE
  126.                 - bumped version with code generation SAS/C 6.58.
  127.  
  128.           V1.4  MAJOR UPDATE
  129.                 - fixed traversing directories
  130.                 - HandleIDCMP() uses Wait() now
  131.                 - FROM, TO paths are checked now
  132.                 - added batch mode.
  133.  
  134.           V1.4b MINOR UPDATE
  135.                 - bumped version
  136.                 - enhanced for more files
  137.                 
  138.           V1.4c MINOR UPDATE
  139.                 - bugfix file arrays
  140.                 - in CLI mode CTRL_C will abort
  141.                 - empty directories on backup are removed
  142.                 
  143.           V1.5  MINOR UPDATE
  144.                 - reformat strings
  145.                 - language support
  146.                 - compiled 68020/60 version
  147.                 - bumped version in sync with FBack                            
  148.  
  149.   2. Using it
  150.     ----------
  151.      2.1. Command line options
  152.          ----------------------
  153.           The program uses standard AmigaDOS command templates, so
  154.           typing 'FMirror ?' will list all the options available.
  155.  
  156.            Detail explanation of options:
  157.  
  158.              FROM/A       - the source path, a AmigaDOS file pattern may be
  159.                             given.
  160.                             
  161.                                 fe.   BACKUP:
  162.                                       BACKUP:Prefs/
  163.                                       BACKUP:S/#?.keyfile
  164.                                       
  165.                             As you can see, a volume needs no '/'. However, a 
  166.                             directory always needs a '/'.
  167.                             If a volume/directory is chosen, only that part will
  168.                             be checked, to include all subdirectories include the
  169.                             'ALL' switch.
  170.                             
  171.                                 fe.   FMirror BACKUP: TO SYS: ALL
  172.                                       FMirror BACKUP:data/ TO Work:data/ ALL
  173.                                                
  174.              TO/A         - the destination path.
  175.              
  176.                                 fe.  BOOT:
  177.                                      Work:Data/Pictures/
  178.                                      
  179.                             Same rules as above, a volume needs no '/'. A directory
  180.                             always needs an ending '/'. 
  181.                                      
  182.              NODELETE/S   - this does exactly what it says, when a file is not
  183.                             found it is normally deleted from the source path.
  184.                             Adding this parameter prevents this and the program will
  185.                             merely report the file.
  186.  
  187.              ALL/S        - include subdirectories.
  188.              
  189.              QUIET/S      - no output messages.
  190.  
  191.              GUI/S        - run in GUI mode, giving up to date statistics & speed !
  192.  
  193.              NOWAIT/S     - when in GUI mode, specifying this switch will close the
  194.                             window immediately after processing. Otherwise, the 
  195.                             window remains open until you click the close gadget.
  196.                             
  197.              CFG=CONFIG/K - this option invokes the batch mode, thus reading a config
  198.                             file for paths and options.  The paths used are the ones
  199.                             found for FBack (and in the right sequence).
  200.                             As you can see it is in fact the same config file as you
  201.                             used in FBack.
  202.  
  203.                             Syntax:
  204.                             
  205.                             ----------------- cut ------------------------
  206.  
  207.                                     [FBack]
  208.                                     NumberOfPaths = N
  209.  
  210.                                     [Paths]
  211.                                     SrcPath1 = fback source entry 1
  212.                                     DstPath1 = fback destination entry 1
  213.                                     ...
  214.                                     SrcPathN = fback source entry N
  215.                                     DstPathN = fback destination entry N
  216.  
  217.                                     [Options]
  218.                                     BOptions1 = fback options entry 1
  219.                                     MOptions1 = fmirror options entry 1
  220.                                     ...
  221.                                     BOptionsN = fback options entry N
  222.                                     MOptionsN = fmirror options entry N
  223.  
  224.                             ----------------- cut ------------------------
  225.  
  226.  
  227.                              The program opens up in GUI or CLI mode depending
  228.                              on the options in the 1st entry.
  229.  
  230.                              To start this mode use a commandline like:
  231.                              
  232.                                 fmirror "" "" cfg=myback.cfg
  233.                                 
  234.                                         or
  235.                                         
  236.                                 fmirror "" "" config=myback.cfg
  237.                                         
  238.  
  239.                              For an example see "MYBACK.CFG"
  240.                              
  241.                                 
  242.            The return code is either RETURN_OK (0) or RETURN_WARN (5) in all
  243.            other cases.
  244.            
  245.            When running in CLI mode the program can be aborted by pressing CTRL_C.
  246.            
  247.            For some examples look at next section "2.2. Examples".
  248.  
  249.  
  250.            =====================================================================
  251.            
  252.            WARNING ! THE SOURCE PATH (FROM) IS THE LOCATION OF THE BACKUP FILES,
  253.                      THE DESTINATION (TO) IS THE LOCATION OF THE ORIGINAL FILES.
  254.            
  255.            REMARK  ! BATCH MODE AUTOMATICALLY SWITCHES THIS FOR YOU, SO THERE IS
  256.                      NO NEED TO ADD EXTRA PATH SPECIFICATIONS.
  257.                      
  258.            =====================================================================          
  259.  
  260.  
  261.      2.2. Examples
  262.          ----------
  263.           This section lists some examples of usage.
  264.  
  265.           - Backup changed prefs files + maintain exact mirror:
  266.  
  267.                ; Startup-sequence
  268.                ...
  269.                FBack sys:prefs/env-archive/ to work:backup/prefs/ ALL GUI
  270.                FMirror work:backup/prefs/ to sys:prefs/env-archive/ ALL GUI
  271.                ...
  272.  
  273.           - Check consistency of backup:
  274.           
  275.               1>Fmirror backup:workbench/ sys: all nodelete
  276.               
  277.  
  278.   3. Appendix
  279.     ----------
  280.      3.1. Common problems
  281.          -----------------
  282.           Q: It doesn't find its source/destination files ?
  283.           
  284.           A: Enter the correct path: see section 2.1 (FROM,TO option).
  285.           
  286.           
  287.      3.2. Error messages
  288.          ----------------
  289.  
  290.           'Source/Destination not found'
  291.  
  292.              The entered path could not be located. Correct your paths !
  293.  
  294.           'File not found'
  295.  
  296.              The file you typed could not be found.
  297.  
  298.           AmigaDOS errors are in format :
  299.  
  300.              'FBack: nnn - message'
  301.  
  302.  
  303.      3.3. The future
  304.          ------------
  305.  
  306.           - ???
  307.  
  308.           Any suggestions from you are welcome !
  309.           
  310.   *********************************************************************
  311.