home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / diskutil / backup12 / backup.txt < prev   
Text File  |  1987-03-17  |  44KB  |  893 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.                          Hard Disk Backup Utility
  7.                                 Version 1.2
  8.                                17 March 1987
  9.  
  10.                                     by
  11.                             David B. Chiquelin
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.      This  hard  drive backup utility is designed to perform a  file  based 
  20. backup of hard drives.  It will not perform an image backup, but will speed 
  21. the backup process by only backing up new files and those files which  have 
  22. been modified since the last backup.  Old versions of files which have been 
  23. modified  are NOT maintained on the backup disks.   Hard disk  files  which 
  24. have  been  modified or deleted are deleted from the backup disks  and  the 
  25. freed  up disk space is used to store the current version of  the  modified 
  26. files  and new files.   It is a GEM-based program to simplify  usage.   The 
  27. program  will  also restore a hard drive using the backup  files  and  data 
  28. files created during the backup process.
  29.  
  30.  
  31.  
  32.  
  33.  
  34. Table of Contents
  35.  
  36. 1.0       Requirements
  37. 2.0       Startup
  38. 3.0       Options menu
  39.    3.1       Date on files
  40.    3.2       Write verify
  41.    3.3       Force backup (f)
  42.    3.4       Force backup (p)
  43.    3.5       Set 'To-drive'
  44.    3.6       40 folder check
  45.    3.7       Size
  46.    3.8       Date/time
  47.    3.9       Archive bit
  48.    3.10      Set list options
  49. 4.0       Disk menu
  50.    4.1       Back-up a hard drive
  51.    4.2       Restore a hard drive
  52.    4.3       Save defaults
  53.    4.4       Create new data files
  54. 5.0       Info menu
  55.    5.1       List file data
  56.    5.2       Search for file(s)
  57. 6.0       Quit menu
  58. 7.0       Terminology
  59. 8.0       Distribution & Notes
  60.    8.1       Changes for version 1.1
  61.    8.2       Changes for version 1.2
  62.  
  63.  
  64.                                Requirements                           1.0
  65.  
  66.      This  program will run on Atari ST computers in either medium or  high 
  67. resolution  modes.   It  WILL NOT format disks,  so an adequate  supply  of 
  68. previously formatted disks should be on hand before beginning a backup.   I 
  69. recommend  disks formatted using the Quick Format program by Brian Ames  be 
  70. used  to help speed up the file saves.   Quick Format is a PD  program  and 
  71. available on most BBSs.   (Sometimes called FASTFORM)
  72.  
  73.      NOTE:   Other format utilities may not work properly with BUP.  Before 
  74. relying  on  them,  run a test by using disks formatted by the  utility  in 
  75. question in BUP and then looking at the disk contents from the desktop.  If 
  76. the files show up (on ALL disks, not just the first) then the format should 
  77. work properly with BUP.  TWISTER ver 1.0 would NOT work properly with BUP.
  78.  
  79.      The Backup Utility Program (BUP) has been tested on both a 520 ST with 
  80. TOS  in ROM and a 1040 ST.   It has not been tested on a 520 ST  with  disk 
  81. based TOS.
  82.  
  83.      The program keeps its internal data in dynamically allocated pointers.  
  84. This  allows the backing up of hard drives of very large size  without  any  
  85. limit  (other than available free RAM) as would be imposed if  arrays  were 
  86. used.   Each  file on a hard drive will take up approximately 42  bytes  of 
  87. memory  for the pointer data,  and each folder will take approximately  110 
  88. bytes.
  89.  
  90.  
  91.  
  92.  
  93.  
  94.                                   Startup                             2.0
  95.  
  96.      When  you  run BUP it will first display a title  screen  showing  the 
  97. version  number  and  the  obligatory statement that  portions  of  it  are 
  98. copyright  by  OSS and CCD.   This is necessary as it is written  in  OSS's 
  99. Personal Pascal.  Click in the OK button or press RETURN.
  100.  
  101.      BUP will immediately display the current date as set in the ST and ask 
  102. if  it is correct.   It is important that the correct date be in the ST  so 
  103. the  program  can  accurately  advise  you of  when  the  last  backup  was 
  104. performed.   If the date is correct, click on Yes (or press RETURN).  If No 
  105. is  selected another dialog box allowing you to set the correct  date  will 
  106. appear.   After setting the correct date BUP will again show the date in  a 
  107. dialog box and ask if it is correct.   When the date has been set correctly 
  108. the dialog boxes will disappear and the top menu will be active.   The menu 
  109. choices are Desk,  Disk,  Info,  Options and Quit.  Options will be covered 
  110. first as this is where you tell BUP how you would like it to operate.
  111.  
  112.  
  113.  
  114.  
  115.  
  116.                                Options menu                           3.0
  117.  
  118.      The  Options menu selection will allow you to set how the BUP  program 
  119. will run.   It is important that you carefully consider how you wish to set 
  120. the options under 'Backup using...' as this affects how future backups  are 
  121. performed.
  122.  
  123.  
  124.                                Date on files                          3.1
  125.  
  126.      Date on files is concerned with what date and time is placed on  files 
  127. if BUP is used to restore a HD.  This is a change from previous versions of 
  128. BUP  and  is designed to save time when backing up a  HD.   There  are  two 
  129. choices  - current date/time and HD (hard drive)  date/time.   The  initial 
  130. default  setting  is  HD date/time.   If the current  date/time  option  is 
  131. selected  then when restoring files the date and time will be the date  and 
  132. time  normally placed on files during a copy.   If HD is selected then  the 
  133. files copied to the HD during the restore will have the same date and  time 
  134. as  they originally had.   It does not matter what setting is  used  during 
  135. backup,  the  backup files will show the date and time of backup,  not  the 
  136. date  and time of the HD files.   You may change this  setting  immediately 
  137. prior to doing a restore, it has no effect on backup procedures.
  138.  
  139.      By  not changing the date and time on the backup disk files,  a  small 
  140. amount of time is saved as it does away with an extra file access.
  141.  
  142.  
  143.  
  144.  
  145.  
  146.                               Write verify on                         3.2
  147.  
  148.      The  'Write verify' item in the Options menu allows you to turn  write 
  149. verify on or off.   The initial default setting is off.   Leaving the write 
  150. verify off will double the write speed (but not cut in half the actual time 
  151. spent  saving  due to GEM overhead.)  I have used the  program  exclusively 
  152. with  write verify off with no problems.   Just be sure good quality  disks 
  153. are used.
  154.  
  155.      Leaving  write verify off and using Quick Format formatted disks  will 
  156. greatly help in speeding up the backup and restore process.
  157.  
  158.      If write verify is on,  the 'Write verify' menu item will have a check 
  159. in front of it.
  160.  
  161.  
  162.  
  163.  
  164.  
  165.                              Force backup (f)                         3.3
  166.  
  167.      BUP  will only backup files that are new or have been  modified  since 
  168. the  last time BUP was run.   It uses criteria determined by you (see  3.6-
  169. 3.8)  to  detect if a file has been modified.   Since some  programs  alter 
  170. files without using GEM and leave no indication of changes,  a force backup 
  171. option  is available.   If 'Force backup (f)' is selected from  the  Option 
  172. menu,  (the 'f' designates a forced backup by file) a dialog box will  open 
  173. allowing  you to enter up to 10 strings that will cause a forced backup  of 
  174. any  file  that matches the string or has the string as part  of  its  file 
  175. name.      BUP will look to see if any of the strings entered in the dialog 
  176. box are contained in each file name,  and if so, will backup that file.  An 
  177. important  note is that this option does not support the use of the * or  ? 
  178. file match criteria often used by DOS's.
  179.  
  180.      Example:   I  have found that the FoReM ST BBS system directly  alters 
  181. its  message base and password files.   Because of this BUP will  not  back 
  182. these  files up during a normal backup and so I use the 'Force backup  (f)' 
  183. option to save the current files.  The message files are named MESAGE1.DAT, 
  184. MESAGE1.IDX  and MESAGE1.ISM to MESAGE7.DAT,  MESAGE7.IDX and  MESAGE7.ISM, 
  185. with  the password files named PAS.DAT and PAS.IDX  To force the backup  of 
  186. these  files I enter on one line of the dialog box "MESAGE" and on  another 
  187. line  "PAS."   (Without the quotes.)  BUP will backup all files  that  have 
  188. either the string MESAGE or PAS. in them, causing all the files I desire to 
  189. be backed up.   For comparison,  if the * and ?  could be used then I would 
  190. have entered "MESAGE?.*" and "PAS.*".   (For comparison ONLY!  They may not 
  191. be used.)
  192.  
  193.      Lower case text may also be entered in these fields.  BUP will convert 
  194. it to upper case.
  195.  
  196.      When Forced backup (f) is active a check will be in front of the  item 
  197. in the Options menu.
  198.  
  199.  
  200.  
  201.  
  202.  
  203.                              Force Backup (p)                         3.4
  204.  
  205.      You  may also force backup of all the files within a folder  by  using 
  206. the Force Backup (p) option.  The (p) designates a path forced backup.  The 
  207. same  criteria is used as in a file forced backup.   Ie.,  a match  of  the 
  208. entered string with any path will force that path to be backed up.   You do 
  209. not have to enter the whole path,  and in fact you may not have  sufficient 
  210. space to enter the whole path.  Example:
  211.  
  212.    I  wish to force the backup of all the files in \PASCAL\BACKUP\ but  not 
  213.    the  files  in  \PASCAL\BACKBURN\.    I  could  enter  the  whole   path 
  214.    (\PASCAL\BACKUP\) or just enough to specify the path such as  CAL\BACKU, 
  215.    or  even  \BACKU  if there were no other paths named  or  starting  with 
  216.    \BACKU on the HD. 
  217.  
  218.      Lower case text may also be entered in these fields.  BUP will convert 
  219. it to upper case.
  220.  
  221.      When Forced backup (p) is active a check will be in front of the  item 
  222. in the Options menu.
  223.  
  224.      
  225.  
  226.                               Set 'To-drive'                          3.5
  227.  
  228.      BUP will backup files to either drive A or B.   The default is A,  but 
  229. you may change to B with this selection from the Options menu.
  230.  
  231.  
  232.  
  233.  
  234.  
  235.                               40 Folder check                         3.6
  236.  
  237.      TOS  has  a serious bug at the present time that can cause  your  hard 
  238. drive and BUP to not function correctly.  It is called the 40 folder limit, 
  239. and  means basically that you should have no more than 40 folders  combined 
  240. on  ALL  your connected hard drives.   TOS has an  array  (not  dynamically 
  241. allocated) set aside to store the HD folder data.  Whenever a new folder is 
  242. accessed,  a  slot  in this array is used.   The slot is never  'freed  up' 
  243. unless you reboot the system.  If all the slots fill up you will see errors 
  244. occur and it will appear your hard drive is trashed.   DO NOT reformat your 
  245. hard drive,  simply reboot your ST and check again.   If it was a 40 folder 
  246. problem your HD and ST will be functioning properly.
  247.  
  248.      The  actual  array count is higher than 40 (presumed to  be  somewhere 
  249. between 60 and 70),  but the total includes slots for floppy folders (these 
  250. ARE freed when the floppy is changed) and also the root directories take up 
  251. a slot.   If you have slightly over 40 folders on your HD, you may be safe, 
  252. or you may be eligible for the '40 folder' bug.  Atari has officially taken 
  253. the  stand that you should not have more than 40 folders on  all  connected 
  254. HD's.  (Actual or logical.)  If you have more than 40 you do so at your own 
  255. risk.
  256.  
  257.      When  BUP backs up or restores a HD it does not attempt to keep  track 
  258. of how many folders were accessed.   (Mainly because it checks first to see 
  259. how much free space is available on the HD,  which accesses ALL folders  on 
  260. that HD.)  If performing a search for a file (see 5.2) and if the 40 folder 
  261. check  option is turned on from the Options menu it will alert you when  it 
  262. has  accessed  more than 40 folders and ask if you desire  to  continue  or 
  263. abort the search.
  264.  
  265.      The initial default setting has the 40 folder check option turned  on.  
  266. If  active,  a  check mark will be in front of the '40 folder  check'  menu 
  267. item.
  268.  
  269.  
  270.  
  271.  
  272.  
  273.                             (Backup using) Size                       3.7
  274.  
  275.      One of the criteria BUP may use to determine if a file needs backup is 
  276. if  the  file size has changed since last backed  up.   This  check  should 
  277. normally be left on.
  278.  
  279.      The initial default setting is on. If on a check mark will be in front 
  280. of 'Size' in the Options menu.
  281.  
  282.  
  283.  
  284.  
  285.  
  286.                          (Backup using) Date/time                     3.8
  287.  
  288.      Another backup selection criteria is the file's date and time.  If the 
  289. current  HD  file's date and time are not the same as the file's  date  and 
  290. time when last backed up, then the file will be selected for backup.
  291.  
  292.      The initial default setting is on.   When on,  a check mark will be in 
  293. front of 'Date/time/ in the Options menu.
  294.  
  295.  
  296.  
  297.  
  298.  
  299.                         (Backup using) Archive bit                    3.9
  300.  
  301.      TOS  includes  a bit in the file's attributes that can be set  when  a 
  302. backup  is performed.   If the file is then written to using TOS  functions 
  303. (not  directly written to on a track or sector basis) the archive bit  will 
  304. be cleared.   Even if the file's date/time and size have not  changed,  the 
  305. archive bit will alert BUP that a backup is required.
  306.  
  307.      IMPORTANT NOTE:   If the archive bit option is turned off when backing 
  308. up a HD,  it should NOT be turned on again for later backups.   If off, the 
  309. archive  bit  will not be set on the HD files.   A later  backup  with  the 
  310. archive bit option on would then select all files for backup as the archive 
  311. bit would be off.
  312.  
  313.      When restoring a HD if the archive bit option is ON, the HD files will 
  314. have their archive bit set so later backups will perform correctly.
  315.  
  316.      The  initial  default setting has the archive bit  check  enabled.   A 
  317. check  mark will be in front of 'Archive bit' in the Options menu  if  this 
  318. function is on.
  319.  
  320. NOTE:   If  all  three 'Backup using' options are off,  then only  new  and 
  321. forced  files will be saved.   At least one of the above should be on  when 
  322. performing backups.
  323.  
  324.  
  325.  
  326.  
  327.  
  328.                              List file options                        3.10
  329.  
  330.      File data may be listed to the screen or printer for any drive:
  331.  
  332.           - Alphabetically by folder (Initial default)
  333.           - Alphabetically for HD
  334.           - By size for HD
  335.           - By age for HD
  336.           - By backup disk
  337.  
  338.      The listing can be in increasing or decreasing format and the data can 
  339. be from the backup data disk,  from the HD, or a combined comparison of the 
  340. backup data and the current HD status.  See 5.1 for more details.
  341.  
  342.      The  'List  file  data' selection in the Options menu  allows  you  to 
  343. select  how  you want the data to be listed.   A window shows  the  current 
  344. settings  and  the mouse is used to make changes.   Click  the  left  mouse 
  345. button on the desired settings.  Click on the DONE box when finished.
  346.  
  347.  
  348.  
  349.  
  350.  
  351.                                  Disk Menu                            4.0
  352.  
  353.      The disk menu contains the selections for backing up a HD, restoring a 
  354. HD and saving the default settings made using the Options menu.
  355.  
  356.  
  357.  
  358.  
  359.  
  360.                             Back-up a hard disk                       4.1
  361.  
  362.  
  363.      When  the 'Back-up a hard disk' item is selected,  BUP will first  ask 
  364. which drive you wish to backup.  Select which HD to backup from the choices 
  365. (C to P) shown.  You may abort the backup by clicking in the Abort box.  If 
  366. the selected HD is a valid choice (connected to the system on boot-up)  BUP 
  367. will show a small window with 'Standby...' displayed.   BUP is  determining 
  368. the  HD size and free space.   The Standby box will disappear and a  dialog 
  369. box  will then ask which drive contains the Backup data  files.   When  you 
  370. first  backup a HD using BUP it will create the data files  containing  the 
  371. information it needs to perform subsequent backups properly.   You may save 
  372. these data files on drives A, B, C or D.  I highly recommend taking a blank 
  373. disk and labeling it BACKUP DATA DISK.  If the data files are saved on a HD 
  374. and the HD requires restoring,  BUP will not be able to perform the restore 
  375. function.   A utility is planned to allow the creation of the data files in 
  376. the  event they are lost but is not available at this  time.   PROTECT  THE 
  377. DATA FILES.  These are not the backup disks which contain the backup files.  
  378. All your backup data files may reside on one disk as they are named for the 
  379. drive they contain data for.   The first time you are using BUP,  click  on 
  380. the None box.
  381.  
  382.      If  there are data disks (ie.,  if this is not the first time you  are 
  383. using BUP to backup a HD), make sure the data disk is in the selected drive 
  384. before making your selection.   If you select a drive and there are no data 
  385. files present the program will alert you to that fact and abort the backup, 
  386. allowing you to insert the correct data disk and reselect the backup  item.  
  387. If  data  files  are present BUP will read in the old data  from  the  last 
  388. backup.
  389.  
  390.      If  None was selected,  or after reading in the data files if a  drive 
  391. was selected,  BUP will display a window titled EXAMINING HARD  DISK.   The 
  392. window  will  show  the drive  identifier,  size  allocated,  free  storage 
  393. remaining  on the drive,  number of paths found,  number of files  checked, 
  394. number  of  new  files and the number of modified files  found  since  last 
  395. backup.   While BUP is searching the HD,  and at any time during the backup 
  396. process if any key is pressed on the ST BUP will pause and display an alert 
  397. box requesting whether you wish to continue or abort.
  398.  
  399.      When the search is completed, a new dialog box will appear showing how 
  400. many  files  need to be saved and asking again if you wish to  continue  or 
  401. abort the backup process.   If you do not abort the process BUP checks  its 
  402. internal data from the data files to see if any files previously backed  up 
  403. have been deleted from the HD.   If there are a lot of files on the HD  and 
  404. there  have been a lot of deleted files this may take a few  seconds.   The 
  405. screen  will remain blank while BUP does this check.   (No dialog or  alert 
  406. box  or window explaining the delay.)  If there are any deleted  file  that 
  407. have been backed up previously,  BUP will tell you how many and ask if  you 
  408. wish to save all the files,  delete all the files or delete by  query.   If 
  409. save  is  selected,  none  of the old files on the  backup  disks  will  be 
  410. deleted.   If delete all is selected, all the old files no longer on the HD 
  411. will be deleted.   If delete by query is chosen you will be shown the  file 
  412. name and folder the file is in and may select to delete the file,  save the 
  413. file  or  delete the remaining files.   If delete the  remaining  files  is 
  414. chosen  the file currently displayed and the remaining files that have  not 
  415. been displayed will be deleted,  any previously shown files will either  be 
  416. saved  or  deleted  depending  on the selection  made  when  the  file  was 
  417. displayed.
  418.  
  419.      At this point BUP will 'do its thing' and start backing up the HD.   A 
  420. window will appear that will keep you advised of the backup progress.  This 
  421. window shows:
  422.  
  423.           - File name in a rounded edged box top center of the window.
  424.           - File's date
  425.           - File size
  426.           - Date it was last backed up (blank if first time)
  427.           - File status (New, Modified, Deleted, Forced)
  428.           - Path of the file (folder) on up to two lines
  429.           - Hard drive being backed up
  430.           - Size of the hard drive
  431.           - Free space on the hard drive
  432.           - Total files on the hard drive
  433.           - Number of files left to copy
  434.           - Number of files copied
  435.           - Backup disk number
  436.           - Size of the backup disk
  437.           - Free space on the backup disk
  438.           - Number of files on the backup disk
  439.           - Action being taken
  440.  
  441.      BUP  will ring the ST bell and display a dialog box requesting a  disk 
  442. be inserted into the drive specified as the 'To drive' in the Options menu.  
  443. If  it is the first time BUP is being run it will ask for "new disk  #x-1", 
  444. where the x corresponds to the drive being backed up.   Insert a previously 
  445. formatted disk into the specified drive.   BUP will place a hidden file  on 
  446. the disk that tells BUP what drive and disk number the disk is.   From then 
  447. on if BUP needs that disk to either erase a file or save a file it will ask 
  448. for "old disk #x-1".  Make sure you mark your disks properly, as it can get 
  449. frustrating  trying  to find the correct disk with BUP telling  you  "wrong 
  450. disk".   If you insert a disk that was used to backup a different  HD,  BUP 
  451. will tell you what disk number it is and for what HD, and ask if you really 
  452. want to use it.
  453.  
  454.      When the proper disk is in place the backup will begin.  You can watch 
  455. as BUP keeps you informed of the progress in the window.  To abort or pause 
  456. the backup press any key.   When the disk can hold no other files from  the 
  457. hard drive BUP will sound the bell again and ask for the next backup  disk.  
  458. You can turn the volume up on the monitor and not watch the display as  the 
  459. bell will alert you when action is necessary.
  460.  
  461.      When  all  files have been backed up,  or if the  program  is  aborted 
  462. before it is finished,  BUP will ask you to specify which drive to save the 
  463. data files to.   These are the IMPORTANT data files it initially asked  you 
  464. for  and should be saved on a floppy although you may select from drives  A 
  465. to  D  to save them on.   BUP will create three files containing  the  data 
  466. fields  necessary for it to properly backup the hard drive at a later  date 
  467. or for listing the file data using the Info menu.   The files will be named 
  468. DATA_x.FLS,  DATA_x.PTH and DATA_x.DSK, where the x is replaced by the hard 
  469. drive letter.
  470.  
  471.      If the backup is aborted the data files will allow you to continue the 
  472. backup  at  a later time from where you left off.   In this case  the  file 
  473. status  in the progress window may not be correct,  but the files  will  be 
  474. backed up properly and the data files after the backup is complete will  be 
  475. correct.
  476.  
  477.      If  an  error occurs during the backup process and the  ST  shows  the 
  478. standard  alert  box stating the data on the disk may be damaged  then  the 
  479. program may bomb when the cancel button is selected.   (See 8.2, changes in 
  480. version 1.2 for additional info on this.)  If another disk is inserted  and 
  481. the  retry  button is selected then the backup will continue but  the  data 
  482. files  will  not be correct.
  483.  
  484. Backup  notes:   BUP checks the disk when first inserted to  determine  the 
  485. size  and  free space.   During the backup process BUP estimates  the  free 
  486. space in order to save time.   When it tries to save a file that will bring 
  487. the  free  space to 7K or less,  it will check the actual disk  free  space 
  488. before saving the file.
  489.  
  490. BUP  does not attempt to optimize the packing of files on  the  disks.   It 
  491. arranges  the  files  alphabetically and  the  folders  alphabetically  and 
  492. starting  at the root directory saves all the files within  that  directory 
  493. that  will fit on the disk.   When all the files in the  current  directory 
  494. have been saved or skipped,  it switches to the next directory (folder) and 
  495. checks those files.  It continues trying to find files that will fit in the 
  496. remaining disk space until either all files have been checked, the disk has 
  497. 0 remaining free space,  or it only has 1K free and a new folder would have 
  498. to  be  created to save a file.   (Each folder takes 1K of  disk  space  to 
  499. create.)  This works fairly well but may leave some disks with free  space, 
  500. especially when performing later backups where the files to choose from are 
  501. fewer.   Over  time  the  disks  will  remain  close  to  full.   (From  my 
  502. experience.)
  503.  
  504.  
  505.  
  506.  
  507.  
  508.                             Restore a hard disk                       4.2
  509.  
  510.      If the hard disk requires restoring for whatever reason,  then BUP can 
  511. perform  the  restoration also provided the backup data  files  and  backup 
  512. disks  are available.   You MUST have both the backup disks and the  backup 
  513. data files to use BUP to restore a hard disk.   The prompts are similar  to 
  514. when  backing  up  a hard disk and a status screen similar  to  the  backup 
  515. status screen that is displayed during backup is shown.  The restore status 
  516. screen  shows  the same file information but for the backup disk  and  hard 
  517. drive displays:
  518.  
  519.           - Files on disk (total files on the backup disk)
  520.           - Files to copy (left to copy from this backup disk)
  521.           - Files copied (from this backup disk)
  522.           - Size (of the hard disk)
  523.           - Free (storage on the hard disk)
  524.           - Total files (number of files copied to the hard disk)
  525.           - Files to copy (total remaining on all backup disks to copy)
  526.           - Files copied (total files copied from all backup disks)
  527.  
  528.      If the hard drive time option is set so the backup files have the same 
  529. date and time as the hard drive files,  then the restored hard drive  files 
  530. will  have  their old dates and times.   When the restore is  complete  the 
  531. window will erase and the menu will be active again.   If the option is set 
  532. so the backup files have the date and time of backup, then BUP will ask for 
  533. the data disk when the restore is complete so it can save the new times  of 
  534. the hard drive files.
  535.  
  536.    BUP  seems  very  sensitive to the 40 folder  problem  with  TOS  during 
  537. restore  operations.   I  have  added an alert box that will  appear  if  a 
  538. problem associated with the 40-folder bug shows up.   You may continue  the 
  539. restore or abort.  If continue is selected the file that was being restored 
  540. is skipped and BUP tries to save the next file.   If the alert box  appears 
  541. again you should abort and check for evidence of the 40 folder bug.   To do 
  542. this look at the HD you were restoring.   If it appears blank,  then reboot 
  543. the  system.   The  files  that have been restored  should  show  up  after 
  544. rebooting.  You may try BUP again to restore the HD, making sure you do not 
  545. access any other drives or folders,  and see if it will be able to complete 
  546. the process, or copy the remaining files from the desktop manually.  If you 
  547. copy  the  files manually,  use Create New Data Files to avoid  having  BUP 
  548. think the files you copied manually (with new date and times) are  modified 
  549. versions of the old files.
  550.  
  551.      BUP shows the free remaining space on the HD being restored,  but does 
  552. not use the data to determine if a file can be saved on the HD.   You  must 
  553. partition  your  HD  large enough to accept the files  during  the  restore 
  554. process.   The free space is estimated while copying files and checked  for 
  555. the  actual free space whenever a new disk is inserted during  the  restore 
  556. process. 
  557.  
  558.  
  559.  
  560.  
  561.  
  562.                                Save defaults                          4.3
  563.  
  564.      The  settings made using the Options menu may be saved to disk so  BUP 
  565. can remember your preferences.   BUP will save the settings in a file named 
  566. BACKUP.DEF on the drive BUP was run from.   If run from A or B, you will be 
  567. prompted to insert your program disk before BUP saves the file.   When  BUP 
  568. is  run  it first looks to see if there is a file named BACKUP.DEF  on  the 
  569. drive it was run from.  If the file is found it loads in your settings.  If 
  570. not  it will set them to the default settings as described in  the  Options 
  571. section.
  572.  
  573.  
  574.  
  575.  
  576.  
  577.                            Create new data files                      4.4
  578.  
  579.      This  menu  item may be used if you have lost your  backup  data  disk 
  580. files or have used another backup program and would like to use BUP.   When 
  581. selected you will be asked which drive to create the data files for.   Once 
  582. selected  the program will prompt you to "Insert old backup disk #x-1  into 
  583. drive  A",  again  where the x corresponds to the drive the files  will  be 
  584. created for.   If you are recreating the data files from data disks created 
  585. by  BUP  then there should be no problem.
  586.  
  587.      If  you are using backup disks created by another program or  manually 
  588. copied,  then you MUST insure there is at least 1024 bytes free on the disk 
  589. for BUP to save the hidden file containing the disk identity.   If any disk 
  590. has  0 bytes free,  then transfer one file to another disk and  delete  the 
  591. file on your original disk.   Since BUP only saves the most recent  version 
  592. of all files on the HD,  you should also insure the disks you will be using 
  593. to  create  the  new  backup data files from have only  one  copy  of  each 
  594. program.  If using disks from a program that saves new versions of modified 
  595. HD  files  on new disks (ie.,  retains the old files and your  backup  disk 
  596. collection  continues to grow over time),  then delete the older copies  of 
  597. the  duplicate  files or perform a complete backup of the  HD  forcing  the 
  598. program  to save all files on new disks and use these disks to  create  the 
  599. backup data files for BUP.
  600.  
  601.      When  BUP has searched all your disks for the selected drive  tell  it 
  602. there are no more disks by clicking in the appropriate box.   BUP will next 
  603. ask  if  you wish to compare the data with the current  hard  drive  files.  
  604. This feature is used so BUP will know the correct date on the files on  the 
  605. HD (in case they are different from the file's date and time on the  backup 
  606. disk.)   If your HD does not contain all the files that are in  the  backup 
  607. disks BUP will not mark them as deleted during this operation.  The compare 
  608. with HD is ONLY to set the correct date/time and check for new files.
  609.  
  610.      When completed with checking the HD (if selected),  BUP will save  the 
  611. new  Backup data files on the drive you specify.   The date of last  backup 
  612. for  all  the  files  will be set to the current  date  since  BUP  has  no 
  613. knowledge of when the files were saved.
  614.  
  615.      At this point you have several options depending on your backup  disks 
  616. and HD status.
  617.  
  618.         If your HD was backed up,  then reformatted or erased or has  files 
  619.      deleted  that  are on your backup disk,  then you may restore  the  HD 
  620.      using PUB and the created backup data files.
  621.  
  622.         If  your HD was backed up,  then reformatted or erased and has  NEW 
  623.      files  on it you wish to save with your other backed  up  files,  then 
  624.      make sure your List file options are set to NO compare and immediately 
  625.      go to List file data.   Look at the file data to insure it is  correct 
  626.      (you  also should have selected Compare with HD when creating the  new 
  627.      backup data files) and then close the list window.   The program  will 
  628.      ask you if you wish to backup your files.   Answer Yes and follow  the 
  629.      prompts.  This must be done immediately after creating the data files.  
  630.      If  BUP  reads  the data in from the backup data files and  you  do  a 
  631.      backup of the HD,  files missing from the HD will be erased from  your 
  632.      backup disks.
  633.  
  634.          If your HD was backed up and new files have been added  since  the 
  635.      backup,  then  you may use the normal backup function of BUP to  bring 
  636.      your backup disks up to date.
  637.  
  638.         If your HD was backed up and then BUP was used to create the backup 
  639.      data files,  with all HD files on the backup disks, there should be no 
  640.      problems and the session is complete.
  641.  
  642.  
  643.  
  644.  
  645.  
  646.                                    Info                               5.0
  647.  
  648.      The Info menu allows you to view or print file information,  or search 
  649. the connected hard drives for a file.
  650.  
  651.  
  652.  
  653.  
  654.  
  655.                               List file data                          5.1
  656.  
  657.      List  file data will display or print file data as determined  by  the 
  658. 'Set list options' settings.   The choices are shown in section 3.9  above.  
  659. If  'Alphabetically by folder' is the method,  then the listing will  start 
  660. with the pathname and list all files under that path.   If anything else is 
  661. chosen the files are listed and a column with the path 'key' is  displayed.  
  662. If  printing  the data the path keys will be displayed at the  end  of  the 
  663. listing.   If the listing is to the screen the top menu bar will change  to 
  664. show a menu choice of Paths.  If the paths menu is selected a second window 
  665. will open displaying the path 'keys' and associated names.
  666.  
  667.      The  information  shown in the printout or window is  the  same.   The 
  668. window will have a header labeling the columns,  if printed the header will 
  669. be at the top of each page.  The data shown is:
  670.  
  671.           - File name
  672.           - Path key (if not sorted by folder)
  673.           - File size
  674.           - File date
  675.           - File time
  676.           - Date of last backup
  677.           - Which backup disk the file is on
  678.  
  679.      When displaying the data to screen the main file data window  operates 
  680. similarly to the normal GEM window.  Clicking on the up or down arrows will 
  681. move  the file listing up or down by one line.   Clicking in the grey  area 
  682. above  or below the slider box will move the listing up or down  one  page.  
  683. (A  page is determined by the number of lines being displayed in  the  file 
  684. data window and varies by the size of the window.)  The slider may also  be 
  685. dragged up or down to rapidly move to a different area.  The full box, size 
  686. box,  close  box and top move bar all function as in normal GEM  use.   The 
  687. mouse may perform slowly however (I'm not sure why this occurs) and you can 
  688. either click several times or simply hold the mouse button down longer than 
  689. usual in order for the requested action to take place.
  690.  
  691.      The path window functions slightly differently when it is active.  The 
  692. window  does not have a slider and when the up or down arrows are  selected 
  693. the  paths shown will move up or down by one page.   The path  window  also 
  694. includes the full box,  close box,  size box and move bar as in normal  GEM 
  695. applications.
  696.  
  697.      If 'Compare with current drive specs' is set to Yes (In the 'Set  list 
  698. options'  menu) then BUP will compare the data from the data disk with  the 
  699. current  files on the hard disk.   A file that needs to be backed  up  will 
  700. have an asterisk in the left column.  If it is new the words No B/U will be 
  701. in the column that displays the date of last backup.   A file that has been 
  702. deleted on the hard disk will have a D in the first column.   If files need 
  703. backup then when the window is closed (and the path window closed if it has 
  704. been opened) then BUP will ask if you wish to backup the hard disk at  this 
  705. time.  If you do a normal backup will proceed.
  706.  
  707.      If compare is set to No,  only the data from the backup data disk will 
  708. be  displayed and there should be no asterisks or D's showing.   (Unless  a 
  709. backup was aborted before completion.
  710.  
  711.      If compare is set to Yes and there are no data files then the  listing 
  712. will  show the current files on the drive and all will have an asterisk  in 
  713. front of their names.
  714.  
  715. Note:   The  printer output assumes 66 lines per page and continuous  feed 
  716. for the paper.   The paper should be aligned and the printer online  before 
  717. selecting  'List  file  data'  if the output has been  selected  to  go  to 
  718. printer.
  719.  
  720.  
  721.  
  722.  
  723.  
  724.                             Search for file(s)                        5.2
  725.  
  726.      This  menu  selection allows you to search one or all  connected  hard 
  727. drives  (C to P) for a file or group of files.   If selected a  dialog  box 
  728. will open asking you for the string to search for and whether to search one 
  729. or  all  drives.   The string search feature works the same as  the  forced 
  730. backup methodology.  You enter a file name or portion of a file name and the 
  731. program will tell you of all files that have the search string within their 
  732. name.
  733.  
  734.      If the '40 folder check' is enabled,  then during the search BUP  will 
  735. alert  you  when  it has accessed more than 40 folders and  each  time  the 
  736. number  of  folders accessed increases from then on.   Be very  careful  of 
  737. exceeding the 40 folder limit during one session.
  738.  
  739.      When  BUP searches there are two windows displayed.   The first  is  a 
  740. very small window at the top center that displays which drive is  currently 
  741. being  searched,  and the larger main window is used to display  the  files 
  742. that match the search parameter.   After a file is found that matches,  the 
  743. number of the match (starting at 1),  the file name and the file's path are 
  744. displayed.   Two  buttons  will also appear at the bottom  of  the  display 
  745. labeled Continue and Abort.   If continue is selected the search  continues 
  746. and if another file name match is found the new file data will be displayed 
  747. under the previous file data.   Long path names may require two lines to be 
  748. displayed but BUP will perform word wrap on the appropriate '\'  sign.   If 
  749. the window fills up it will clear and start displaying new matches from the 
  750. top again.   You may also abort the search at any time by pressing any  key 
  751. on the ST keyboard.
  752.  
  753.  
  754.  
  755.  
  756.  
  757.                                  Quit menu                            6.0
  758.  
  759.      The  last menu item is the quit menu.   If selected an alert box  will 
  760. ask if you are sure you want to quit.   If yes,  the program will end.  BUP 
  761. will  not  automatically save your default settings.   You must  save  them 
  762. using the Save defaults menu item.
  763.  
  764.  
  765.  
  766.  
  767.  
  768.                                 Terminology                           7.0
  769.  
  770.    BUP  - Backup Utility Program.
  771.  
  772.    Backup data disk  - Backup data disk is not a disk containing the backed 
  773.       up files from the HD,  but is the one disk containing the backup data 
  774.       files  created by BUP and used by BUP to perform subsequent  backups.  
  775.       This disk should be carefully protected as BUP requires it to perform 
  776.       a restore or to properly backup the HD again.  Label this disk Backup 
  777.       Data disk.
  778.     
  779.    Backup disk  - A disk containing copies of the files on the  HD.   There 
  780.      can/will  be multiple backup disks.   They should be labeled with  the 
  781.      letter of the drive they contain files from and the disk # assigned by 
  782.      BUP.  Example - Backup disk C-001.
  783.  
  784.    Hard disk,  hard drive,  HD  - All mean the same thing,  the  high-speed 
  785.      fixed  media  device using the ST's DMA port.   The terms refer  to  a 
  786.      unique drive identifier,  as in drive D or drive E.  A single physical 
  787.      HD  may  be  partitioned  into  several  logical  HDs  with   separate 
  788.      identifiers.
  789.  
  790.  
  791.  
  792.  
  793.  
  794.                            Distribution & Notes                       8.0
  795.  
  796.      Permission  is  granted  to  distribute the program  as  long  as  the 
  797. documentation file accompanies the program.  The program is copyright by me 
  798. and is distributed as a Shareware program.  This does not mean and I do not 
  799. expect  you  to send me money before you can use it.   I  feel  you  should 
  800. decide  if the program is worth anything to you by using it before  feeling 
  801. obliged to send money.   If you use the program but find it too slow or you 
  802. find a better program, then don't send anything.  If you do use it and like 
  803. it,  then I hope you will recognize the work and time spent writing BUP and 
  804. contribute a small amount to supplement my current unemployed pay of  zero.  
  805. No contribution is too small and any contribution would be appreciated.   I 
  806. have only contributed once for a shareware program, and that was for ARC as 
  807. I  use  it  all  the time.   The reason I have  not  contributed  to  other 
  808. shareware programs is I don't use them or only rarely use them.  If you can 
  809. not afford to contribute then use BUP anyway, a backup of hard disk data is 
  810. important to maintain.
  811.  
  812.  
  813.       If  you find a bug in the program then please advise me of it  and  I 
  814. will  try to get it corrected as soon as possible.   The program  has  been 
  815. compiled  without  the  full debug feature (saves 25K) so  if  the  program 
  816. crashes  please include as much information about the option  settings  and 
  817. what  part of BUP was being used when the crash occurred as you  can.   Bug 
  818. reports and any other comments about BUP may be sent to:
  819.  
  820.           D.CHIQUELIN      (GEnie)
  821.           71336,1443       (CIS)
  822.           DCHIQUELIN       (Delphi)
  823.           Sysop            (Atari-O! BBS 402-592-4435 300/1200/2400)
  824.  
  825. Contributions, bug reports or recommendations may be mailed to:
  826.  
  827.           David B. Chiquelin
  828.           501 Woodbine Circle
  829.           Omaha, NE  68128-6040
  830.  
  831.     After April '87 it would be best to send them to my  permanent  address 
  832. of:
  833.  
  834.           16042 Shenandoah Ave.
  835.           Baton Rouge, LA  70817
  836.  
  837.    as I currently am looking for employment and may not remain in the Omaha 
  838. area.
  839.  
  840.  
  841.  
  842.  
  843.  
  844.                           Changes for version 1.1                     8.1
  845.  
  846.      The  Create  new data files feature was added for version  1.1  and  a 
  847. couple of bugs fixed.   One bug could potentially have crashed the  program 
  848. during  backup.   A  minor  bug  that was corrected  had  resulted  in  the 
  849. Examining  HD  window to have the characters write over  each  other  under 
  850. certain   circumstances,   creating  black  blocks  eventually  where   the 
  851. characters  should have been.   With the Create new data files  feature  in 
  852. BUP, no separate utility will be required.
  853.  
  854.  
  855.  
  856.  
  857.  
  858.                           Changes for version 1.2                     8.2
  859.  
  860.      More  bugs were fixed,  including a bug created in ver 1.1 that  would 
  861. not allow the restore function to perform correctly.   More error  checking 
  862. has been added in 1.2 as well.  The Force Backup by path feature is new for 
  863. version 1.2, and now when List file data (with Compare off) is selected you 
  864. may choose any drive, not just drives connected to the ST.  This allows you 
  865. to view or print the file data from another ST or if the HD is turned  off.  
  866. The added error checking during Disk I/O may or may not function  properly, 
  867. depending  on your individual setup.   It has been found that certain  desk 
  868. accessories and 'load and stay resident' programs may cause the program  to 
  869. crash  if  a disk error occurs.   If you have a problem  with  the  program 
  870. crashing  after seeing the System generated alert about "Data in drive  'x' 
  871. may be damaged...",  then try running BUP without desk accessories or other 
  872. programs active.  One accessory that has been shown to cause the problem is 
  873. CONTROL.ACC 
  874.  
  875.  
  876.  
  877.  
  878. Final Notes:
  879.      BUP  works best when used frequently.   If there are a bunch of  files 
  880. that  need backup then it may be better to use another backup program  that 
  881. performs an image backup.  If used frequently the time spent on the backups 
  882. will be short and you will have the peace of mind of knowing your hard disk 
  883. files are protected.  Remember also that BUP only saves the latest revision 
  884. of modified files,  and optionally deletes files from the backup disks that 
  885. have been deleted from the HD.  This keeps the number of disks required for 
  886. BUP  fairly constant,  but requires YOU to save previous versions of  files 
  887. separately if required.   The GEM interface makes using BUP  easy,  without 
  888. having  to remember what commands you need to  enter.   This  documentation 
  889. file  is probably larger than required since you are lead each step of  the 
  890. way by BUP.   If you have only received the documentation for BUP,  then  I 
  891. urge you to obtain the program itself and try it.
  892.  
  893.