home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / r / realcount / !RealCount / !Help < prev    next >
Text File  |  1995-09-19  |  10KB  |  250 lines
  1.                   ==========================================
  2.                   RealCount (1.01)  - Improved Desktop Count
  3.                   ========= (C) Sergio Monesi 1995 =========
  4.                   ==========================================
  5.  
  6. RealCount provides a desktop Count facility similar to the Filer but, unlike
  7. Filer, shows the real disc space that the counted directory uses together
  8. with a number of other useful statistics.
  9. RealCount can be used as a stand-alone application alongside the standard
  10. RISC OS Count or also as a complete Count replacement.
  11.  
  12. RealCount requires RISC OS 3.10 or later (it has been fully tested on Risc PC
  13. 600 and should work on Risc PC 700 and 'big' discs) and supports interactive
  14. Help.
  15.  
  16. RealCount is FREEWARE. See 'Conditions of use' for more info.
  17.  
  18.  
  19. Index
  20. -----
  21.  
  22. - Introduction
  23. - Using RealCount
  24. - Customizing the display
  25. - Disclaimer
  26. - Bugs and Limitations
  27. - History
  28. - Credits
  29. - Conditions of use
  30. - Contacting the Author
  31.  
  32.  
  33. Introduction
  34. ------------
  35.  
  36. The standard RISC OS Count window shows only the number of files and their
  37. total length. This is good when counting single files but when counting
  38. directories it could be more useful to know the real disc space used by the
  39. directory, not only the total length of the files it contains.
  40.  
  41. In fact, on E-Format discs (ie floppies, hard discs and RAM disc but not
  42. archives, for example) a directory uses a fixed space (2048 bytes) but
  43. because of the organisation of the disc map it usually eats up some extra
  44. space that can be used by small files stored in it.
  45.  
  46. Moreover, because of the sectors boundaries and disc map constraints, some
  47. extra disc space is wasted at the end of the various files (eg on a disc with
  48. 512 bytes sectors, a 513 bytes file uses 1024 bytes of disc space).
  49.  
  50. RealCount has been designed to display all these informations so that you can
  51. know exactly how much disc space your directories use. Moreover, RealCount is
  52. much faster than the standard Count.
  53.  
  54. If you want to know more about the E-Format map structure you can read the
  55. file 'MapExpl' included in the RealCount distribution archive.
  56.  
  57.  
  58. Using RealCount
  59. ---------------
  60.  
  61. If RealCount has been configured to replace the standard Filer's Count (see
  62. "Configuring RealCount") you can just ignore RealCount's existence and just
  63. use the Filer: when you choose 'Count' from the Filer's menu you will get a
  64. RealCount window instead of a standard Filer one.
  65.  
  66. Alternatively, to count a file or a directory just drag it to the RealCount
  67. icon on the iconbar. To count a directory you can also drag the RealCount
  68. icon from the iconbar to a Filer window (so that, for example, you can easily
  69. count the whole content of a disc counting its root directory).
  70.  
  71. A window, very similar to the standard Filer Count, will be opened and the
  72. count will proceed as expected. You can pause or abort it, make it run faster
  73. or remove the window until the count is finished using the menu: it will
  74. behave exactly like a standard Count window.
  75.  
  76. Once the count is finished the window can be enlarged (or is automatically
  77. enlarged, see "Configuring RealCount") and the extra statistics revealed:
  78. - Files: this shows the number of files and their total length, as shown by
  79.   the standard Count
  80. - Directories: this shows the number of directories and the space they uses
  81.   (ie number of directories multiplied by 2048)
  82. - Wasted sectors: this is the disc space wasted because of unused shared map
  83.   chunks. A detailed description of the reasons of this space is beyond the
  84.   scope of this file: it seems enough to say that this space is caused by the
  85.   organisation of the disc map and can be filled only by small files.
  86. - Sectors rounding: this is the space wasted because of sectors boundaries
  87.   and disc map constraints. This space cannot be recovered.
  88. - Total: this is the sum of the values above and is the total space used by
  89.   the counted directory.
  90.  
  91. Beside the values in bytes there are either the percentages or the sizes in
  92. megabytes or kilobytes. Click on them to switch between these two displays.
  93.  
  94. RealCount also works on discs that are not E-Format and on Image files
  95. although it will just perform like a common Count (but faster).
  96.  
  97.  
  98. Configuring RealCount
  99. ---------------------
  100.  
  101. The iconbar menu includes an 'Options' submenu that allows to configure the
  102. following features:
  103. - Replace Filer: when selected the user Filer's Count will be replaced by
  104.   RealCount.
  105. - Auto-enlarge window: when selected the RealCount window will be
  106.   automatically enlarged when the count operation is finished (so that the
  107.   various statistics are shown). When this is not selected, a RealCount
  108.   window will look exactly like a Filer's Count one except the fact that you
  109.   can enlarge it to see the extra statistics.
  110. - Show percentages: when selected the RealCount window will show by default
  111.   the percentages of the statistics besides their size in bytes. Otherwise
  112.   the sizes in megabytes or kilobytes are displayed.
  113. - Install iconbar: choose whether RealCount will install itself on the
  114.   iconbar or not.
  115.  
  116. When RealCount is not installed on the iconbar you can obtain the 'iconbar'
  117. menu (thus the 'Options' menu) from every RealCount window using the 'Shift'
  118. key (ie if 'Shift' is depressed while you try open the window's menu, the
  119. iconbar menu will appear instead).
  120.  
  121. Note that you cannot unselect both 'Replace Filer' and 'Install iconbar',
  122. otherwise there will be no way to access RealCount!
  123.  
  124. Selecting 'Replace Filer' and unselecting both 'Auto-enlarge window' and
  125. 'Install iconbar' will allow you to have a Filer's Count raplacement that
  126. will just perform faster than the original one but will also provide extra
  127. statistics if you enlarge the Count window after the end of the count
  128. operation.
  129.  
  130.  
  131. Customizing the display
  132. -----------------------
  133.  
  134. In the current version the only way to configure the displayed icons is to
  135. edit the "Messages" file inside the RealCont application. Try to load it into
  136. an editor and read the instruction at the beginning of the file.
  137.  
  138. Another way to configure the display is to edit the window defined in the
  139. "Templates" file using a template editor. You can change the size of the
  140. window or move the icons as you like but remember not to change the icon
  141. numbers!
  142.  
  143.  
  144. Disclaimer
  145. ----------
  146.  
  147. In normal operations RealCount is not a dangerous program since it doesn't write
  148. anything to the disc, it just reads it.
  149.  
  150. If for any reason (either your mistake or a bug in RealCount) it causes you a
  151. loss of data, I am sorry for you but I WILL NOT BE HELD RESPONSIBLE.
  152.  
  153. Use RealCount at your own risk.
  154.  
  155.  
  156. Bugs and Limitations
  157. --------------------
  158.  
  159. If you drag the iconbar icon to a window whose title starts with a filename
  160. (eg. an editor window), RealCount will count it. This is probably more a
  161. feature than a bug, though! :-)
  162.  
  163. Most of the memory used by RealCount is allocated dynamically but a small
  164. part isn't. This means that on RISC OS 3.10 there is a limit to the number of
  165. window open at the same time: this limit can be enlarged by changing the
  166. WimpSlot setting in the !Run file to a value larger than the current one.
  167. Thanks to dynamic areas this limitation doesn't apply to RISC OS 3.50 or
  168. later.
  169.  
  170.  
  171. History
  172. -------
  173.  
  174. 1.00  -- 29 Jun 95
  175. First fully working version. Released only to a few friends.
  176.  
  177. 1.01  -- 19 Sep 95
  178. Added Filer's Count replacement. RealCount should now work on big discs (ie
  179. disc larger than 512Mb handled by the new FileCore module). 
  180.  
  181.  
  182. Credits
  183. -------
  184.  
  185. I'd like to thank the following people who contibuted in some way to the
  186. development of RealCount:
  187. - Nick Craig-Wood who encouraged me to write this program since he said that
  188.   it was easy to replace the Filer's Count window... I followed his
  189.   suggestions and it seems to work fine! Thanks for part of the text in this
  190.   !Help file, too.
  191. - Martin J Ebourne for his memory allocation functions and list management
  192.   functions.
  193. - Jason Williams (and all the other collaborators) for DeskLib.
  194. - Martin Wuerthner for his suggestions
  195.  
  196.  
  197. Conditions of use
  198. -----------------
  199.  
  200. RealCount (the Software) is Copyright (C) Sergio Monesi 1995 (the Author) and
  201. may not be used or copied except as in accord with the terms and conditions
  202. below.
  203.  
  204. You may NOT Make t