home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / misc / starblan.lzh / StarBlanker.doc < prev    next >
Encoding:
Text File  |  1990-08-06  |  8.0 KB  |  179 lines
  1.      .        .      .             .    .      .     .                .    
  2.           .              .          .      .                 .             
  3.                 .                                       .                  
  4.       StarBlanker version 1.10               ⌐ 1989, 1990 Chris Bailey     
  5.       Yet Another ScreenBlanker                 All Rights Reserved        
  6.          .       .            .      .         .        .             .    
  7.            .              .                         .              .       
  8.     .               .                     .                .               
  10.  
  11. -- Before You Start --
  12.  
  13.   If you intend to distribute this software further, you must agree
  14. to the distribution guidelines described in the file "Distribution"
  15. that is included in this archive.  If you do not intend to distribute
  16. this software further, then there is no need to read that file.  Note
  17. that some minor details about distribution have changed since v1.0.
  18.   If you wish to know what specific changes were made between releases
  19. 1.0 and 1.1 of StarBlanker, refer to the Revision History at the end
  20. of this file.
  21.  
  22. -- Overview --
  23.  
  24.   StarBlanker is a screen blanker, pure and simple.  It helps you avoid
  25. monitor burn-in if you should leave your computer sitting with the same 
  26. display showing for an abnormal amount of time.  It operates in the same 
  27. manner as most screen blankers operate - if no keyboard or mouse activity 
  28. is detected for a specific amount of time, the display will do something 
  29. interesting until you either press a key or move the mouse.  
  30.  
  31. -- When the screen blanks --
  32.  
  33.   When the timeout expires, instead of just making the screen black like
  34. some other screen blankers do, StarBlanker replaces your current display
  35. with one of two different scrolling starfields.  The starfield will 
  36. continue to scroll until you either touch a key on the keyboard or move 
  37. the mouse.
  38.  
  39.   To make things interesting, StarBlanker chooses which starfield to
  40. blank the screen with at random.
  41.   
  42. -- Setting the timeout --
  43.  
  44.   StarBlanker needs one number from you before it can start.  It needs
  45. to know how many seconds of no activity should cause the starfield
  46. display to pop up.  If you don't specify a number (as outlined below),
  47. StarBlanker will use an internal default of 4 minutes.  
  48.   The method of specifying the timeout has changed since version 1.0 of
  49. StarBlanker.  There is no longer a way to directly specify the timeout
  50. value when you invoke the program from CLI or Workbench.  Instead, I've
  51. used what I feel is a more logical approach to setting a timeout that
  52. you won't want to change very often - using environment variables.
  53.   Although this method will require you to use the CLI, you only have
  54. to do it once.
  55.  
  56.   From the CLI, the timeout is set by specifying an SBTIMEOUT environment
  57. variable.  For example, this would set the timeout value to 5 minutes:
  58.  
  59.   1> setenv sbtimeout "300"
  60.  
  61.   As you can see, the timeout value is entered in seconds.  The minimum
  62. number of seconds is 10 and the maximum is 9999.  If you specify a value
  63. out of this range (or non-numeric), StarBlanker will default to its 
  64. internal default of four minutes.
  65.   After you have set the SBTIMEOUT environment variable, you should never
  66. need to set it again unless you want to change the timeout value or the
  67. contents of your ENV: directory are lost somehow.
  68.   StarBlanker only reads the environment variable when you first invoke
  69. it.  If you change the environment variable while StarBlanker is running,
  70. you will need to quit StarBlanker and re-invoke it.
  71.  
  72.   Note : You must use Commodore's "setenv" command.
  73.  
  74.   Oh, and after the timeout has been specified, you invoke StarBlanker
  75. from the CLI like so:
  76.  
  77.   1> StarBlanker
  78.   
  79.   From the Workbench, just click on the icon.  If started from the CLI,
  80. StarBlanker will detach, so there's no reason to use runback, excessive
  81. redirection, or anything else.
  82.  
  83. -- Blanking the screen by hand --
  84.  
  85.   New to version 1.1 is the largest request I had from 1.0 - the ability
  86. to press a key combination and blank the screen.  The following key 
  87. combination will cause the screen to blank:
  88.  
  89.   RIGHT SHIFT + RIGHT ALT + "b"
  90.  
  91. -- Killing StarBlanker --
  92.  
  93.   The easiest way to de-install StarBlanker is to re-activate the program, 
  94. either from Workbench or from the CLI.  StarBlanker will announce that it 
  95. is removing itself, and free up all memory that it was using.
  96.  
  97.   The following hotkey combination will also remove StarBlanker:
  98.     
  99.    RIGHT SHIFT + RIGHT ALT + "x"
  100.  
  101. -- Using StarBlanker with DMouse --
  102.  
  103.   As of this writing, the easiest way to use StarBlanker with DMouse is
  104. to simply turn DMouse's screen blanker option off before starting 
  105. StarBlanker.  This is done by specifying -s0 on dmouse's command line.
  106. A future version of starblanker may have an included program to help
  107. this.
  108.   
  109. -- Of Memory And Multitasking --
  110.  
  111.   When StarBlanker is dormant, it doesn't take up very much memory,  but
  112. when it opens its display, it can take more than a small amount of memory.  
  113. The starfield display is 2 bitplanes deep, and there are also a couple of 
  114. offscreen bitmaps to make the animation smooth and fast.  If there is not 
  115. enough memory for StarBlanker to open the displays needed, it simply won't 
  116. blank the screen.
  117.   
  118.   At the request of Martin Taillefer, the starfield display updates with
  119. IntuiTicks messages.  This means that while the screen is blanked, 
  120. processor time won't be noticeably degraded.  This also means that the 
  121. starfield isn't going as fast as it could, which is okay, since this
  122. is a screen blanker and not a european demo.
  123.  
  124. -- Revision History --
  125.  
  126. 1.0 - 04-Jan-1990
  127. ----------------
  128.   StarBlanker first released.
  129.  
  130. 1.1 - 06-Aug-1990
  131. -----------------
  132.   After seeing no less than 3 other 'versions' (some with the same names!)
  133. of this wonderful program, I decided it was time for an upgrade.
  134.  
  135.  - Reliability should be much better.  1 call to ClearPointer wasn't
  136.    quite in the right place.  Apparently the MAIN problem was that I
  137.    was setting the stack of the detaching process too small in an attempt
  138.    to save memory, which caused it to work on my trusty A1000 but to 
  139.    go screwy on other Amiga models.
  140.  - Startup changed from command line/tooltypes to using environment
  141.    variables.  This should fix problems with trying to get the command
  142.    line after a detach.
  143.  - Ability to blank screen with a keypress added.
  144.  - Screen will now only unblank with the downstroke of a key (added this to
  145.    support the above)
  146.  - Source code removed from the archive, mainly to save space.  If you want
  147.    the source code, ask me.
  148.  - Size went way down - 7000 bytes vs. 8428 bytes.
  149.    (enough room now to add a new blank mode?)
  150.  - Minor whacking at the routine that shows the opening and closing messages.
  151.  - Brand new 2.0 looking icon that looks like trash under 1.3
  152.  - ANSI color added to the doc file (whoopee)
  153.  
  154. -- The Future & Other Junk --
  155.  
  156.   There is no fee for using this software.  You can put it in your 
  157. startup sequence right now if you wish without giving the author a second
  158. thought.  If your conscience asks you to donate, the recommended fee is
  159. $10, although again, this is *not* required to use this software.
  160.   I fully intend to release future versions of StarBlanker, but I can make
  161. no estimation of when they might appear.  I will say that I have a fireworks 
  162. blank mode about 30% finished....
  163.  
  164.   If you wish to contact me for bug reports, praise, comments, or anything 
  165. else, here's how.  Electronic means are preferred.
  166.  
  167. (*=======================================================================*)
  168.   Chris Bailey                    Phone : 803-794-4933
  169.   2405, Feather Run Trail
  170.   W. Columbia, SC  29169
  171.   
  172.   UUCP:{uunet!ncrlnk, gatech!hubcap}!ncrcae!secola!smoak!avcom!bailey!chris
  173.   BIX : csbailey
  174.   SDI : Starving Developers Incorporated
  175.  
  176.   A witty saying proves nothing, but saying something pointless gets
  177.   people's attention.
  178. (*=======================================================================*)
  179.