home *** CD-ROM | disk | FTP | other *** search
/ The Best of Mecomp Multimedia 2 / MECOMP-CD-II.iso / amiga / tools / system / updatecopy / docs / updatecopy.doc next >
Encoding:
Text File  |  1998-01-20  |  7.2 KB  |  193 lines
  1.  
  2.                         Documentation to UpDateCopy
  3.  
  4.                           Version 1.00 - 20.01.1998
  5.                    $VER: UpDateCopy.doc 1.00 (20.01.1998)
  6.  
  7.  
  8.                          Written by Sven Steiniger
  9.                                -- Cardware --
  10.  
  11.  
  12. ------------------------------------------------------------------------------
  13.                                 Introduction
  14. ------------------------------------------------------------------------------
  15.  
  16.     UpDateCopy is an extension of the standard copy command. It does not
  17.     only copy files and create (if necessary) directories but also process
  18.     already existing files: older files are replaced automatical by newer
  19.     ones. UpDateCopy first try to find a version-string within the files
  20.     ($VER: Programname Version.Reversion) and copy only the one with the
  21.     higher version or simply compares the dates.
  22.     UpDateCopy features multiple sourcefiles, pattern matching and
  23.     recursively directory scanning.
  24.  
  25.  
  26. ------------------------------------------------------------------------------
  27.                             System requirements
  28. ------------------------------------------------------------------------------
  29.  
  30.     - an Amiga :-)
  31.     - at least KickStart 2.04
  32.  
  33. ------------------------------------------------------------------------------
  34.                                    Usage
  35. ------------------------------------------------------------------------------
  36.  
  37.  
  38.     Format:
  39.         UpDateCopy [FROM] {<sourcename|sourcepattern>} [TO] <destname>
  40.                    [QUIET] [ALL] [FORCE] [DEEP] [NODATECHECK]
  41.                    [TESTMODE] [CLONE] [PAPF] [SMARTINFO] [FAST]
  42.                    [NOASK] [CHECKARCBIT] [SETARCBIT]
  43.  
  44.     Template:
  45.         UpDateCopy FROM/M,TO/A,QUIET/S,ALL/S,FORCE/S,DEEP/S,
  46.                    NDC=NODATECHECK/S,TESTMODE/S,CLONE/S,PAB=PAPF/S,
  47.                    SMARTINFO/S,FAST/S,NOASK/S,SAB=SETARCBIT/S,
  48.                            CAB=CHECKARCBIT/S
  49.  
  50.  
  51.  
  52.     Parameter:
  53.         sourcename, sourcepattern
  54.             The names of the files to be copied or directories
  55.             (also name patterns).
  56.         destname
  57.             Name of destination directory.
  58.         QUIET
  59.             Switch output off. Only error messages are displayed.
  60.         ALL
  61.             If specified than also subdirctories are scaned and
  62.             copied otherwise only files and directorynames of the
  63.             source directory.
  64.         FORCE
  65.             Normally delete-protected files could not be over-
  66.             written. If you specify this option UpDateCopy
  67.             ignores all Protectionbits.
  68.         DEEP
  69.             UpDateCopy only compares the dates of existing files.
  70.             With the DEEP-option UpDateCopy scans the files first
  71.             for version-strings ($VER:) and only if this fails
  72.             the dates are compared.
  73.             Note: Although this search is written in fast
  74.                   assembly language it slows things down.
  75.         NODATECHECK
  76.             UpDateCopy do not compare the datestamps. This might
  77.             be useful for packed files.
  78.             Note: If this option is specified then the
  79.                   DEEP-scanmode is switch on by default.
  80.         TESTMODE
  81.             Switchs the testmode on. UpDateCopy don't copy/replace
  82.             older files and directories are not created. But the
  83.             outputs are the same as without the testmode.
  84.             This option can be used for simply comparing the
  85.             contents of two directories.
  86.         CLONE
  87.             If you set this option, UpDateCopy copies the
  88.             datestamp from the source file.
  89.         PAB
  90.             Normally UpDateCopy clears the archive protection flag
  91.             of a copied file. If you set this option this flag is
  92.             not altered.
  93.             Note: UpDateCopy always copies
  94.                 - the protection flags (except archive)
  95.                 - and the file comment.
  96.         SMARTINFO
  97.             Now UpDateCopy don't displays skipped directories and
  98.             files.
  99.         FAST
  100.             Switches off linefeeds. This increases processing
  101.             speed if you copy many small files (scrolling the
  102.             display takes longer than scanning the file).
  103.         NOASK
  104.             I an error occurs UpDateCopy asks what to do now.
  105.             By setting this switch it simply aborts.
  106.         CHECKARCBIT
  107.             Only copy files/directories if their archive bit
  108.             is *not* set. Normally the archive bit is cleared
  109.             whenever an file is modified. In connection with
  110.             SETARCBIT you can easily copy changed files.
  111.             Note:    On files with cleared archive bit all
  112.                 compare modes (date check, DEEP) are
  113.                 performed.
  114.         SETARCBIT
  115.             Sets the archive bit on all copied files/directories.
  116.  
  117.     Examples:
  118.         UpDateCopy #? ram:T
  119.             Copies all files of the current directory to
  120.             "ram:T". Not existing files are copied. Not existing
  121.             directories are created. Existing files are only
  122.             overwritten if they have a older date.
  123.         UpDateCopy #? ram:T ALL
  124.             Same as previous but now also scans through sub-
  125.             directories.
  126.         UpDateCopy #? ram:T DEEP
  127.             Same as first example but do not only compares the
  128.             dates but first compare the version-strings (if
  129.             possible)
  130.         UpDateCopy #? ram:T DEEP NDC
  131.             Same as first example but do only compares the
  132.             version-strings. If no version-string is found nothing
  133.             is copied/replaced even if the datestamp is newer.
  134.             Also not existing directories are not created.
  135.         UpDateCopy #?.info #?.e TO=ram:T ALL DEEP esource:3D/Plotter3D
  136.             Copies all files of the of the current directory to
  137.             "ram:T" which ends with ".info" or ".e". Also sub-
  138.             directories are scanned and the file
  139.             "esource:3D/Plotter3D" is copied.
  140.         UpdateCopy sys: TO backup: ALL CAB SAB SMARTINFO
  141.             This is my normal backup routine. It copies only
  142.             changed files (archive bit), sets the archive bit on
  143.             the copied files and shows a list of all copied files.
  144.  
  145. ------------------------------------------------------------------------------
  146.                                    Author
  147. ------------------------------------------------------------------------------
  148.  
  149.     Send Bugreports, Ideas or anything else to:
  150.  
  151.                                Sven Steiniger
  152.  
  153.                               Rathener Str. 29
  154.                                01259 Dresden
  155.                                 Deutschland
  156.  
  157.                      Email: ss37@irz.inf.tu-dresden.de
  158.  
  159. ------------------------------------------------------------------------------
  160.                                 Legal Stuff
  161. ------------------------------------------------------------------------------
  162.  
  163. UpDateCopy is CARDWARE, means that you should send me an email if you use it.
  164. Also small presents are very welcome.
  165.  
  166.  Copyright
  167. -----------
  168. UpDateCopy is written by Sven Steiniger. You may use the source freely in your
  169. programs or you may extend it to your own UpDateCopy. But please do not spread
  170. a modified version under this name (UpDateCopy). If the source was useful to
  171. you it would be a good idea to send me your program.
  172.  
  173.  Distribution
  174. --------------
  175. This program can be freely distributed as long as the archiv-contents is
  176. not changed and no profits are made.
  177. Archiv contents:
  178.     UpDateCopy/UpDateCopy        - the executable
  179.     UpDateCopy/Source/UpDateCopy.e    - the source file (E language)
  180.     UpDateCopy/Docs/UpDateCopy.doc    - english documentation
  181.     UpDateCopy/Docs/UpDateCopy.dok  - german documentation
  182.     UpDateCopy/Scripts/BackUpUp     - Backup-script by Attilio Scifoni
  183.     UpDateCopy/Scripts/BackUpUp2    - modified BackUpUp-script
  184.     UpDateCopy/Scripts/BackUpUp_GUI - BackUpUp2 with requesters
  185.     UpDateCopy/Scripts/BackUpUp.doc - english description of these scripts
  186.     UpDateCopy/readme        - short information
  187.  
  188.  
  189.  Disclaimer
  190. ------------
  191. I am (The author) are in no way liable for damages or loss of data directly or
  192. indirectly caused by this program.
  193.