home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / new / util / wb / qdisk / qdisk.doc < prev    next >
Text File  |  1994-05-18  |  22KB  |  472 lines
  1.  
  2.   Q D I S K (Query  Disk)
  3.   ~~~~~~~~~~~~~~~~~~~~~~~
  4.   Version      : 2.11
  5.   Written By   : Norman Baccari
  6.   Compiler     : SAS/C V6.51
  7.   Program Icon : John Waszczak
  8.   Interface    : GadToolsBox 37.300 © Jaba Devlopement.
  9.   COPYRIGHT    : © 1993-94 Norman J. Baccari
  10.   Distribution : FREEWARE. "Its Not PD, But Its FREE!"
  11.  
  12.  
  13.   /~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
  14.  /                           DISTRIBUTION                           \
  15. /                                                                    \
  16. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  17. NO WARRANTIES ARE MADE.  ALL USE IS AT YOUR OWN RISK.  NO LIABILITY OR
  18. RESPONSIBILITY  IS ASSUMED.  QDisk is NOT public domain.  QDisk may be
  19. freely  distributed as long as the there are no charges other than for
  20. media and / or mailing, the program is not used for commercial gain or
  21. included  as  part  of  any other software without permission from the
  22. author,  and  the  program  and  the  documentaion file remain intact,
  23. unalterd and distributed together.  QDisk is classed as FREEWARE.  All
  24. I  ask,is  that  you  let  me  know  of any problems or bugs you might
  25. encounter,  or  just  let me know what features you think QDisk should
  26. have.
  27.  
  28. The following files make up the distribution for QDisk...
  29.  
  30.   QDisk                     Main program.
  31.   QDisk.doc                 Standard text documentation.
  32.   QDisk.guide               AmigaGuide format documentation.
  33.  
  34.  
  35.   /~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
  36.  /                        WHAT IS QDISK?                            \
  37. /                                                                    \
  38. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  39. QDisk  provides  you  with the ability to monitor, from WorkBench, the
  40. space  usage of all AMIGA DOS disk volumes that are currently mounted.
  41. QDisk can also send you a notification using a standard requester or a
  42. recoverable  alert  when  usage  exceeds  a  limit  set by you.  QDisk
  43. requires WB2.04 or higher.
  44.  
  45.  
  46.   /~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
  47.  /                       NEW FOR QDISK V2.11                        \
  48. /                                                                    \
  49. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50. ° This is a maintenance version and minor bug fix.
  51. ° Removed and enforcer hit.
  52. ° Made a few optimizations.
  53. ° Binary now about 9% smaller.
  54.  
  55.  
  56.   /~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
  57.  /                    PREVIOUS QDISK USERS NOTE!!                   \
  58. /                                                                    \
  59. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  60. As I had to restructure the preferences format, prefs prior to  v2.10
  61. will be ignored and not loaded. I apologize for this inconvenience.
  62.  
  63.  
  64.   /~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
  65.  /                            MAIN WINDOW                           \
  66. /                                                                    \
  67. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  68. To  use QDisk simply double click on the program icon or you can place
  69. QDisk  in  you  WBStartUp drawer.  You will then be presented with the
  70. main window on the WorkBench or public screen that you have specified.
  71. In it will be a list of DOS volumes that are currently mounted.  There
  72. are   4   columns   starting  from  "Usage", "DevName", "VolName"  and
  73. "FreeBytes".   By simply clicking once on one of these lines, a detail
  74. window will open showing more information on that particular volume.
  75.  
  76. Iconifying QDisk
  77. ~~~~~~~~~~~~~~~~
  78. In  the  upper  right  corner  there is a small square gadget with the
  79. letter  "I"  in it.  Clicking on this will cause QDisk to iconify.  To
  80. un-iconify,  activate  the iconified window by clicking once on it and
  81. then click the right mouse button.
  82.  
  83. Menus
  84. ~~~~~
  85. The menu options from the main window are as follows...
  86.  
  87.    Menu Item                      Description
  88.    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  89.    Graph           : Calls up graph usage window.
  90.    Iconify         : Iconifies Disk.
  91.    Preferences
  92.       Notify       : Prefs editor for notification of drive usage.
  93.       General      : Prefs editor for QDisk general preferences.
  94.       Load         : Load current preferences settings.
  95.       Save         : Save current preferences settings.
  96.    About           : Author/program info
  97.    Quit            : Quit QDisk
  98.  
  99. Keeping Up To Date
  100. ~~~~~~~~~~~~~~~~~~
  101. QDisk  reads  the  systems  DOS  device/volume lists to update itself.
  102. Updates  happen  whenever  a  disk is removed or inserted, or the main
  103. window  is made active.  Optionally, you can set updates to take place
  104. by  activating  the  timer  and  setting  the  timer interval from the
  105. general preferences editor.
  106.  
  107.  
  108.   /~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
  109.  /                          DETAIL WINDOW                           \
  110. /                                                                    \
  111. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  112. When  you  select  one  of  the  drives from the main windows listview
  113. gadget  by  clicking on it, you will be presented with a detail window
  114. with  information on the drive you selected.  Across the bottom of the
  115. window  there is a graphic bar that indicates the space usage based on
  116. percent.
  117.  
  118.  
  119.   /~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
  120.  /                          GRAPH WINDOW                            \
  121. /                                                                    \
  122. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  123. Selecting  "Graph"  from  the main menu will provide you with a window
  124. that  has  a  bar  graph or "gas gauge" representing each drives space
  125. usage.   If  there are more than 10 drives mounted on your system then
  126. you  can  use  the  scroll  bar  on  the right of the window to scroll
  127. through your drives.
  128.  
  129.  
  130.   /~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\
  131.  /                        GENERAL PREFERENCES                       \
  132. /                                                                    \
  133. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  134. Windows
  135. ~~~~~~~
  136. This  group  of  gadgets allows you to set the TopEdge and LeftEdge of
  137. all the windows or you can manually enter values for TopEdge/LeftEdge.
  138. Or,  if  the  window is currently open, you can take a snapshot of it.
  139. These  values  will  be  used next time you boot QDisk.  If you try to
  140. snapshot  a  window  thats  not  open it will be ignored.
  141.  
  142.  
  143. Bar Graph Pens
  144. ~~~~~~~~~~~~~~
  145. This  group  of  gadgets allows you to set the pen colors for all the
  146. bar graphs. The front pen is used for the actual bar render, the back
  147. pen for a background to the bar and the text pen is the color of the
  148. text in the bar.
  149.  
  150.  
  151. Miscellaneous Prefs
  152. ~~~~~~~~~~~~~~~~~~~
  153.    Priority
  154.    ~~~~~~~~
  155. The  priority  for  QDisk  can  be  altered by +/- 3.  Use this option
  156. keeping  in  mind  that  this will effect either QDisks performance or
  157. your overall system performance. Good values would be +/- 1.
  158.  
  159.    Sort Device Names
  160.    ~~~~~~~~~~~~~~~~~
  161. This will sort device names in ascending sequence.
  162.  
  163.    Show Free Bytes AS Mb/Kb
  164.    ~~~~~~~~~~~~~~~~~~~~~~~~
  165. This  will  format  the  free bytes into Kilobytes/Megabytes.  Keep in
  166. mind that a kilobyte is 1,024 bytes and a megabyte is 1,048,576 bytes.
  167. This  should  be mentioned as there will be a difference between space
  168. expressed as bytes vs Mb/Kb.
  169.  
  170.    Start Iconified
  171.    ~~~~~~~~~~~~~~~
  172. If activated, QDisk will start up in an iconified state.
  173.  
  174.    Update Every...
  175.    ~~~~~~~~~~~~~~~~
  176. This  will  cause  QDisk  to  be updated using the timer device at the
  177. interval  that  you  specify  in  seconds.   The minimum interval is 5
  178. seconds,  and  maximum  interval  is  999 seconds.  Updates are always
  179. performed  when  a  disk is inserted or removed, or the main window is
  180. activated. (See also "Considerations For Timed Notifications").
  181.  
  182.    Mark When...
  183.    ~~~~~~~~~~~~
  184. This  will  cause  QDisk  to