home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 215.lha / AmyLoad / amyload.doc < prev    next >
Text File  |  1996-02-14  |  7KB  |  200 lines
  1.  
  2.     NAME
  3.     Amyload - graphically monitor Amiga CPU, blitter, and memory usage
  4.  
  5.     SYNOPSIS
  6.     amyload [options] [ '{' [window options] [ '[' [record options] ']' ] ... '}' ] ...
  7.  
  8.     DESCRIPTION
  9.     Amyload is a program which graphically displays information about
  10.     current CPU, blitter, and memory usage of the Amiga.  This
  11.     information is displayed in one or more windows, each of which may
  12.     display information about the usage of any or all of the following:
  13.  
  14.         CPU usage - The average length of the ready queue over the last
  15.             n seconds (a settable time interval).  When greater
  16.             than 1, horizontal lines are drawn to reflect a
  17.             change in the scale that CPU usage is being
  18.             displayed in.
  19.  
  20.         Blitter usage - The fraction of time during the last interval
  21.                 that the blitter was in use.
  22.  
  23.         Chip memory usage - The fraction of chip memory in use.
  24.  
  25.         Fast memory usage - The fraction of fast memory in use.
  26.  
  27.         Both chip and fast memory usage - The combination of both above.
  28.  
  29.     Options: (spaces are ignored except between an option requiring
  30.           an integer parameter, where there had better not be any)
  31.  
  32.         i<n>    Set the time interval between updates to n seconds.
  33.             Default is the current setting of load.device, which
  34.             begins at 5 seconds, but may have been changed.
  35.  
  36.         t<n>    Set the number of ticks per interval (at which samples
  37.             of CPU and blitter usage are taken) to n.  Default is
  38.             the current setting of the load.device, which begins
  39.             at 61.  The interval time divided by the number of
  40.             ticks should form an irregular number, so as to try
  41.             to avoid aliasing problems.  (e.g. 1 second / 10 ticks
  42.             is probably a bad idea, because the device might get
  43.             'in sync' with some other task, and that would distort
  44.             the results.)
  45.  
  46.         p<n>    Set the priority of the measuring task to n.  It should
  47.             be higher than any tasks it is trying to measure.
  48.             Default is the current setting of the load.device, which
  49.             begins at 25.
  50.  
  51.         Following the options selection, window specifications may be
  52.         given.  They are introduced by the '{' character, and terminated
  53.         by the '}' character.
  54.  
  55.     Window Options:
  56.  
  57.         =[WIDTH][xHEIGHT][{+-}XOFF[{+-}YOFF]]
  58.           (similar to an X geometry specification)
  59.         The '=' character introduces the specification.  WIDTH
  60.         and HEIGHT specify the WIDTH and HEIGHT of the window.
  61.         XOFF and YOFF specify the position of the window relative
  62.         to the screen's borders, the '+' or '-' characters
  63.         indicating a position relative to the left or right border
  64.         respectively of the screen in the case of XOFF, or top or
  65.         bottom in the case of YOFF.  Distances are measured between
  66.         the screen's border and the nearest window edge, so the
  67.         window can be placed in the lower right corner with
  68.         specifications of -0-0 for XOFF and YOFF.  No spaces
  69.         are allowed within the geometry specification.
  70.  
  71.         d<n>    Set the window's detail pen color to n.
  72.  
  73.         b<n>    Set the window's block pen number to n.
  74.  
  75.         g<n>    Set the background pen number for the window to n.
  76.  
  77.         After window options have been specified, one or more record
  78.         descriptions may be specified.  These are introduced with the
  79.         '[' character, and terminated by the ']' character.  The records
  80.         specified earlier will have their data lines drawn on top of
  81.         records specified later  (first to last == foreground to
  82.         background).
  83.  
  84.     Record Options:
  85.  
  86.         C        This record will display CPU usage (really ready queue
  87.             length).  This is the default record type.
  88.  
  89.         b        This record will display blitter usage.
  90.  
  91.         c        This record will display chip memory usage.
  92.  
  93.         f        This record will display fast memory usage.
  94.  
  95.         m        This record will display all memory usage.
  96.  
  97.         d<n>    Data lines for this record will be drawn with pen n.
  98.  
  99.         r<n>    References lines (drawn when scaling) will be drawn with
  100.             pen n.  This is irrelevant unless the record is
  101.             displaying CPU usage.  Note that reference lines will
  102.             be drawn behind all records, regardless of ordering,
  103.             except that they will be drawn on top of the scaled
  104.             record's data lines.
  105.  
  106.     Note that load.device MUST be in your DEVS: directory (or already
  107.     loaded into the system).
  108.  
  109.     USER INTERFACE
  110.     Standard system gadgets are present but invisible (except for the
  111.     drag bar, see BUGS).  The menu button causes the types of the
  112.     records in the windows to be printed in the color of their data
  113.     lines.
  114.  
  115.     EXAMPLES
  116.     amyload
  117.         - use the default setup
  118.  
  119.     amyload {[C]}
  120.         - open a single window monitoring CPU usage
  121.  
  122.     amyload {=200x200-0-0[C]}
  123.         - as above, but make the window 200 by 200 and put it in the
  124.           lower right hand corner of the screen.
  125.  
  126.     amyload {[bd2][Cd3]}{[cd3][fd2]}
  127.         - open one window displaying blitter usage in the foreground
  128.           using pen 2 for drawing data lines, and CPU usage in the
  129.           background using pen 3 for data lines and the default pen
  130.           for scale reference lines.  Open a second window with chip
  131.           memory usage in the foreground using pen 3 for data lines,
  132.           and fast memory usage in the background using pen 2 for
  133.           data lines.
  134.  
  135.  
  136.     DIAGNOSTICS
  137.     Error numbers are returned, rather than a messages,
  138.     to avoid DOS.  Error numbers are:
  139.       1 -  "Can't open graphics library"
  140.       2 -  "Can't open intuition library"
  141.       3 -  "Can't create message port"
  142.       4 -  "Can't create IO request"
  143.       5 -  "Can't open load device"
  144.       6 -  "Can't open window"
  145.       7 -  "Can't create load record"
  146.       8 -  "Unexpected end of record description"
  147.       9 -  "Unexpected end of window description"
  148.      10 -  "Bad record flag"
  149.      11 -  "Bad window flag"
  150.      12 -  "Bad flag"
  151.  
  152.     BUGS
  153.     When the window is activated/deactivated, the not so invisible drag
  154.     bar is still drawn/masked.  Can't seem to figure out how to avoid
  155.     this.
  156.  
  157.     Doesn't do enough checking of options.  May crash if bad ones
  158.     are given, especially zeroes in the wrong places.
  159.  
  160.     Doesn't do a 3D representation, yet...
  161.  
  162.     There is a bug in the data line drawing procedure (I think it's in
  163.     there, anyway) that causes scale lines to not be drawn over data lines
  164.     that are just heigher than the scale line.
  165.  
  166.     Should use cback.o, so you don't have to 'run' it, but I haven't
  167.     looked into that yet.
  168.  
  169.     Isn't Intuition friendly.  Application gadget and menu support
  170.     should be added to allow configuration after startup.
  171.  
  172.     SEE ALSO
  173.     devices/load.doc
  174.  
  175.     AUTHOR
  176.     Jeff Kelley
  177.     Dept. of Computer Science
  178.     University of Waterloo
  179.     Waterloo, Ontario, Canada
  180.     N2L 3G1
  181.  
  182.     Voice:      (519)-578-4514
  183.     UUCP:      {ihnp4,watmath}!watcgl!jvkelley
  184.     BITNET:   jvkelley@cgl.waterloo.bitnet
  185.     INTERNET: jvkelley@cgl.waterloo.edu
  186.     EAN:      jvkelley@cgl.waterloo.cdn
  187.  
  188.     Comments, suggestions, bug reports welcome.
  189.  
  190.     ACKNOWLEDGEMENTS
  191.     Amyload was inspired by the 'xload' program for UN*X workstations
  192.     running the X Window System, and, to a lesser extent, by 'pm' for
  193.     the Amiga.
  194.  
  195.     Thanks to Matt Dillon for Dme, the Software Distillery for blink,
  196.     Comspec for getting a 2M RAM expansion to me quickly (NACK to the
  197.     <unnamed> company whose lies about delivery dates delayed this
  198.     project by a couple months), everyone on USENET, and the
  199.     visionaries who created the Amiga.
  200.