home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / d / discedit / !DiscEdit / !Help next >
Text File  |  1995-10-20  |  11KB  |  246 lines
  1. Disc Sector Editor © Chris Poole, 1995
  2. --------------------------------------
  3.  
  4. Note:  This documentation was rather hurriedly put together.  I
  5. will write some more complete documentation when I have time, but
  6. in the mean time, email cep20@cam.ac.uk with any questions.  More
  7. contact details are in the licence file.
  8.  
  9. 0. Licence and Disclaimer
  10. -------------------------
  11.  
  12. This program is SHAREWARE, it is NOT public domain.  You are
  13. permitted to use it for a period of one month, after which time
  14. you must register the software, as described below.
  15.  
  16. You may freely distribute this unregistered version as long as no
  17. charge other than the cost of the distribution media is made.  It
  18. may be distributed by any means, including floppy disc, CD-ROM,
  19. Internet FTP, E-mail, and through a Bulletin Board.
  20.  
  21. The software is copyright Chris Poole, 1995 and must only be
  22. distributed unaltered, and complete with all the accompanying
  23. documentation.
  24.  
  25. For registration details, please see the licence file.
  26.  
  27. This software is supplied 'as is', with no guarantee of its
  28. suitablity for any purpose.  The author cannot accept resposibility
  29. for any loss or damage caused by the use, or mis-use, of this
  30. software or its documentation.
  31.  
  32. 1. Selecting a disc
  33. -------------------
  34.  
  35. Editing a particuar filing system and drive
  36. -------------------------------------------
  37.  
  38.     Clicking on the icon bar, shows the filing system select 
  39. window.  All the FileCore based filing systems are shown in the
  40. left-hand list, the drives for the current filing system are shown
  41. to the right.  Any drives present but unreadable are shown greyed
  42. out.  The Re-read button will update the list, if discs are inserted,
  43. etc.
  44.  
  45.     Having selected a filing system and drive, clicking the OK 
  46. button will open the main disc editor window.  If the drive cannot be 
  47. read, an error is reported.
  48.  
  49.     !DiscEdit can edit all FileCore discs, old or new format, but 
  50. many utilities are only available for new map discs.  A warning 
  51. message will be displayed if an old-map disc is edited.
  52.  
  53. Starting editing at a particular file
  54. -------------------------------------
  55.  
  56.     If a file or directory is dragged to the !DiscEdit icon, or to the 
  57. disc editor window if open, the program will attempt to locate the 
  58. file and open the main editor window at that location.
  59.  
  60.     If the file is zero bytes long, or it is in an Image filing system 
  61. (such as ArcFS, SparkFS, DosFS) a warning will be displayed and the editor
  62. window will be opened at the first sector.
  63.  
  64.     If the file is dragged from a non-FileCore filing system (such as 
  65. Resources:), an error is reported and the editor window is not 
  66. opened.
  67.  
  68. ZapRedraw support
  69. -----------------
  70.  
  71.     The disc editor software will make use of the ZapRedraw 
  72. module supplied with the FreeWare editor !Zap to speed up the 
  73. redraw of the main editor window.  !DiscEdit will attempt to load 
  74. the module if !Zap has been seen by the filer.
  75.  
  76.     If you do not have a copy of !Zap, the editing window will re-
  77. draw more slowly.    
  78.  
  79. 2. Disc Editor Operations
  80. -------------------------
  81.  
  82. Moving around the disc
  83. ----------------------
  84.  
  85.     The tool bar at the top of the window is used to navigate around 
  86. the disc.
  87.  
  88.     The chunk icons step through the disc by allocated chunk.  
  89. Chunks can contain single files or directories, or they may contain a 
  90. directory and a number of files − they are the basic unit of space 
  91. allocated from the disc map.  The ID icon shows the chunk ID for 
  92. the current sector.  It may show '*Free*' if the chunk is free space, or 
  93. '*NoMap*' if the you are editing an old-format disc.
  94.  
  95.     The sector icons step through by individual sectors − the 
  96. current disc address is shown below the icons.  The 'Follow ID' 
  97. button forces !DiscEdit to follow a fragmented file when the sector 
  98. icons are used.  If 'Follow ID' is not selected, the sector icons move 
  99. forward and backward through the disc from beginning to end.  
  100. When 'Follow ID' is used, the editor is constrained to the individual 
  101. chunk currently being edited.  If the chunk is fragmented into more 
  102. than one area, the editor will automatically move to the next section 
  103. if the sector forward icon is clicked at the end of the first.
  104.  
  105.     The data in the selected sector can be edited in hex or ASCII by 
  106. clicking to place the cursor at the appropriate point, and typing over 
  107. the data.  The arrow keys can be used to move around the sector and 
  108. pressing TAB will switch between hex and ASCII editing.  To re-
  109. write the sector, use the 'Update' icon.  To discard the edited sector, 
  110. use the 'Re-read' icon.
  111.  
  112. File type icon
  113. --------------
  114.  
  115.     The recessed icon on the tool bar shows !DiscEdit's guess 
  116. at the file type for the current sector, it is blank if the file type is 
  117. not known.  Types can normally only be determined when the editor is
  118. positioned at the start of the file in question.  The following file types
  119. are currently identified by !DiscEdit.
  120.  
  121. 10B    Symphony    3C1    TwEffect    3D6    StrHelp
  122. 3FB    ArcFSArc    406    Accounts    695    GIF
  123. AE7    ARMovie        AE9    Alarms        AED    SheetMc
  124. AEF    Sheet        AF1    Maestro        AFF    DrawFile
  125. BC5    ImpDoc        BCF    TbleMate    BD5    Envelope
  126. BD6    AudioWrk    BD7    HyprDict    BE9    SWorkSp
  127. C00    Rhapsody    C0C    SMacro        C26    ASheet
  128. C4B    CmprDraw    C55    DrumSeq        C6A    smArt
  129. C7F    Titler        C85    JPEG        CC3    Poster
  130. CDD    Ovation        D83    Ignore        D84    UserDict
  131. D8E    ABIDefs        D94    ArtWork        FAE    Resource
  132. FB1    Wave        FB2    AVI        FC8    DOSDisc
  133. FCA    Squash        FCF    Cache        FD4    MIDI
  134. FEA    Desktop        FF0    TIFF        FF5    PoScript
  135. FF6    Font        FF8    Absolute (AIF)    FF9    Sprite
  136. FFB    BASIC        FFD    Data (AOF)
  137.  
  138.     More types will be implemented if I can find example files -
  139. the Acorn User CD-ROM was very helpful in implementing the current
  140. selection.
  141.  
  142. Menu functions
  143. --------------
  144.  
  145.     Clicking the menu button over the editor window opens the 
  146. menu shown below.  The middle section of the menu allows you to 
  147. go to the disc map, the root directory, to any specified address, or to 
  148. a particular file ID.
  149.  
  150.     At the top of the menu are utilities for map zones and 
  151. directories.  These are only enabled if the editor is opened at a map 
  152. sector, or at the start of a directory.
  153.  
  154.     'Calc map checksum' calculates the checksum for the currently 
  155. selected zone of the disc map.  This is necessary if the zone has been 
  156. altered to prevent FileCore thinking the data is invalid.  It can also 
  157. be used to repair map zones.
  158.  
  159.     'Directory functions' leads to a sub-menu of operations that can 
  160. be carried out on directories.  This option is only available when the 
  161. file type icon shows the current sector as a directory.
  162.  
  163.     The 'Diagnostics' option performs several checks on the 
  164. integrity of the directory and reports on its findings.  It is useful in 
  165. determining the cause of 'Broken Directory' errors.  The checks 
  166. performed on the directory are:
  167.  
  168.     ·    Two copies of the master sequence number agree
  169.     ·    Directory checksum correct
  170.     ·    Two copies of directory entries agree
  171.  
  172.     The figure below shows an example of the output from 
  173. 'Directory diagnostics' for a directory which has a corrupt entry.  
  174. You can see clearly from the list of differences between the first and 
  175. second copy of the entries that entry 1 in the first copy is corrupt.  
  176. The function has also pointed out that the checksum is incorrect, 
  177. indicating that there is something wrong.
  178.  
  179.     Recommended actions are shown in the window and you would 
  180. probably now use the 'Restore from 2nd copy' option to correct the 
  181. corruption of 'Accounts95'.  If the 2nd copy seems incorrect, you would
  182. only need to correct the checksums as RISC OS only _reads_ the first
  183. copy.
  184.  
  185. +-------------------------------------------------------------------------------+
  186. | Directory Diagnostics                                    |
  187. |                                                 |
  188. | First master sequence number: 02                            |
  189. | Second master sequence number: 02                            |
  190. | Master sequence numbers tally.                             |
  191. |                                                  |
  192. | Checksum in buffer: C7                                     |
  193. | Correct checksum: C9                                                          |
  194. | Checksum INCORRECT - use 'Correct checksums' option.                          |
  195. |                                                                               |
  196. | Second copy of directory entries disagrees                                    |
  197. |   This may or may not cause a problem, depending on