home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / k / keeper / !Keeper / !Help < prev    next >
Text File  |  1993-07-05  |  7KB  |  183 lines
  1. !Keeper (1.00): to keep your files backuped.
  2.  
  3. Introduction
  4. ------------
  5.  
  6. Keeper provides an easy way to make regular backup of your files. You can
  7. specify the files or directory to backup, choose the destination directory,
  8. include a command or obey file that can be runned before (and/or after) the
  9. backup and select the type of backup required (all files, newer files).
  10. The control files generated by Keeper can be runned from the desktop, just
  11. like an obey file, to make a backup of the files without having to load the
  12. Keeper application.
  13.  
  14. The lists
  15. ---------
  16.  
  17. You can specify two lists of files: the first (Backup list) contains the
  18. files or directories to backup and the second (Exclude list) the files or
  19. directories to exclude from the backup. This means that you can specify a
  20. whole directory but exclude some files from it. For example if you are
  21. programming an application you may want to backup regularly its directory.
  22. Let us consider the following directory structure:
  23.  
  24. !App --> !Boot
  25.          !Help
  26.          !Run
  27.          !RunImage
  28.          !Sprites
  29.          c         --> Source1
  30.                        Source2
  31.          h         --> Header1
  32.                        Header2
  33.          Makefile
  34.          o         --> Object1
  35.                        Object2
  36.          Templates              
  37.  
  38. You probably want to backup all the directory (ie. you don't want to
  39. specify all the single files in the !App directory) and so in the Backup
  40. list you must put !App. However there are files (ie. !RunImage and the
  41. contents of the 'o' directory) that can be easily reconstructed from the
  42. sources (contained in the 'c' and 'h' directories). To avoid this you must
  43. put !RunImage and the 'o' directory in the Exclude list.
  44. After a backup the backup directory will contain:
  45.  
  46. !App --> !Boot
  47.          !Help
  48.          !Run
  49.          !Sprites
  50.          c         --> Source1
  51.                        Source2
  52.          h         --> Header1
  53.                        Header2
  54.          Makefile
  55.          Templates              
  56.  
  57.  
  58. The backup options
  59. ------------------
  60.  
  61. There are three types of backups (Newer, All and Freshen) so that only
  62. some files are copied:
  63. Newer  : only the files that are absent from the backup directory or that
  64.          have a recent date stamp.
  65. All    : (obviously) all the files, regardless of the date stamp.
  66. Freshen: only the files that are already present in the backup directory
  67.          but that have an older date stamp.
  68. Usually Newer is the suitable option for regular backup but with Freshen
  69. you can have a finer control over the copied files (the files in the
  70. backup directory are a sort of Include-only list).
  71.  
  72.  
  73. The start and the end of the backup
  74. -----------------------------------
  75.  
  76. Before starting and after finishing a backup, Keeper can execute two CLI
  77. commands or obey files. In this way you can unprotect your read-only hard
  78. disc partition where you keep the backup copies and then reprotect it or
  79. you can create a SparkFS archive on a disc before filling it.
  80.  
  81.  
  82. The window
  83. ----------
  84.  
  85. The contents of the main window is quite self-explicative and I will only
  86. explain how to fill the fields. Almost everything can be done by dragging:
  87. - to include files in the backup or exclude list simply drag them to the
  88.   relative sub-window.
  89. - to choose the backup directory drag the directory or a file contained in
  90.   it to the writeable field or drag the writeable field itself to a filer
  91.   window.
  92. - to choose the files to run before and after the backup drag the obey(s)
  93.   to the relative writeable fields. If you want to execute a CLI command
  94.   you must definitely write it yourself. 
  95.  
  96.  
  97. The menus
  98. ---------
  99.  
  100. The two menus are quite short and easy to use:
  101. - the main menu allows you to save the control file
  102. - with the sub-windows menu you can remove the file under the pointer.
  103.  
  104.  
  105. The control file
  106. ----------------
  107.  
  108. Keeper generates control files with filetype &641. These files can be
  109. runned from the desktop (after Keeper has been seen by the filer) to
  110. start the backup without having to explicitly load the application: after
  111. the backup is finished, Keeper will automatically quit. If Keeper is
  112. already loaded or if you press Ctrl while double clicking, the file will
  113. be loaded in Keeper.
  114.  
  115.  
  116. Other features and comments
  117. ---------------------------
  118.  
  119. When the multitask option is selected, Keeper will use the standard filer
  120. action window to copy the files. Because of a limitation in the filer
  121. (only one source and one destination directory can be choosen) it is
  122. likely that more than one window is needed for the backup: to avoid that
  123. opening too many windows in one go would fill up the memory, after a
  124. window has closed onother one will be opened.
  125. The control files are written in plain text (even if they have a special
  126. filetype so that can be double clicked and runned). This means that you
  127. can load them in an editor to change their content without having to load
  128. Keeper. If an entry is missing (ie. you want to clear the commands to run
  129. before and after or the backup directory) a ":" is placed.
  130. Inside the Keeper application you can save a control file called "Default":
  131. this file is loaded every time Keeper is runned so that you can set up
  132. your default backup directory and commands setting.
  133.  
  134.  
  135. Known bugs
  136. ----------
  137.  
  138. Strangely if you try to save a control file directly to an editor you get
  139. a blank file: fortunately this is never needed.
  140.  
  141.  
  142. Possible improvements (in order of importance)
  143. ----------------------------------------------
  144.  
  145. Allow to edit the files in the backup and exclude list and add support
  146. for wildcards in filenames.
  147. Add an option to copy the files in the backup dir to another directory
  148. instead of overwriting them, so that you can have two levels of backup.
  149.  
  150.  
  151. History
  152. -------
  153.  
  154. 1.00  The first release.
  155.  
  156.  
  157. Thanks go to:
  158. -------------
  159.  
  160. - Loek Frederiks for the code of the solid drag save box.
  161. - Cristian Ghezzi for his support and Internet access.
  162. - All the people who keep Internet alive, especially who writes news,
  163.   comments, ideas and hints for the Acorn world.
  164.  
  165.  
  166. Conditions of use
  167. -----------------
  168.  
  169. This software is copyrighted by Sergio Monesi and is NOT Public Domain.
  170. You can distribute it freely as long as you don't do it for profit and you
  171. include all the original files. You can't modify it in any way without my
  172. prior permission.
  173. Donations, suggestions and criticism are always welcome. Please contact me
  174. via e-mail if you can or send me a disc if you want the latest version.
  175.  
  176.  
  177. Sergio Monesi
  178. Via Trento e Trieste 30
  179. 20046 Biassono (MI)
  180. Italy
  181.  
  182. Temporary e-mail address: ser1536@cdc835.cdc.polimi.it
  183.