home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / h / hardback / !Backup / Docs / Backup < prev    next >
Encoding:
Text File  |  1996-10-26  |  17.0 KB  |  422 lines

  1. HardBack in use
  2. ===============
  3.  
  4. This section gives an in-depth guide to the features present in 
  5. Backup and Restore.
  6.  
  7. Backup
  8. ======
  9.  
  10. Basic overview
  11. --------------
  12.  
  13. When you first load HardBack, an icon is displayed on the iconbar.  
  14. Clicking on this icon will bring up the options window allowing 
  15. you to set various options about the backup, and save and load 
  16. script files.  Once these have been set, a click on Start starts the 
  17. backup operation proper.  This opens the status window which tells 
  18. you how the backup is progressing.  At certain times dialogue 
  19. boxes may appear either asking to make choices, or to do 
  20. something (such as insert a new disc) and click Continue.  Once 
  21. the backup has finish, a short message will be displayed at the 
  22. bottom of the status window.  When this has happened, you can 
  23. start another backup operation by closing the status window and 
  24. clicking on the iconbar icon, which will display the options 
  25. window once again.
  26.  
  27. Starting up
  28. -----------
  29.  
  30. To start up Backup, double click on the !Backup icon in a directory 
  31. display.  A large window will appear which urges you to register 
  32. with the author (see Appendix A for details).  After you have read 
  33. the text in this window, click on Continue to load Backup.  After a 
  34. short pause the icon will appear on the iconbar with the word 
  35. ‘Ready’ underneath it.  This signals that Backup is waiting for you 
  36. to tell it to do something.  If you click Menu over the iconbar icon, 
  37. a short menu will appear.
  38.  
  39.  
  40. Info
  41. ----
  42. This opens a window giving information about the Backup 
  43. program.
  44.  
  45. It also displays the version and serial numbers, which should be 
  46. quoted in all correspondence with the author.  The ‘This program is 
  47. Shareware’ icon is actually a button, which, when clicked on, 
  48. opens a text file giving details on how to register.  It is essentially 
  49. the same as Appendix A in this manual.
  50.  
  51. Quit
  52. ----
  53. This exits the Backup program and removes it from memory.  You 
  54. will be asked if you really want to quit if there is a backup in 
  55. progress.
  56.  
  57. If you click on the iconbar icon the Options window will appear.
  58.  
  59. Options window
  60. ==============
  61.  
  62. This window permits you to change a large number of factors 
  63. which affect what the backup does and how it works.
  64.  
  65. 1  Load target
  66. Drag a script file here to load it into HardBack.  If Shift is held 
  67. down, then any files in the Selected and Ignored windows will be 
  68. cleared before the script file is loaded, otherwise the items 
  69. currently there will remain and the selected/ignored parts of the 
  70. two files will merge.
  71.  
  72. 2 Scrolling section (pane)
  73. This section contains the options themselves and can be scrolled by 
  74. using 3.  It is officially called a pane.
  75.  
  76. 3 Scroll bar
  77. Use this to scroll the scrolling section, as you would any other Risc 
  78. OS window.
  79.  
  80. 4 Reset
  81. This button resets the options to what they were when they were 
  82. last stored - when Start or Update was clicked, or when a script file 
  83. was loaded or saved.  Note that Selected and Ignored files, plus the 
  84. contents of the ‘Only file of type:’ list are stored each time a new 
  85. entry is added, removed, selected or deselected, and so these values 
  86. will not change.
  87.  
  88. 5 Update
  89. This updates the copy of the options stored within the program to 
  90. that shown in the options window.
  91.  
  92. 6 Cancel
  93. This is the same as reset, but it also closes the options window.
  94.  
  95. 7 Start
  96. This is the same as update, but it also starts the backup operation 
  97. described by the options.
  98.  
  99. Scrolling options
  100. -----------------
  101. This is the main part of the options window, which contains the 
  102. icons which allow you to set the criteria by which the backup is 
  103. carried out.  It is divided into several parts:
  104.  
  105. Source/Destination
  106.  
  107. 1  Source box
  108. Dragging a file or directory here will fill in the source icon with its 
  109. name.  Dragging with Ctrl held down will enter the name of its 
  110. parent into the source icon.
  111.  
  112. 2 Source icon
  113. This icon allows you to type in and edit directly the name of the 
  114. source directory or file - i.e. the name of the directory or file to 
  115. copy files from onto floppy disc.
  116.  
  117. 3 Destination icon
  118. This icon allows you to enter and edit the name of the destination 
  119. drive and directory - i.e the drive and directory to back up the 
  120. source onto.  Currently, this must include a drive specifier (e.g :0) 
  121. rather than a disc specifier (e.g :FredsDisc).  However it can 
  122. contain any number of directories - if these are not present on the 
  123. disc they will be created.  It must mention a filing system, which 
  124. must be controlled by FileCore.  This includes most major filing 
  125. systems such as SCSI, ADFS, IDE, RAMFS, but not networks, 
  126. ArcFS or DeviceFS.
  127.  
  128. For example: scsi::5.$.Backups.WorkAug95
  129.  
  130.  
  131. 4 Destination menu icon
  132. This icon opens a pop-up menu containing a selection of possible 
  133. destinations.  It auto-senses how many ADFS floppies and SCSI 
  134. drives are connected and puts only valid items onto the menu.
  135.  
  136. Options
  137. -------
  138. This region permits you to set some of the major, but non-
  139. compulsory options.
  140.  
  141. 1 Selected files
  142. This allows you to choose particular files and directories to 
  143. backup.  They needn’t be in the same directory or even on the same 
  144. drive or filing system.  When this is selected, incremental backups 
  145. are disabled and so 4, 5, 6, and 9 are disabled.  Click on Select... 
  146. to display a window into which you can drag particular files.  
  147. When selected files is used, the source name is not necessary.  
  148. However, it is still stored in the backup file as the ‘parent’ of all the 
  149. files, as if they all came from the same directory, and it is used as 
  150. the default directory when you are restoring the whole backup.  If 
  151. no name is present, Backup.Selections will be used instead.
  152.  
  153. 2 Ignored files
  154. This allows you to opt to ignore certain files and directories that 
  155. you don’t want to be backed up.  The files to ignore can be 
  156. anywhere within the directory structure as long as a parent is 
  157. specified to be backed up; if it is not specified then clearly nothing 
  158. will happen.  If a file or directory is present in both the Selected 
  159. and Ignored windows then it will be ignored.
  160.  
  161. 3 Select.../Ignore...
  162. Clicking either of these buttons brings up a window to which you 
  163. can drag files and directories to respectively choose to backup or 
  164. not to backup.
  165.  
  166. You can select particular items in the same way you would do in a 
  167. Filer window, and clicking Menu over the window brings up a 
  168. menu giving you options to remove files or directories from the 
  169. window.
  170.  
  171. 4 Incremental
  172. This option allows you to backup files that have changed since a 
  173. certain date.  It does not apply to directories; all directories are 
  174. scanned, but their contents will not be backed up if it is older than 
  175. the date specified.  Files which are untyped - i.e have load/
  176. execution addresses rather than a filetype and date stamp will 
  177. always be backed up.
  178.  
  179. 5 Last backup
  180. This option, when Incremental is switched on, will read the date of 
  181. the last backup from the BackupDate file stored in the source 
  182. directory, and back up all file created after the date held within it.  
  183. If a BackupDate file is not present in the source then an error will 
  184. be given when you try to start the backup.  You can check the date 
  185. held in a BackupDate file by loading it into a text editor such as 
  186. Zap or Edit.  It is stored in a human-readable form at the end of the 
  187. file.
  188.  
  189. 6 On/at
  190. This allows you to specify a date and, if necessary, a time, directly 
  191. by typing it into the icons. The date should go in the top icon in the 
  192. form day/month/year, and the time in the bottom as either 
  193. hours:minutes or hours:minutes:seconds.  The year can either be as 
  194. four digits (1998) or as two (98).  If it is as two, then it is assumed 
  195. to be in the 20th century.  Alternatively, dragging a file or directory 
  196. will set the date and time to when it was last saved.
  197.  
  198. 7 Only files of type ...
  199. This option allows you to choose to only backup files of specified 
  200. filetypes, including Impression documents stored as applications.  
  201. The list which contains those filetypes you do want to backup can 
  202. be added to by clicking on the pop-up menu icon to the right (Ç)
  203.  
  204. 8 Only files... pop-up menu
  205. Clicking on this icon opens the menu which contains a list of those 
  206. filetypes you want to backup.  At the top of the menu is a list of the 
  207. filetypes that have been entered already.  You can click on any of 
  208. these and it will toggle whether that type is to be backed up or not.  
  209. If a filetype is to be backed up, its entry will be ticked.  At the 
  210. bottom of the menu is a writeable icon, into which you can enter 
  211. filetypes.  This can either be in the name of the type, such as 
  212. ‘DrawFile’, or its hexadecimal type, such as ‘3FB’.  The entry will 
  213. then be put on the menu and automatically ticked.  The Impression 
  214. option recognises an Impression file as being a directory with a file 
  215. called !DocData inside it.  If you have any directories with 
  216. !DocData files inside them which are not Impression files, then 
  217. they will be backed up.  Also if you have any Impression files 
  218. without !DocData, then they will not be backed up.
  219.  
  220. 9 Write BackupDate file
  221. The BackupDate file is used to store the date of the last backup - 
  222. see Ã Incremental for more details.  If this option is off, a 
  223. BackupDate file will not be created in the source directory.  This is 
  224. useful if you do not intend to do an incremental backup on a 
  225. particular source, or because the source is read only, such as a 
  226. network.
  227.  
  228. 10 Image filing systems...
  229. Under Risc OS 3 only, image files are partitions of a disc which are 
  230. actually a file, but when double-clicked open like a directory - for 
  231. example, PC partitions and ArcFS 2 archives.  This section 
  232. provides three possible ways of backing them up:
  233.  
  234. 1 file: This treats the image file as a file, and backs it up in the 
  235. exact form it is on the disc.  This means you can restore an 
  236. identical copy from either the Entire backup or Selected items part 
  237. of Restore, but you will not be able to access the files inside it 
  238. under Selected items.
  239.  
  240. Directory: This treats it as a directory, and so opens it and backs 
  241. up each of the files inside individually.  In Restore, you can only 
  242. access the contents under Selected items - you cannot restore the 
  243. whole thing in Entire backup, or drag out the image file itself from 
  244. Selected files because HardBack has no way of knowing how the 
  245. original image file was structured.  Restore entire backup will 
  246. simply ignore image files stored in this way.
  247.  
  248. Ignore: This ignores all image files completely.
  249.  
  250. Please note that an image file is only recognised as an image file if 
  251. the relevant software is loaded - for instance,  until ArcFS 2 is 
  252. loaded all ArcFS archives will be treated as normal files.
  253.  
  254. HardBack can cope with files which have names up to 255 
  255. characters long.  However, in Restore under Selected items, the 
  256. directory display may be slightly messed up if they have more than 
  257. 12.  This should have no effect on restoring them.
  258.  
  259. Optimisation
  260. ------------
  261. This section allows you to speed up HardBack to the greatest 
  262. possible extent and produce smaller backup files.  Due to 
  263. compression being missing from this demo version, only one 
  264. option is available.
  265.  
  266. 1 Buffer size
  267. This allows you to expressly set the size of file buffers used when 
  268. reading data from files and copying it into the backup file. 
  269. Basically, the higher this value, the faster the backup proceeds.  
  270. Another way to increase the size of the file buffers is to open the 
  271. Task Manager’s Task Display, and drag the red bar next to 
  272. HardBack (Backup) to the right, thus increasing the memory 
  273. allocation.  For more details see the section Memory Management 
  274. in section 3.
  275.  
  276. Errors
  277. This is a rather small section, containing just one item.
  278.  
  279. 1 Ignore file errors
  280. If this is set HardBack will not warn you about errors concerning 
  281. individual files in the source such as ‘Access violation’, 
  282. ‘Disc error...’ etc.  It will display the error in the messages icon in 
  283. the option window, but will not open a window and ask you to 
  284. click on Continue.  This option is useful if you want to do an 
  285. unattended backup - obviously you don’t want it stopping half way 
  286. through and waiting for you to click on OK.
  287.  
  288. Status window
  289. -------------
  290. Once you have clicked on Start in the Options window, it closes 
  291. and is replaced by the status window.  This window gives you 
  292. information about the backup operation, how it is progressing, and 
  293. any problems that occur.  Clicking Menu over this window 
  294. produces a menu with one item, Stop, which acts the same as 
  295. clicking on the Stop button (11).  Once the backup operation has 
  296. finished, closing this window and then clicking on the iconbar icon 
  297. will take you back to the options window, with the options chosen 
  298. for the backup still there.
  299.  
  300.  
  301. 1,2 Source, Destination paths
  302. These are simply reminders of where the backup is coming from 
  303. and going to.  They are exactly the same as those specified in the 
  304. options window.
  305.  
  306. 3 Backup type
  307. This is a basic reminder of the settings in the options window.  
  308. Each letter or pair of letters stands for a setting which is switched 
  309. on:
  310. S    Selected items
  311. I    Ignored items
  312. i    Incremental:
  313.     l    Last backup
  314.     o    On/at specified date/time
  315. O    Only files of type...
  316. B    Write BackupDate
  317. M    Treat image files as:
  318.     f    One file
  319.     d    Directory
  320.     i    Ignore completely
  321. b    Buffer size set
  322.  
  323. Image files will always be set to something, so this will never be 
  324. empty.
  325.  
  326. 4 Complete
  327. This indicates approximately how much of the backup operation 
  328. has been completed as a percentage.  It is calculated from the file 
  329. sizes of those files done and those files to go, and so may be 
  330. slightly out as regards the time taken to finish; for example, if the 
  331. backup consisted of one 100k file and 200 empty files, then as 
  332. soon as the 100k file had been backed up, Complete would show 
  333. 100% while the backup would continue for some time doing all the 
  334. empty files.
  335.  
  336. 5 Doing disc ...
  337. This displays the number of the current destination disc.
  338.  
  339. 6 ... of ~ ...
  340. This displays the estimated total number of discs.  This is worked 
  341. out in a similar way to Complete, and so may not be exact.  Also, it 
  342. cannot anticipate what capacity discs you will be using, and as a 
  343. result may be slightly inaccurate.  It is calculated using the mix of 
  344. disc capacities you have used so far, and so assumes that you will 
  345. be using the same mix until the end of the backup.
  346.  
  347. 7 Average compression
  348. In the full version, this displays the average size of files after 
  349. compression as a percentage of their original size, but in this demo 
  350. compression is not available, and so it is always 100%.
  351.  
  352. 8 Time to finish
  353. This displays a rough guess at the time that it will take to finish the 
  354. backup.  As with Complete and Doing disc ..., this is an 
  355. approximate figure, and so may not be exact, or count down 
  356. precisely in seconds.  For the first few files, you should ignore this 
  357. value as it will often be ludicrously high - this is simply due to 
  358. inaccuracies in timing, which are evened out after the first few 
  359. files.
  360.  
  361. 9 Currently doing
  362. This shows the file or directory that is currently being backed up.
  363.  
  364. 10 Messages bar
  365. This bar shows any other messages which are reported from the 
  366. backup.  In the screenshot above it is displaying the compression 
  367. ratio for a particular file (this is irrelevant in this version, which 
  368. does not have compression).  It can also be used to report errors 
  369. and tells you which files are too old to be backed up in an 
  370. incremental backup.
  371.  
  372. 11 Stop button
  373. This button stops the backup completely.  Generally if the backup 
  374. is stopped in this way then it will still be readable in the Entire 
  375. backup part of Restore, but obviously only up until the point it was 
  376. stopped.
  377.  
  378. 12 Pause button
  379. This button pauses the backup.  All disc activity stops, although 
  380. files are still left open.  The word ‘Pause’ changes to ‘Continue’, 
  381. and so to carry on with the backup you must click on this icon 
  382. again.
  383.  
  384. Request window
  385. --------------
  386. This window gives you simple prompts such as ‘Insert blank disc X 
  387. into drive Y’ or ‘Please wait, formatting disc.’.  While it is on the 
  388. screen the backup is paused.  If you click Menu over it, a menu is 
  389. produced which acts identically to the menu produced when Menu 
  390. is clicked over the status window.
  391.  
  392. Query window
  393. ------------
  394. This window asks you questions which mostly involve handling of 
  395. discs.  A menu identical to that mentioned above is produced when 
  396. you click Menu over it.
  397.  
  398. There are a number of messages that can be given that need 
  399. explaining:
  400.  
  401. Disc is not blank - Erase contents?
  402. This means there is some space free on the disc.  If you click OK 
  403. the disc will be wiped, while if you click Cancel, the files will be 
  404. left as they are and the backup files added to them. This will 
  405. obviously means that you can get less data on a disc which is not 
  406. blank.
  407.  
  408. Disc is full - erase contents?
  409. This is different from the above error, because it means the disc is 
  410. absolutely full, and there is not even room to create the backup file.
  411. Clicking OK will wipe the disc, while Cancel will prompt you to 
  412. insert another disc.
  413.  
  414. Error: xxxxx. Do you want to continue using this disc?
  415. This is used to report errors such as ‘Disc is write-protected’.  
  416. Click OK to try again or Cancel to use another disc.
  417.  
  418. Error: xxxxx. Format disc?
  419. This is used to report errors such as ‘Disc not understood - has it 
  420. been formatted’.  Click OK to format the disc or Cancel to use 
  421. another.
  422.