Amiga ACS 1998 #2

home *** CD-ROM | disk | FTP | other *** search

/ Amiga ACS 1998 #2 / amigaacscoverdisc1998-021998.iso / utilities / shareware / diskutils / backup / fbackv14 / doc / fback14.doc next >

Wrap

Text File | 1997-09-07 | 18.1 KB | 445 lines

********************************************************************* FBack V1.4 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 3.4. About me 1. Introduction -------------- If you have used this program before try to make the effort to read this doc again. Some useful info is updated, not listed in previous versions. 1.1. Legal ------- Type : - (E)MAILWARE Terms : - no modifications to any file in this archive - add no additional files to this archive - use this program longer than 30 days, then you should reward the author with a postcard/letter/email, 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 - any commercial distribution is prohibited (except on Aminet). 1.2. What it does -------------- 'FBack' is a file copy tool. It will check the archive bit of files and copy them if the archive bit is not set. After copying it will add the archive bit. It can be used to perform a 'Daily' backup of changed files. As an option you can run the program in GUI mode, this will open up a window which keeps up with the process. For now, when processing is finished the window will remain open until you close it with the close gadget. Unless you specify NOWAIT, then the window is closed immediately after processing. In this mode the 'Current' gadget displays the files it is scanning. In CLI mode it merely reports the directories it is scanning (let me know if you want files here too [as an option]). On request of some users a CLONE option has been added, meaning the date/time is preserved on the backup. The filenotes are copied by default, specifying the NOCOMMENT option will suppress this. ************************* NEW FEATURES *************************** This version includes a batch mode, paths and options are then specified with a configuration file. Further, the filenotes on directories are copied. Also, in this update. Some extra statistics, the estimated processor time (for now only in second(s)). ****************************************************************** 'FMirror' is included now. Its purpose is to delete files which no longer exist in the original directory, thus creating a mirror. There has been a remark concerning the mirror concept in combination with the pack mode, if you take it word for word, issuing PACK is no EXACT mirror (jeezes!). Mirroring is portrayed in this implementation as following concept: you have a copy (normal or packed) on the backup volume of what is on your source path (Comprendo!). 1.3. Requirements -------------- Properly installed Amiga ROM 2.04+. Needs XPK library when using this option. GUI window uses standard GADTOOLS library. Needs Argue (V1.3a) to use FBackGUI, FMirrorGUI. 1.4. Contact address ----------------- For mail/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.58. All file I/O has been coded using standard system library functions (V38+). 1.6. Versions ---------- The actual version can be determined by typing 'version fback' in a CLI window. It is recommended to always upgrade to the latest version. V0.9 TEST RELEASE - first internal test version. V1.0 FIRST PUBLIC RELEASE - cleaned up code - adapt stack size + compile with stackextend, optimize - first public release. V1.1 MAJOR UPDATE - added file report after processing - shortened output strings + reformat - changed ExamineDir() flow, performs better with patterns - message to indicate NOCOPY mode - fixed error in document (FROM/A & TO/A examples). V1.1a MINOR UPDATE - changed some buffer sizes for speed, copybuffer = 16Kb. V1.2 MAJOR UPDATE - added packing mode - added XPK packer/unpacker - added date in version string. V1.2a MINOR UPDATE - updated some internal values - added Argue GUI - added BUF option. V1.2b MINOR UPDATE - added FORCE option - changed some displayed strings. V1.2c MINOR UPDATE - replaced SAS pattern match function with 'dos.library' function MatchPatternNoCase() - fixed pattern matching. V1.3 MAJOR UPDATE - archive bits are also set on destination (Oops!) - added GUI window option - added NOWAIT option - added CLONE option, to keep date on destination. V1.3a MINOR UPDATE - filenotes of files are copied now - added NOCOMMENT option - code generation with SAS/C 6.58. V1.4 MAJOR UPDATE - fixed traversing the directory tree - HandleIDCMP() uses Wait() now - added estimated processor time (and total time) report - changed output attributes of some strings - FROM, TO paths are checked now - filenotes of directories are copied now - added configuration file mode (batch). 2. Using it ---------- 2.1. Command line options ---------------------- The program uses standard AmigaDOS command templates, so typing 'FBack ?' will list all the options available. Detail explanation of options: FROM/A - the source path, a AmigaDOS file pattern may be given. fe. BOOT: BOOT:Prefs/ BOOT: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. FBack BOOT: TO BACKUP: ALL FBack WORK:data/ TO BACKUP:Sys/ PACK=HUFF ALL Fback WORK:data/calc/#?.wk1 TO BACKUP:Wks/ ALL TO/A - the destination path. fe. BACKUP: SQ0:Backup/Workbench/ Same rules as above, a volume needs no '/'. A directory always needs an ending '/'. As you might expect, the 'ALL' switch will create any missing subdirectories in the destination path. NOCOPY/S - this does exactly what it says, when a file has been modified it is normally copied to the backup location. Adding this parameter prevents this and the program will merely report the file. Call it a SIMULATE mode. ALL/S - include subdirectories. QUIET/S - no output messages. PACK=/K - enables packer mode, supply preferred packer. In this mode make sure your recovery disk includes the XPK library + some XPK unpacker (fe. xpk [included]) to restore files. fe. PACK=nuke BUF=/K/N - choose the buffer size used for copying, default is 16 Kb. Size limited only by your available RAM (but do not try to use TOO big sizes, 16 Kb will do fine for most users). The buffer size is specified in bytes. FORCE/S - specifying this option will ignore the archive bit, thus copying every file (= full backup). GUI/S - opens GUI showing some statistics, no more CLI output. NOWAIT/S - when using GUI mode, closes the window immediately after processing finishes, otherwise window remains open until you click the close gadget. CLONE/S - clones file date/time to destination. NOCOMMENT/S - specifying this option will instruct FBack NOT to copy the filenotes. *NEW* CONFIG=/K - run in batch mode, this parameter contains the filename of the configuration file to process. Syntax configuration file (text file): ----------------- cut ---------------------- [FBack] NumberOfPaths = <N> [Paths] SrcPath1 = <source path 1> DstPath1 = <destination path 1> ... SrcPathN = <source path N> DstPathN = <destination path N> [Options] BOptions1 = <fback options for entry 1> MOptions1 = <fmirror options for entry 1> ... BOptionsN = <fback options for entry N> MOptionsN = <fmirror options for entry N> ----------------- cut ---------------------- Example: study "MYBACK.CFG" included in the archive. To start batch mode use a command line like: fback "" "" cfg=myback.cfg or fback "" "" config=whatever All options are available in batch mode, except for FROM, TO and BUF. Also, batch mode is NOT included in the Argue GUI. NOTE: To detect in which mode (CLI or GUI) FBack will run the first option entry is taken. Thus, specifying GUI in the 1st option entry will trigger GUI mode for all subsequent batch entries. Leaving GUI out of the 1st option entry will run all subsequent entries in CLI mode. NOWAIT is also only interpreted in the 1st option entry. When running batch mode with GUI, the current gadget will display the batch entry it is going to process for a couple of seconds. After the batch entry is done the "Estimated processor time" is displayed. When all batch entries are finished the "Total processor time" will be shown. HINT: to test whether the config file is readable by FBack use the supplied "listcfg" tool (see "listcfg.doc"). 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". Or, if you have Argue V1.3a you can use the GUI (FBackGUI) version. 2.2. Examples ---------- This section lists some examples of usage. - Backup changed prefs files: ; Startup-sequence ... FBack sys:prefs/env-archive/ to work:backup/prefs/ ALL FORCE QUIET FMirror work:backup/prefs/ to sys:prefs/env-archive/ ALL QUIET ... - Mirror a disk at startup & create logfile: ; Startup-sequence ... FBack sys: to mirror:boot/ ALL >T:FBack.log FMirror mirror:boot/ to sys: ALL >T:FMirror.log ... - Mirror files before shutdown: .key FLAG .bra { .ket } ; Shutdown script echo "Just a moment, valuable files are checked..." ; if {FLAG} EQ "GFX" FBack work:data/gfx/ to backup:data/gfx/ ALL GUI NOWAIT echo "Gfx data has been saved." endif if {FLAG} EQ "ALL" FBack work:data/ to mirror:data/ ALL GUI NOWAIT FMirror mirror:data/ work:data/ ALL GUI echo "All data has been mirrored." endif ; FBack sys:prefs/ to mirror:prefs/ ALL PACK=BZLW QUIET echo "System preferences have been saved." ; if exists C:Halt echo "It now safe to switch me OFF !" Halt endif 3. Appendix ---------- 3.1. Common problems ----------------- Q: It doesn't find its source/backup files ? A: Enter the correct path: see section 2.1 (FROM,TO option). Q: Fback picks up not any file ? A: Did you end the source path with a '/' ? Leaving it out will traverse the entire source drive without touching any file. Call it a side-effect ! 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/motivations/gifts from you are welcome ! Thanks to all guys & dolls sending me (E)MAIL. It is because of YOU this program keeps getting better and better... 3.4. About me ---------- Well, I'm working as a "Technical Analist" for a multinational company. My main responsibilities are "Implementing and supporting the WINDOWS NT LAN/WAN environment" (shame on me !). It's only for the money... give me a break ?? (If my bosses read this -> I'm only sucking up the great Amiga community !). At home I have a Amiga 4000T (68060/50, 32Mb Fast, 1GB HD, Syquest 105, a JAZ, VLab digitizer, Cybervision 64, Y/C genlock, 2 VCR's, etc). Which I primarily use for desktop video, animations, LightWaving, programming [and making backups (I detect a bit of sarcasm here !)]. I started my Amiga carrier on a A500, upgraded to A2000 and later a 68020 accelerator card (somewhere in the cellar now). Anyway, hope you can use the program (I do !). See yo.