home *** CD-ROM | disk | FTP | other *** search
/ Amiga ACS 1998 #2 / amigaacscoverdisc1998-021998.iso / utilities / shareware / diskutils / backup / fbackv14 / doc / fback14.doc next >
Text File  |  1997-09-07  |  19KB  |  445 lines
  1.  
  2.   *********************************************************************
  3.                                FBack  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.         3.4. About me
  29.  
  30.  
  31.   1. Introduction
  32.     --------------
  33.  
  34.      If you have used this program before try to make the effort to read this doc
  35.      again. Some useful info is updated, not listed in previous versions.
  36.      
  37.      1.1. Legal
  38.          -------
  39.           Type  : - (E)MAILWARE
  40.  
  41.           Terms : - no modifications to any file in this archive
  42.                   - add no additional files to this archive
  43.                   - use this program longer than 30 days, then you should
  44.                     reward the author with a postcard/letter/email, hence the term
  45.                     mailware
  46.                   - author can not be held responsible for data loss, the program
  47.                     has been tested and the behaviour has been described below
  48.                   - any commercial distribution is prohibited (except on Aminet).
  49.  
  50.  
  51.      1.2. What it does
  52.          --------------
  53.           'FBack' is a file copy tool. It will check the archive bit of files
  54.           and copy them if the archive bit is not set. After copying it will
  55.           add the archive bit. It can be used to perform a 'Daily' backup of
  56.           changed files.
  57.           
  58.           As an option you can run the program in GUI mode, this will open up
  59.           a window which keeps up with the process. For now, when processing is
  60.           finished the window will remain open until you close it with the close
  61.           gadget. Unless you specify NOWAIT, then the window is closed immediately
  62.           after processing. In this mode the 'Current' gadget displays the files it
  63.           is scanning. In CLI mode it merely reports the directories it is scanning
  64.           (let me know if you want files here too [as an option]).
  65.           
  66.           On request of some users a CLONE option has been added, meaning the
  67.           date/time is preserved on the backup.
  68.           
  69.           The filenotes are copied by default, specifying the NOCOMMENT option
  70.           will suppress this.
  71.            
  72.            
  73.             ************************* NEW FEATURES ***************************
  74.            
  75.           This version includes a batch mode, paths and options are then specified
  76.           with a configuration file.
  77.           
  78.           Further, the filenotes on directories are copied.
  79.           
  80.           Also, in this update. Some extra statistics, the estimated processor time
  81.           (for now only in second(s)).
  82.            
  83.             ******************************************************************          
  84.           
  85.           'FMirror' is included now. Its purpose is to delete files which no longer
  86.           exist in the original directory, thus creating a mirror.
  87.           
  88.           There has been a remark concerning the mirror concept in combination
  89.           with the pack mode, if you take it word for word, issuing PACK is no
  90.           EXACT mirror (jeezes!). Mirroring is portrayed in this implementation as
  91.           following concept: you have a copy (normal or packed) on the backup volume
  92.           of what is on your source path (Comprendo!).
  93.  
  94.  
  95.      1.3. Requirements
  96.          --------------
  97.           Properly installed Amiga ROM 2.04+.
  98.           Needs XPK library when using this option.
  99.           GUI window uses standard GADTOOLS library.
  100.           Needs Argue (V1.3a) to use FBackGUI, FMirrorGUI.
  101.  
  102.  
  103.      1.4. Contact address
  104.          -----------------
  105.           For mail/information/problems/gifts/bugs etc. write to the address
  106.           below, state version & add postage for reply:
  107.  
  108.                                  Visionary Software
  109.                                  tav. Chris De Maeyer
  110.  
  111.                                  Norbertijnenstraat 4
  112.                                  B-2040       BELGIUM
  113.                                  EUROPE
  114.  
  115.                                  Internet:   cdemaeyer1@mmm.com   
  116.  
  117.  
  118.      1.5. Development info
  119.          ------------------
  120.           Sources were written in C and compiled using SAS/C V6.58.
  121.  
  122.           All file I/O has been coded using standard system library
  123.           functions (V38+).
  124.  
  125.  
  126.      1.6. Versions
  127.          ----------
  128.         
  129.           The actual version can be determined by typing 'version fback' in a
  130.           CLI window.
  131.           It is recommended to always upgrade to the latest version.
  132.  
  133.           V0.9  TEST RELEASE 
  134.                 - first internal test version.
  135.  
  136.           V1.0  FIRST PUBLIC RELEASE 
  137.                 - cleaned up code
  138.                 - adapt stack size + compile with stackextend, optimize
  139.                 - first public release.
  140.                  
  141.           V1.1  MAJOR UPDATE 
  142.                 - added file report after processing
  143.                 - shortened output strings + reformat
  144.                 - changed ExamineDir() flow, performs better with patterns
  145.                 - message to indicate NOCOPY mode
  146.                 - fixed error in document (FROM/A & TO/A examples).
  147.  
  148.           V1.1a MINOR UPDATE 
  149.                 - changed some buffer sizes for speed, copybuffer = 16Kb.
  150.           
  151.           V1.2  MAJOR UPDATE
  152.                 - added packing mode
  153.                 - added XPK packer/unpacker
  154.                 - added date in version string.
  155.           
  156.           V1.2a MINOR UPDATE
  157.                 - updated some internal values
  158.                 - added Argue GUI
  159.                 - added BUF option.        
  160.                 
  161.           V1.2b MINOR UPDATE
  162.                 - added FORCE option
  163.                 - changed some displayed strings.
  164.                 
  165.           V1.2c MINOR UPDATE
  166.                 - replaced SAS pattern match function with 'dos.library'
  167.                   function MatchPatternNoCase()
  168.                 - fixed pattern matching.
  169.                                       
  170.           V1.3  MAJOR UPDATE
  171.                 - archive bits are also set on destination (Oops!)
  172.                 - added GUI window option 
  173.                 - added NOWAIT option
  174.                 - added CLONE option, to keep date on destination.
  175.  
  176.           V1.3a MINOR UPDATE
  177.                 - filenotes of files are copied now
  178.                 - added NOCOMMENT option
  179.                 - code generation with SAS/C 6.58.
  180.                 
  181.           V1.4  MAJOR UPDATE
  182.                 - fixed traversing the directory tree
  183.                 - HandleIDCMP() uses Wait() now
  184.                 - added estimated processor time (and total time) report
  185.                 - changed output attributes of some strings
  186.                 - FROM, TO paths are checked now
  187.                 - filenotes of directories are copied now
  188.                 - added configuration file mode (batch).
  189.                 
  190.  
  191.   2. Using it
  192.     ----------
  193.      2.1. Command line options
  194.          ----------------------
  195.           The program uses standard AmigaDOS command templates, so
  196.           typing 'FBack ?' will list all the options available.
  197.  
  198.            Detail explanation of options:
  199.  
  200.              FROM/A       - the source path, a AmigaDOS file pattern may be
  201.                             given.
  202.                             
  203.                                 fe.   BOOT:
  204.                                       BOOT:Prefs/
  205.                                       BOOT:S/#?.keyfile
  206.                                       
  207.                             As you can see, a volume needs no '/'. However, a 
  208.                             directory always needs a '/'.
  209.                             If a volume\directory is chosen, only that part will
  210.                             be checked, to include all subdirectories include the
  211.                             'ALL' switch.
  212.                             
  213.                                 fe.   FBack BOOT: TO BACKUP: ALL
  214.                                       FBack WORK:data/ TO BACKUP:Sys/ PACK=HUFF ALL
  215.                                       Fback WORK:data/calc/#?.wk1 TO BACKUP:Wks/ ALL
  216.                                                
  217.              TO/A         - the destination path.
  218.              
  219.                                 fe.  BACKUP:
  220.                                      SQ0:Backup/Workbench/
  221.                                      
  222.                             Same rules as above, a volume needs no '/'. A directory
  223.                             always needs an ending '/'. 
  224.                             As you might expect, the 'ALL' switch will create any
  225.                             missing subdirectories in the destination path.
  226.                                      
  227.              NOCOPY/S     - this does exactly what it says, when a file has
  228.                             been modified it is normally copied to the backup
  229.                             location. Adding this parameter prevents this and the
  230.                             program will merely report the file. Call it a SIMULATE
  231.                             mode.
  232.  
  233.              ALL/S        - include subdirectories.
  234.              
  235.              QUIET/S      - no output messages.
  236.  
  237.              PACK=/K      - enables packer mode, supply preferred packer. In this
  238.                             mode make sure your recovery disk includes the XPK library
  239.                             + some XPK unpacker (fe. xpk [included]) to restore files.
  240.                             
  241.                                 fe. PACK=nuke
  242.                                 
  243.              BUF=/K/N     - choose the buffer size used for copying, default is 16 Kb.
  244.                             Size limited only by your available RAM (but do not try to
  245.                             use TOO big sizes, 16 Kb will do fine for most users).
  246.                             The buffer size is specified in bytes.
  247.                             
  248.              FORCE/S      - specifying this option will ignore the archive bit, thus
  249.                             copying every file (= full backup).
  250.         
  251.              GUI/S        - opens GUI showing some statistics, no more CLI output.
  252.     
  253.              NOWAIT/S     - when using GUI mode, closes the window immediately after
  254.                             processing finishes, otherwise window remains open until you
  255.                             click the close gadget.
  256.                             
  257.              CLONE/S      - clones file date/time to destination.
  258.  
  259.              NOCOMMENT/S  - specifying this option will instruct FBack NOT to copy
  260.                             the filenotes.
  261.  
  262.      *NEW*   CONFIG=/K    - run in batch mode, this parameter contains the filename
  263.                             of the configuration file to process. 
  264.                             
  265.                             Syntax configuration file (text file):
  266.                             
  267.                             ----------------- cut ----------------------
  268.                                 [FBack]
  269.                                 NumberOfPaths = <N>
  270.                                 
  271.                                 [Paths]
  272.                                 SrcPath1 = <source path 1>
  273.                                 DstPath1 = <destination path 1>
  274.                                 ...
  275.                                 SrcPathN = <source path N>
  276.                                 DstPathN = <destination path N>
  277.                                 
  278.                                 [Options]
  279.                                 BOptions1 = <fback options for entry 1>
  280.                                 MOptions1 = <fmirror options for entry 1>
  281.                                 ...
  282.                                 BOptionsN = <fback options for entry N>
  283.                                 MOptionsN = <fmirror options for entry N>
  284.                             ----------------- cut ----------------------
  285.                                  
  286.                             Example: study "MYBACK.CFG" included in the archive.
  287.                                 
  288.                             To start batch mode use a command line like:
  289.                             
  290.                                 fback "" "" cfg=myback.cfg
  291.                                 
  292.                                             or
  293.                                 
  294.                                 fback "" "" config=whatever
  295.                                     
  296.                                     
  297.                             All options are available in batch mode, except for
  298.                             FROM, TO and BUF.
  299.                             Also, batch mode is NOT included in the Argue GUI.
  300.                                          
  301.                             NOTE: To detect in which mode (CLI or GUI) FBack
  302.                                   will run the first option entry is taken.
  303.                                   
  304.                                   Thus, specifying GUI in the 1st option entry
  305.                                   will trigger GUI mode for all subsequent batch
  306.                                   entries.
  307.                                   Leaving GUI out of the 1st option entry will 
  308.                                   run all subsequent entries in CLI mode.    
  309.  
  310.                                   NOWAIT is also only interpreted in the 1st
  311.                                   option entry.
  312.                                   
  313.                                   When running batch mode with GUI, the current
  314.                                   gadget will display the batch entry it is going
  315.                                   to process for a couple of seconds. After the
  316.                                   batch entry is done the "Estimated processor
  317.                                   time" is displayed. When all batch entries are
  318.                                   finished the "Total processor time" will be
  319.                                   shown.
  320.                                   
  321.                                   HINT: to test whether the config file is
  322.                                         readable by FBack use the supplied
  323.                                         "listcfg" tool (see "listcfg.doc").
  324.                                                                         
  325.                                   
  326.            The return code is either RETURN_OK (0) or RETURN_WARN (5) in all
  327.            other cases.
  328.            For some examples look at next section "2.2. Examples".
  329.  
  330.            Or, if you have Argue V1.3a you can use the GUI (FBackGUI) version.
  331.  
  332.  
  333.      2.2. Examples
  334.          ----------
  335.           This section lists some examples of usage.
  336.  
  337.           - Backup changed prefs files:
  338.  
  339.                ; Startup-sequence
  340.                ...
  341.                FBack sys:prefs/env-archive/ to work:backup/prefs/ ALL FORCE QUIET
  342.                FMirror work:backup/prefs/ to sys:prefs/env-archive/ ALL QUIET
  343.                ...
  344.  
  345.           - Mirror a disk at startup & create logfile:
  346.  
  347.                ; Startup-sequence
  348.                ...
  349.                FBack sys: to mirror:boot/ ALL >T:FBack.log
  350.                FMirror mirror:boot/ to sys: ALL >T:FMirror.log
  351.                ...
  352.                
  353.  
  354.           - Mirror files before shutdown:
  355.           
  356.                .key FLAG
  357.                .bra {
  358.                .ket }
  359.                ; Shutdown script
  360.                echo "Just a moment, valuable files are checked..."
  361.                ;
  362.                if {FLAG} EQ "GFX"
  363.                     FBack work:data/gfx/ to backup:data/gfx/ ALL GUI NOWAIT
  364.                     echo "Gfx data has been saved."
  365.                endif
  366.                if {FLAG} EQ "ALL"
  367.                     FBack work:data/ to mirror:data/ ALL GUI NOWAIT
  368.                     FMirror mirror:data/ work:data/ ALL GUI
  369.                     echo "All data has been mirrored."
  370.                endif
  371.                ;
  372.                FBack sys:prefs/ to mirror:prefs/ ALL PACK=BZLW QUIET
  373.                echo "System preferences have been saved."
  374.                ; 
  375.                if exists C:Halt
  376.                     echo "It now safe to switch me OFF !"
  377.                     Halt 
  378.                endif
  379.  
  380.  
  381.   3. Appendix
  382.     ----------
  383.      3.1. Common problems
  384.          -----------------
  385.  
  386.           Q: It doesn't find its source/backup files ?
  387.           
  388.           A: Enter the correct path: see section 2.1 (FROM,TO option).
  389.  
  390.  
  391.  
  392.           Q: Fback picks up not any file ?
  393.           
  394.           A: Did you end the source path with a '/' ? Leaving it out
  395.              will traverse the entire source drive without touching
  396.              any file. Call it a side-effect !           
  397.  
  398.           
  399.      3.2. Error messages
  400.          ----------------
  401.  
  402.           'Source/Destination not found'
  403.  
  404.              The entered path could not be located. Correct your paths !
  405.  
  406.           'File not found'
  407.  
  408.              The file you typed could not be found.
  409.  
  410.           AmigaDOS errors are in format :
  411.  
  412.              'FBack: nnn - message'
  413.                                                               
  414.  
  415.      3.3. The future
  416.          ------------
  417.  
  418.           Any suggestions/motivations/gifts from you are welcome !
  419.           
  420.           Thanks to all guys & dolls sending me (E)MAIL.
  421.  
  422.           It is because of YOU this program keeps getting better and better...
  423.  
  424.  
  425.      3.4. About me
  426.          ----------
  427.          
  428.          Well, I'm working as a "Technical Analist" for a multinational company.
  429.          My main responsibilities are "Implementing and supporting the WINDOWS NT
  430.          LAN/WAN environment" (shame on me !). It's only for the money... give me
  431.          a break ?? (If my bosses read this -> I'm only sucking up the great Amiga   
  432.          community !).
  433.          
  434.          At home I have a Amiga 4000T (68060/50, 32Mb Fast, 1GB HD, Syquest 105,
  435.          a JAZ, VLab digitizer, Cybervision 64, Y/C genlock, 2 VCR's, etc).
  436.          Which I primarily use for desktop video, animations, LightWaving,
  437.          programming [and making backups (I detect a bit of sarcasm here !)].
  438.  
  439.          I started my Amiga carrier on a A500, upgraded to A2000 and later a 68020
  440.          accelerator card (somewhere in the cellar now).
  441.  
  442.          Anyway, hope you can use the program (I do !).
  443.          
  444.          See yo.
  445.