home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / misc / cpuload / !CPUload / !Help next >
Text File  |  1994-04-11  |  6KB  |  140 lines
  1.  
  2.                         CPU Load Average Monitor
  3.                         ========================
  4.  
  5.  
  6. Documentation for !CPUload desktop utility version 2.50 27-Feb-1994.
  7.  
  8. Issue: 2.50  28-Feb-1994, replaces:     0.10 24-Mar-1991
  9.                                         1.00 25-Mar-1991
  10.                                         2.00 08-Jun-1991
  11.  
  12. Author: David J Ruck
  13.  
  14. Copyright © DEEJ Technology PLC 1991 -1994
  15.  
  16.  
  17.  
  18. Overview
  19. ========
  20.  
  21.  
  22. !CPUload is designed to graphically show the amount of work the CPU (ARM
  23. chip) is doing, in the style of the X windows utility xload. It provides an
  24. alternative to Acorn's !Usage, supplied on the original RISC OS Applications
  25. Discs, with several major enhancements, including:
  26.  
  27.         (1)       More accurate calculation & display of CPU load.
  28.  
  29.         (2)       Fully re-sizeable in both height (load axis) 
  30.                   and width (time axis).
  31.  
  32.         (3)       User selectable update rate, 100ms to 5 seconds.
  33.  
  34.         (4)       400 load average point store.
  35.  
  36.         (5)       Full automatic and manual scaling options.
  37.  
  38.         (6)       Uses a very low amount of CPU time in operation.
  39.  
  40. The CPU load average is calculated from the number of calls and amount of
  41. time between the Window manager Wimp_Poll Idle events being delivered to
  42. !CPUload, this is used to determine the responsiveness of the machine.
  43.  
  44. The calculated CPU load average is displayed as black vertical bars in the
  45. !CPUload window. After every update period the window scrolls to the left
  46. and another bar is plotted.
  47.  
  48. The display automatically scaled to accommodate the largest value currently
  49. in the window. The update rate and manual scaling can be selected via a
  50. menu.
  51.  
  52.  
  53.  
  54. Using !CPUload
  55. ==============
  56.  
  57. On starting !CPUload a window is displayed immediately, it does not install
  58. an icon on the icon bar. The !CPUload window is slightly different from most
  59. RISC OS windows, in that it does not have horizontal or vertical scroll
  60. bars, but it does have toggle and resize icons on the right of the title bar
  61. - these can be used to resize the window in the standard RISC OS manner.
  62.  
  63. !CPUload holds a large number of load average points, so increasing the
  64. horizontal size of the window will reveal previous values which have
  65. disappeared off the left of the window (if the program has been running long
  66. enough). Increasing the vertical size will enable more detail to be shown,
  67. by using a larger scale.
  68.  
  69.   
  70. !CPUload menu
  71. -------------
  72. The !CPUload menu options and sub menus are described below.
  73.  
  74. Info                    Displays program information and version number.
  75.  
  76.  
  77.  
  78. Update                  The update sub menu is used to select an update rate
  79.                         in centi-seconds (1/100 second). The default is 50cs
  80.                         or 2 updates per second. Low values can be used to
  81.                         monitor small bursts of activity, 500cs enables over
  82.                         an hours worth of CPU load to be monitored with the
  83.                         maximum window width.
  84.  
  85.                         Note: the size of the bars produced at the same load
  86.                         average is not the same for different update rates.
  87.  
  88. Scale                   The scale of the window is shown by light grey
  89.                         horizontal lines, these do not represent values, but
  90.                         the number of times the height of the vertical bars
  91.                         has been halved. Thus no lines is the default scale,
  92.                         1 line  = ½ scale, 
  93.                         2 lines = ¼ scale and 
  94.                         8 lines = 1/256th scale, etc.
  95.  
  96.                         The automatic scaling (Auto ticked) ensures that the
  97.                         largest bar currently in the window will fit. The
  98.                         scale will change if a new large bar enters the
  99.                         window or the largest bar falls off the left of the
  100.                         window. Adjusting the horizontal size of the window
  101.                         will affect the scale depending on the values moved
  102.                         in or out of the window. Adjusting the vertical size
  103.                         can also affect the scale.
  104.  
  105.                         The problem with automatic scaling is that if a very
  106.                         large load blip occurs, other bars will become much
  107.                         smaller, losing detail. Selecting and entering a
  108.                         value in the Max scale sub-menu will limit the scale
  109.                         used, smaller scales will still be used if possible.
  110.  
  111.                         Selecting and entering a value in Fixed scale will
  112.                         only allow this scale to be used. Both the Max scale
  113.                         and Fixed scale values correspond to the number of
  114.                         light grey scale lines displayed.
  115.  
  116. Quit                    Removes !CPUload, having the same effect as click on
  117.                         the window close icon.
  118.  
  119.  
  120.  
  121. Programming advice
  122. ==================
  123.  
  124. One problem which RISC OS application programmer's face is deciding on the
  125. amount of time that should be spent in idle processing - that is routines
  126. that run in the background using the idle events returned by Wimp_Poll.
  127. Choosing too low a time will make the program inefficient, but too high a
  128. time is anti-social to other active applications, making the machine feel
  129. sluggish.
  130.  
  131. Unfortunately the RISC OS Programmers Reference Manuals only state this
  132. fact, and do not provide firm timing values. Using !CPUload, a reference can
  133. be obtained against a standard test, such as running the C compiler in an
  134. DDE task window. You can then tailor your program to produce a mean load
  135. equivalent to this under the same conditions.
  136.  
  137.  
  138. End of !CPUload.!Help
  139.  
  140.