home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d548 / sandglass.lha / SandGlass / SandGlass.doc < prev    next >
Text File  |  1991-09-18  |  9KB  |  289 lines
  1. ============================================================================
  2.  
  3.  
  4.                                SandGlass V1.0
  5.  
  6.                 © Copyrights by Dirk O. Remmelt in July 1991
  7.  
  8.  
  9. ============================================================================
  10.  
  11.  
  12.  
  13.  
  14.  
  15. (i)     INTRODUCTION
  16. (ii)    DESCRIPTION OF SANDGLASS
  17. (iii)   STARTING SANDGLASS
  18. (iv)    FURTHER INFORMATIONS
  19. (v)     CONDITIONS OF COPYING / DISTRIBUTION
  20. (vi)    GREETINGS
  21. (vii)   TRADEMARKS
  22. (viii)  RESPONSE-ADDRESS
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29. (i) INTRODUCTION:
  30. -----------------
  31.  
  32.         Hi to all  carbon-based  bipedal  ape-descended  amiga-addicted life
  33.         forms out there !
  34.  
  35.  
  36.         SandGlass is a program  which animates  the original Workbench-busy-
  37.         or-zz-mouse-pointer. I was  inspired by the  MS-Windows  busy-mouse-
  38.         pointer to write a similar program for the Amiga.
  39.  
  40.         The actual version is only for  Workbench/Kickstart upto 1.3. If you
  41.         want to know why, please refer to chapter (ii).
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48. (ii) DESCRIPTION OF SANDGLASS:
  49. ------------------------------
  50.  
  51.         After starting  SandGlass, and while a  disk-device-access is taking
  52.         place, the mouse-pointer  represents itself as a  sandglass, purling
  53.         sand through it, turning around and starting all over again.
  54.  
  55.         For doing this, the program reads out the address of the busy-mouse-
  56.         pointer-image  at the first  disk-device-address, saves  this image,
  57.         and writes  repeatedly the  datas of my animated  sandglass at  this
  58.         address. The fact, that an access is  taking place can be checked by
  59.         the value written in the variable 'Pointer' of the
  60.  
  61.         IntuitionBase->ActiveWindow-structure.
  62.  
  63.         In this case, the value in 'Pointer' is unequal  zero. It now points
  64.         to the datas of the busy-mouse-pointer-image.
  65.  
  66.         Some  words about  Workbench/Kickstart  2.x. The actual  version  of
  67.         SandGlass is only designed for Workbench/Kickstart upto 1.3, because
  68.         these two kinds of  versions have different handlings  of the mouse-
  69.         pointer-image.
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76. (iii) STARTING SANDGLASS:
  77. -------------------------
  78.  
  79.         There are two ways to start SandGlass:
  80.  
  81.  
  82.  
  83.         1. How to start SandGlass from CLI/Shell
  84.  
  85.            The syntax of SandGlass is:
  86.            SandGlass [?] [D=delay] [P=priority]
  87.  
  88.  
  89.            Examples:
  90.  
  91.            a)  Run SandGlass D=4 P=-42
  92.                Set the parameters for process delay time and task priority
  93.  
  94.            b)  Run SandGlass ?
  95.                Print out the syntax line and exit
  96.  
  97.  
  98.            You may  leave out any  parameter as you like. The  parameters do
  99.            not need to have a certain order.
  100.  
  101.  
  102.            NOTE:
  103.  
  104.            If your  parameters are not  reasonable (delay must be greater or
  105.            equal than zero; priority must be out of the interval [-128,127])
  106.            the program will be exited.
  107.  
  108.  
  109.  
  110.         2. How to start SandGlass from Workbench
  111.  
  112.            Just  doubleclick the  SandGlass icon. If you  want to change its
  113.            parameters, you can do  this by editing the  SandGlass.info file.
  114.            That  means: select the  SandGlass  icon  and call the  Workbench
  115.            build-in function 'Info'. Now you can edit the parameter lines
  116.  
  117.            process delay time : DELAY=5
  118.            task priority      : PRIORITY=-10
  119.  
  120.  
  121.            NOTE:
  122.  
  123.            If your  parameters are not  reasonable (delay must be greater or
  124.            equal than zero; priority must be out of the interval [-128,127])
  125.            the default values (delay=5; priority=-10) will be used.
  126.  
  127.  
  128.  
  129.         A process delay time of 5 will be a  reasonable value. In this case,
  130.         the program  needs approx 4% processor  time on a 68000  machine and
  131.         approx 1% on a 68030/33Mhz/4MB machine. If the task priority is held
  132.         about  zero, its value  won't affect  the processing  as much as the
  133.         delay value.
  134.  
  135.         If you want to speed up the animation, you can decrease the value of
  136.         the process delay time.
  137.  
  138.  
  139.         IMPORTANT:
  140.  
  141.         Please keep the following two points always in mind !
  142.  
  143.         - A decreasing  of delay  will have an  increasing effect on the CPU
  144.           performance.
  145.  
  146.         - If the task priority is more than 10, important system tasks could
  147.           be interrupted. On the  other hand, a task  priority less than -80
  148.           could  interrupt the SandGlass  program. The effect  of that would
  149.           be, that you  couldn't close the SandGlass window to stop the pro-
  150.           gram. Reasonable  values for  the task  priority are  out of  the
  151.           intervall [-50,5].
  152.  
  153.  
  154.         If you want to exit SandGlass, just close the tiny SandGlass window.
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161. (iv) FURTHER INFORMATIONS:
  162. --------------------------
  163.  
  164.         The program  needs about  2K chip  and  12K fast memory. The  actual
  165.         version of  SandGlass is totally  written in C  with the  Manx Aztec
  166.         C68k V5.0b Compiler/Linker.
  167.  
  168.         The sources can be unpacked using lharc 1.1 or higher. The syntax is
  169.         lharc -rxa x SandGlass_Sources.lzh
  170.         LHARC will create a subdirectory 'Sources' in which the sources are
  171.         placed.
  172.  
  173.         In a future  release of  SandGlass I hopefully  will have solved the
  174.         problem about Workbench/Kickstart 2.x.
  175.  
  176.         I also think about an assembler-translated  main routine to speed up
  177.         the animation without decreasing the process delay time value.
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184. (v) CONDITIONS OF COPYING / DISTRIBUTION:
  185. -----------------------------------------
  186.  
  187.         This package consists of the following files:
  188.  
  189.           - SandGlass ................... the executable program
  190.           - SandGlass.info .............. its icon
  191.           - SandGlass.doc ............... this file
  192.           - SandGlass.doc.info .......... this file's icon
  193.           - Sources/ImageDatas.h ........ the include-file with 14 images
  194.           - Sources/ImageDatas.h.info ... its icon
  195.           - Sources/SandGlass.c ......... the source code of SandGlass
  196.           - Sources/SandGlass.c.info .... its icon
  197.           - Sources/MakeFile ............ the makefile for Make -CLI only-
  198.           - Sources/MakeFile.info ....... its icon
  199.  
  200.         The package and all its files are NOT Public Domain. However you are
  201.         allowed to copy the package as long as ALL the following demands are
  202.         met. Exception  from any of the points  below can only be granted by
  203.         my expressed written consent.
  204.  
  205.  
  206.         1. This  package may  only be  distributed in  its intact, unchanged
  207.            form.  Altering, as  well  as  omitting, expanding  or any  other
  208.            change of the package or any part of it is strictly forbidden!
  209.  
  210.         1. Neither this package, nor any  portion of it may be included in a
  211.            commercial product.
  212.  
  213.         2. Neither this  package, nor any  portion of it may be used commer-
  214.            cially.
  215.  
  216.         3. Neither  this  package, nor  any  portion of it may  appear in an
  217.            electronic  mailing facility, where an additional  charge to your
  218.            telephone bill is upheld.
  219.  
  220.         4. The disk, this package is  distributed on  has to be priced below
  221.            $6 in  the U.S.A. or the  equivalent  of DM 6 in  Germany  or any
  222.            other country.
  223.  
  224.         5. Neither this  package, nor  any part  of it may  appear or be in-
  225.            cluded in any Public Domain series  without my expressed  written
  226.            consent.
  227.  
  228.  
  229.         No guarantees, implicit  or explicit  are provided. The user is res-
  230.         ponsible for all damages  resulting directly  or indirectly from the
  231.         use of this package.
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238. (vi) GREETINGS:
  239. ---------------
  240.  
  241.         Greetings go to
  242.  
  243.         - Douglas Noel Adams  for  his  Hitch Hiker's  Guide  to the  Galaxy
  244.           (the only trilogy of four volumes), and
  245.           Dirk Gently's detective agency
  246.           (at this moment two volumes), and
  247.           The Meaning of Liff
  248.           (the additional book to the Oxford English Dictionary).
  249.  
  250.         - Thomas Geib  for testing,  advice and  for the  parameter-read-in-
  251.           subroutines.
  252.  
  253.         - Stefan Boldorf for his "legal stuff text" via Thomas.
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260. (vii) TRADEMARKS:
  261. -----------------
  262.  
  263.         Amiga, Workbench, Kickstart are trademarks of  Commodore-Amiga, Inc.
  264.         MS-Windows is a trademark of Microsoft Corporation.
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271. (viii) RESPONSE-ADDRESS:
  272. ------------------------
  273.  
  274.         Please send flames, bug reports or a list of features you would like
  275.         to have included in the next version to
  276.  
  277.         Dirk O. Remmelt
  278.         Lutrinastr. 11
  279.         D-6750 Kaiserslautern
  280.         Unified Germany
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.                                                 Kaiserslautern, 31 July 1991
  288.                                                              Dirk O. Remmelt
  289.