home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 3 / Meeting_Pearls_III.iso / Pearls / debug / Monitor / PM / PM.doc < prev    next >
Text File  |  1992-06-14  |  4KB  |  95 lines
  1. TABLE OF CONTENTS
  2.  
  3. PM
  4. PM                                                                         PM
  5.  
  6.    NAME
  7.     PM v37.8 - Copyright (c) 1992 by MKSoft Development    (Requires 2.0)
  8.  
  9.    SYNOPSIS
  10.     PM - A CPU Load Monitor
  11.  
  12.    FUNCTION
  13.     PM is a tool that monitors the Amiga system's CPU usage using some
  14.     hooks that are available in 2.04 EXEC.  The program uses the high
  15.     resolution EClock timer to get real time values for the amount of
  16.     time the processor spends running tasks and the amount of time it
  17.     spends between tasks (in task switch and in sleep).
  18.  
  19.     PM has full ReadArgs commandline input and it can also run from
  20.     the Workbench.  (The tooltypes match the ReadArgs arguments)
  21.     PM can also be started by a Project Icon, in which case it will use
  22.     the tooltypes from the project icon.
  23.  
  24.     PM has another feature and that is it can watch a specific task.
  25.     There is a TASK keyword which will make it watch the task in question.
  26.     This can be usefull in order to see exatly how much of the system
  27.     performance is spend on just that task.
  28.  
  29.     When PM is not watching a specific task, it removes its own processing
  30.     from the total time such that any overhead it may cause is not noticed.
  31.     When PM is monitoring a specific task, PM's overhead is not counted as
  32.     part of the task's CPU usage.
  33.  
  34.     There is also a PROP-gadget that controls the speed at which the
  35.     results are reported.
  36.  
  37.     The two numbers at the bottom (when statistics are not turned off)
  38.     are the weighted average CPU usage and the instantanious CPU usage.
  39.  
  40.     When monitoring a single task, the window titlebar will display the
  41.     task name.
  42.  
  43.     Example usage:
  44.  
  45.         PM        ; Use the default settings
  46.         PM RATE 15    ; Set the rate to 15/100 seconds.
  47.         PM TASK MyTask    ; Watch "MyTask"  (Uses FindTask(), not CLI name)
  48.         PM NOSIZE    ; Do not have the size/prop gadget.
  49.  
  50.     PM will only let itself be installed once as a global monitor.  However,
  51.     you can have PM monitor any number of tasks.  PM will do its best to
  52.     not confuse the system on exit.  It will beep the display if it can not
  53.     unhook itself from the system.  When this happens it means that PM was
  54.     unable to remove the hook due to the fact that something else has hooked
  55.     into the system on top of PM.
  56.  
  57.    INPUTS
  58.     (Command Line Arguments or Icon ToolTypes:)
  59.  
  60.         LEFT/N        Left edge for the window.    Default=<none>
  61.         TOP/N        Top edge for the window.     Default=<none>
  62.         WIDTH/N        Inner width of the window.   Default=228
  63.         HEIGHT/N    Inner height of the window.  Default=40
  64.         RATE/K/N    Rate of display in 1/100 sec Default=100   (1.00 sec)
  65.         TASK/K        Task to monitor              Default=<global CPU>
  66.         CLI/K/N        The CLI number to monitor    Default=<global CPU>
  67.         CHARTCOLOR/K/N    The colour for the chart     Default=1
  68.         MEMLINE/K/N    Colour for the memory line   Default=<no memory line>
  69.         RMSLINE/K/N    Colour for the RMS line      Default=<no RMS line>
  70.         PUBSCREEN/K    Public screen name           Default=<default>
  71.         NOSIZE/S    Switch off size/prop gadget
  72.         NOSTATS/S    Turn off numerical statistics
  73.  
  74.    RESULTS
  75.     A window that shows the CPU usage...
  76.  
  77.    NOTES
  78.     The accuracy is so high that PM can even notice the task switch
  79.     overhead of the system.  This "overhead" is considered part of
  80.     the CPU idle time (not CPU task time) and thus it may be hard to
  81.     to get a full 100% utilization if task switching is still going on.
  82.  
  83.     If CHARTCOLOR is set to 0, the CPU chart is not drawn.
  84.     If a MEMLINE colour or RMSLINE colour is given, those lines will be drawn.
  85.  
  86.     Special thanks to "talin" for the nice icon!
  87.  
  88.    SEE ALSO
  89.     "A master's secrets are only as good as the
  90.      master's ability to explain them to others."  -  Michael Sinz
  91.  
  92.    BUGS
  93.     None?
  94.  
  95.