home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / s1 / sparkinfo / !SparkInfo / !Help < prev    next >
Text File  |  1993-01-13  |  14KB  |  293 lines
  1. -> !SparkInfo.!Help 2.20 - 13-01-93 - Paul John Murphy
  2. Copyright © 1990,1991,1992,1993 Murphsoft - Paul John Murphy
  3.  
  4. Read this document carefully before using SparkInfo.
  5.  
  6. Program Description
  7. ===================
  8.  
  9. SparkInfo is an application which I have written to provide quick analysis
  10. of an Archive. The program *should* cope with anything which Spark (up to
  11. version 2.14) can create, and is based on information included with Spark on
  12. the format of Archive files. The program *should* work on any Acorn
  13. Archimedes.
  14.  
  15. Program Purpose
  16. ===============
  17.  
  18. To provide full information on files in an archive, even if it is corrupt or
  19. truncated, and to aid recovery of files from a corrupt or truncated archive.
  20.  
  21. Program Distribution
  22. ====================
  23.  
  24. SparkInfo may be freely distributed, providing that the contents of the
  25. archive remain the same, and no files are added to or modified in the
  26. archive. The actual archiving method may be changed, as I have no desire to
  27. force people to use Spark (even although it is excellent). I reserve all
  28. other rights to SparkInfo, and it remains Copyright © 1990,1991,1992,1993
  29. Murphsoft - Paul John Murphy. This software costs nothing, but I still
  30. retain all rights to it. This type of software is often called freeware, and
  31. it is NOT the same as public domain (PD).
  32.  
  33. The distribution archive should contain the following files:
  34.      Filename               Length   
  35.      --------               ------
  36.      !!ReadMe!!             77 bytes
  37.      !SparkInfo.!Boot       282 bytes
  38.      !SparkInfo.!Help       14389 bytes
  39.      !SparkInfo.!Run        663 bytes
  40.      !SparkInfo.!RunImage   28847 bytes
  41.      !SparkInfo.!Sprites    2364 bytes
  42.      !SparkInfo.!Sprites22  4496 bytes
  43.      !SparkInfo.Messages    3590 bytes
  44.      !SparkInfo.ORunImage   4049 bytes
  45.      !SparkInfo.Sprites     4712 bytes
  46.      !SparkInfo.Sprites22   9192 bytes
  47.      !SparkInfo.Templates   5341 bytes
  48.  
  49. The original distribution archive was created using Spark 2.14 in Compress
  50. 16-bit mode.
  51.  
  52. ORunImage is the only non-essential file, and is v0.03 of SparkInfo which is
  53. non-multitasking, in BASIC, and does not use the wimp. It may be of use to
  54. some as an aid in recovering corrupt Sparkives.
  55.  
  56. If you are short of space, then the 22 variants of the Sprite files may
  57. safely be removed from your working copy (or used to replace the ordinary
  58. sprite files). However, the software must not be passed on without these
  59. files, under any circumstances.
  60.  
  61. Program Guarantee
  62. =================
  63.  
  64. Sorry, no guarantee (of any sort), if the program works, and saves your
  65. life, great, I'm happy for you. If the program fails miserably, crashing
  66. your machine, and trashing your hard disk, then hard luck, but not my
  67. problem. The program works fine on my machines (A400/1 series, 4Mb RAM, 40Mb
  68. ADFS hard disk, 46Mb SCSI hard disk, RISC OS 3.10; & A4, 4Mb RAM, 60Mb IDE
  69. hard disk, RISC OS 3.10), and may work on others.
  70. Unfortunately, I can no longer test under RISC OS 2, so correct operation is
  71. even less guaranteed there!
  72.  
  73. Disclaimer
  74. ==========
  75.  
  76. I accept no responsibility for ANY problems with this software, or any
  77. problems which this software may create.
  78. Use is entirely at the risk of the user.
  79.  
  80. Instructions
  81. ============
  82.  
  83. SparkInfo is loaded by double-clicking on the application, and will do no
  84. more than initialise and install itself on the icon-bar at this point. To
  85. examine an archive, simply drag the file onto the SparkInfo icon (a spark on
  86. top of a question mark), and a window will open with the first entry in the
  87. archive being displayed.
  88. Moving between files in the archive is done by clicking one of the
  89. tape-recorder style icons at the top-left of the SparkInfo window. The
  90. tape-recorder icons perform the following tasks (from left to right): start,
  91. back, forward, end. Clicking SELECT on one of the icons performs that
  92. action, and clicking ADJUST on one of the icons performs the opposite of
  93. that action. There is also an option on the window menu to jump straight to
  94. an individual file in the archive, if you know which it is relative to the
  95. start (it is Goto=>File number).
  96. You can also work with files in "offset mode". This is automatically entered
  97. when you jump to a file by its offset (Goto=>Offset on the window menu).
  98. Only the forward and start icons work in offset mode. Offsets are to the
  99. archive marker character, from the start of the file.
  100. You can save an individual file in a Sparkive by going to it (ie making it
  101. the one being displayed), and using the save option on the window menu. It
  102. will be saved as a Sparkive containing one entry (the file being examined
  103. when save was selected).
  104. SparkInfo may be terminated in the usual way (i.e. Quit on the Icon-Bar
  105. Menu).
  106. Once loaded, SparkInfo will try to grab any double-clicks on a file of type
  107. &DDC, and act as if the file was dragged onto its icon. Also, if the RunType
  108. environment variable is not set, then it will be set load SparkInfo when a
  109. file type &DDC is executed.
  110. When a Sparkive is opened (ie the SparkInfo window is open), the archive
  111. headers may be altered. This can be done by turning off the "Safe" option
  112. (using either the window icon, or the menu option), and simply changing the
  113. values as required. Once the header has been updated as desired, it can be
  114. written back to the Sparkive by choosing the "Write" option.
  115. It is possible to do basic searches for files within Sparkives, based on
  116. combinations of the information which can be displayed about a file within a
  117. Sparkive. This is achieved using the Find menu option. The "Master Find
  118. Spec" field is used to specify which of the other fields should be
  119. considered in the search. If a field is included in the search, then it must
  120. be EXACTLY matched for the a particular file to be found. "Go" will find the
  121. first file after the current position in the Sparkive, using the movement
  122. method selected (Headers/Search). "Count" will count the number of files
  123. after the current position matching the search specification.
  124.  
  125. Comments
  126. ========
  127.  
  128. I wrote this program because I had a corrupted archive, and wished to
  129. recreate as much of the contents as I could. The archive turned out to be
  130. truncated, so I ended up making it the right length, with the correct
  131. format, and this enabled Spark to accept it, so I could get all but the last
  132. file (the one short of data) back. I leave it up to you to solve your own
  133. problems, but hope that SparkInfo is helpful to you.
  134. Information on the archive file format can be found in the !ReadMe for Spark
  135. on the Spark disk from David Pilling (Spark's author and the only source of
  136. Spark at the moment). SparkInfo is probably only of use to the more
  137. technically minded, so please remember that if something is not broken, then
  138. you cannot fix it, and should not attempt to do so.
  139. I may in future improve SparkInfo to make it have an attempt at fixing
  140. broken archives, as far as possible, but this and any other support is not
  141. guaranteed.
  142. Sub-directories of Archives (just an Archive within an Archive, effectively)
  143. are not dealt with, just ignored. If you want info on a sub-directory, then
  144. it must be extracted to a "normal" filing system, and then have SparkInfo
  145. run on it (cannot easily be done with Spark, but is easy with Arc).
  146. Alternatively, you can tell SparkInfo to go to the archive data offset for
  147. the archive sub-directory in question, and this will allow examination of
  148. the sub-directory, although some of the normal movement functions will not
  149. be available.
  150. SparkInfo in "Safe" mode only opens archives for input (i.e. OPENIN), so
  151. should not corrupt or modify in any way any archive passed to it, unless
  152. instructed to do so by the user.
  153. Offsets are relative to the start of the file.
  154. Only one archive may be open under SparkInfo at a time.
  155. SparkInfo will only touch files of type DDC (Archive).
  156. If any items displayed in the main SparkInfo window seem duplicated, or in a
  157. strange order, then that is because they appear in that order in the archive
  158. header.
  159. SparkInfo knows nothing of the new ArcFS format which is probably a better
  160. format from certain points of view.
  161. SparkInfo also knows nothing of the Computer Concepts Compression format.
  162. When I refer to a Sparkive, I basically mean an archive file which Spark is
  163.